Docs For Class One_Click

One_Click_Generic __construct(

$mApp)

Tags:

access:

public

Overridden in child classes as:

lucida_Install::__construct()

create_Install::__construct()

punBB_Install::__construct()

wordpress_Install::__construct()

gallery_Install::__construct()

joomla_Install::__construct()

phpBB_Install::__construct()

Typo_Install::__construct()

Zencart_Install::__construct()

mediawiki_Install::__construct()

Parameters:

$mApp

[ Top ]

void call_proc(

$mCmd)

Tags:

access:

public

Parameters:

$mCmd

[ Top ]

void call_proc_sudo(

$mCmd, 
$mUser)

Tags:

access:

public

Parameters:

	$mCmd
	$mUser

[ Top ]

bool compare_versions(
string
$mVersion1, string
$mVersion2, [string
$mOperand = '='])

int compare_versions(string, string, string)

Overrideable version comparison method used by upgrade facility By default, this is just a wrapper to PHP's version_compare() function

Tags:

access:

public

Parameters:

string	$mVersion1	first version
string	$mVersion2	second version
string	$mOperand	boolean operators '<','>','==','!='

[ Top ]

void connect(
[
$mHost = NULL], [
$mPort = NULL])

Tags:

access:

public

Parameters:

	$mHost
	$mPort

[ Top ]

void copy_storehouse(

$mSrc, 
$mDest)

Tags:

access:

protected

Parameters:

	$mSrc
	$mDest

[ Top ]

void copy_storehouse_raw(

$mSrc, 
$mDest)

Tags:

access:

protected

Parameters:

	$mSrc
	$mDest

[ Top ]

bool fix_apache_perms(
string
$mPath, [bool
$mRecurse = false])

bool fix_apache_perms(string[, bool = false])

Tags:

final:
access:	protected

Parameters:

string	$mPath
bool	$mRecurse

[ Top ]

void generate_locales(
)

Tags:

access:

protected

[ Top ]

void get_application_installs(
)

Tags:

access:

public

[ Top ]

void get_audit_status(
)

Tags:

access:

public

[ Top ]

void get_author(
)

Tags:

access:

public

[ Top ]

void get_author_address(
)

Tags:

access:

public

[ Top ]

void get_database_prefix(
)

Tags:

access:

protected

[ Top ]

void get_dependencies(
)

Tags:

access:

public

[ Top ]

void get_description(
)

Tags:

access:

public

[ Top ]

void get_install_database(
)

Tags:

access:

protected

[ Top ]

void get_install_path(
)

Tags:

access:

protected

[ Top ]

void get_install_url(
)

Tags:

access:

public

[ Top ]

void get_instance_configuration(

$mPath)

Tags:

access:

public

Parameters:

$mPath

[ Top ]

void get_logo(
)

Tags:

access:

public

[ Top ]

void get_original_version(
)

Tags:

access:

protected

[ Top ]

void get_postback(
[
$mKey = NULL])

Tags:

access:

protected

Parameters:

$mKey

[ Top ]

void get_site_id(
)

Tags:

access:

public

[ Top ]

void get_space(
)

Tags:

access:

public

[ Top ]

void get_target_version(
)

Tags:

access:

protected

[ Top ]

void get_version(
)

Tags:

access:

public

[ Top ]

void get_versions(
)

Tags:

access:

public

[ Top ]

void get_version_hierarchy(
)

Tags:

access:

protected

[ Top ]

void get_website(
)

Tags:

access:

public

[ Top ]

void install(
)

Tags:

abstract:
access:	public

Overridden in child classes as:

lucida_Install::install(): Perform the application installation process

create_Install::install(): Perform the application installation process

punBB_Install::install(): Perform the application installation process

wordpress_Install::install()

gallery_Install::install(): Perform the application installation process

joomla_Install::install(): Perform the application installation process

phpBB_Install::install(): Perform the application installation process

Typo_Install::install(): Perform the application installation process

Zencart_Install::install(): Perform the application installation process

mediawiki_Install::install(): Perform the application installation process

[ Top ]

void log_status(

$mMsg)

Tags:

access:

protected

Parameters:

$mMsg

[ Top ]

void mysql_import(

$mScript)

Tags:

access:

public

Parameters:

$mScript

[ Top ]

void patch(

$mVersion, [
$mFuzz = 30])

Tags:

access:

public

Overridden in child classes as:

lucida_Install::patch(): Call diff command, patch application, do anything else...

create_Install::patch(): Call diff command, patch application, do anything else...

punBB_Install::patch(): Call diff command, patch application, do anything else...

wordpress_Install::patch(): bool patch(string, int)

gallery_Install::patch(): Call diff command, patch application, do anything else...

joomla_Install::patch(): Call diff command, patch application, do anything else...

phpBB_Install::patch(): Call diff command, patch application, do anything else...

Typo_Install::patch(): Call diff command, patch application, do anything else...

Zencart_Install::patch(): Call diff command, patch application, do anything else...

mediawiki_Install::patch(): Call diff command, patch application, do anything else...

Parameters:

	$mVersion
	$mFuzz

[ Top ]

void patch_exists(

$mInternal, 
$mOld, 
$mNew)

The patch process works as follows: 1) Use xdiff (or diff binary itself) to generate diffs between <old> and <new> and store the diffs under /tmp/. Return the array of different files.

2)

Tags:

access:

protected

Parameters:

	$mInternal
	$mOld
	$mNew

[ Top ]

void pgsql_import(

$mScript)

Tags:

access:

public

Parameters:

$mScript

[ Top ]

void post_configuration(
)

Tags:

abstract:
access:	public

Overridden in child classes as:

lucida_Install::post_configuration(): Validate input.

create_Install::post_configuration(): Validate input.

punBB_Install::post_configuration(): Validate input.

wordpress_Install::post_configuration()

gallery_Install::post_configuration(): Validate input.

joomla_Install::post_configuration(): Validate input.

phpBB_Install::post_configuration(): Validate input.

Typo_Install::post_configuration(): Validate input.

Zencart_Install::post_configuration(): Validate input.

mediawiki_Install::post_configuration(): Validate input.

[ Top ]

void post_install(
)

Tags:

abstract:
access:	public

Overridden in child classes as:

lucida_Install::post_install(): Clean-up any remaining files, reinitialize variables, et cetera

create_Install::post_install(): Clean-up any remaining files, reinitialize variables, et cetera

punBB_Install::post_install(): Clean-up any remaining files, reinitialize variables, et cetera

wordpress_Install::post_install(): Clean-up any remaining files, reinitialize variables, et cetera

gallery_Install::post_install(): Clean-up any remaining files, reinitialize variables, et cetera

joomla_Install::post_install(): Clean-up any remaining files, reinitialize variables, et cetera

phpBB_Install::post_install(): Clean-up any remaining files, reinitialize variables, et cetera

Typo_Install::post_install(): Clean-up any remaining files, reinitialize variables, et cetera

Zencart_Install::post_install(): Clean-up any remaining files, reinitialize variables, et cetera

mediawiki_Install::post_install(): Clean-up any remaining files, reinitialize variables, et cetera

[ Top ]

void post_patch(
)

Tags:

access:

public

Overridden in child classes as:

lucida_Install::post_patch(): Post-patch cleanup

create_Install::post_patch(): Post-patch cleanup

punBB_Install::post_patch(): Post-patch cleanup

wordpress_Install::post_patch(): Post-patch cleanup

gallery_Install::post_patch(): Post-patch cleanup

joomla_Install::post_patch(): Post-patch cleanup

phpBB_Install::post_patch(): Post-patch cleanup

Typo_Install::post_patch(): Post-patch cleanup

Zencart_Install::post_patch(): Post-patch cleanup

mediawiki_Install::post_patch(): Post-patch cleanup

[ Top ]

void pre_configuration(
)

Tags:

abstract:
access:	public

Overridden in child classes as:

lucida_Install::pre_configuration(): Pre configuration hooks. This function is reserved for ensuring that the user has the necessary features enabled for the account in order to install the application fine.

create_Install::pre_configuration(): Pre configuration hooks. This function is reserved for ensuring that the user has the necessary features enabled for the account in order to install the application fine.

punBB_Install::pre_configuration(): Pre configuration hooks. This function is reserved for ensuring that the user has the necessary features enabled for the account in order to install the application fine.

wordpress_Install::pre_configuration()

gallery_Install::pre_configuration(): Pre configuration hooks. This function is reserved for ensuring that the user has the necessary features enabled for the account in order to install the application fine.

joomla_Install::pre_configuration(): Pre configuration hooks. This function is reserved for ensuring that the user has the necessary features enabled for the account in order to install the application fine.

phpBB_Install::pre_configuration(): Pre configuration hooks. This function is reserved for ensuring that the user has the necessary features enabled for the account in order to install the application fine.

Typo_Install::pre_configuration(): Pre configuration hooks. This function is reserved for ensuring that the user has the necessary features enabled for the account in order to install the application fine.

Zencart_Install::pre_configuration(): Pre configuration hooks. This function is reserved for ensuring that the user has the necessary features enabled for the account in order to install the application fine.

mediawiki_Install::pre_configuration(): Pre configuration hooks. This function is reserved for ensuring that the user has the necessary features enabled for the account in order to install the application fine.

[ Top ]

void pre_install(
)

Tags:

abstract:
access:	public

Overridden in child classes as:

lucida_Install::pre_install(): Ensure that the filesystem meets the needs of the application.

create_Install::pre_install(): Ensure that the filesystem meets the needs of the application.

punBB_Install::pre_install(): Ensure that the filesystem meets the needs of the application.

wordpress_Install::pre_install()

gallery_Install::pre_install(): Ensure that the filesystem meets the needs of the application.

joomla_Install::pre_install(): Ensure that the filesystem meets the needs of the application.

phpBB_Install::pre_install(): Ensure that the filesystem meets the needs of the application.

Typo_Install::pre_install(): Ensure that the filesystem meets the needs of the application.

Zencart_Install::pre_install(): Ensure that the filesystem meets the needs of the application.

mediawiki_Install::pre_install(): Ensure that the filesystem meets the needs of the application.

[ Top ]

void pre_patch(
)

Tags:

access:

public

Overridden in child classes as:

lucida_Install::pre_patch(): Double check files exist prior to patch

create_Install::pre_patch(): Double check files exist prior to patch

punBB_Install::pre_patch(): Double check files exist prior to patch

wordpress_Install::pre_patch(): Double check files exist prior to patch

gallery_Install::pre_patch(): Double check files exist prior to patch

joomla_Install::pre_patch(): Double check files exist prior to patch

phpBB_Install::pre_patch(): Double check files exist prior to patch

Typo_Install::pre_patch(): Double check files exist prior to patch

Zencart_Install::pre_patch(): Double check files exist prior to patch

mediawiki_Install::pre_patch(): Double check files exist prior to patch

[ Top ]

void process_installation(

$mOpts)

Tags:

access:

public

Parameters:

$mOpts

[ Top ]

void query(

$mCmd, [
$mArgs = NULL])

Tags:

access:

public

Parameters:

	$mCmd
	$mArgs

[ Top ]

void render_configuration(
)

Tags:

access:

public

[ Top ]

void setup_mysql(

$mUser, 
$mPassword, 
$mDB)

Tags:

access:

protected

Parameters:

	$mUser
	$mPassword
	$mDB

[ Top ]

void setup_pgsql(

$mUser, 
$mPassword, 
$mDB)

Tags:

access:

protected

Parameters:

	$mUser
	$mPassword
	$mDB

[ Top ]

void set_database_prefix(

$mPrefix)

Tags:

access:

protected

Parameters:

$mPrefix

[ Top ]

void set_dependencies(

$mDeps)

Tags:

access:

public

Parameters:

array

$mDeps

[ Top ]

void set_description(

$mDesc)

Tags:

access:

public

Parameters:

$mDesc

[ Top ]

void set_function_int(

&$mObj)

Tags:

access:

public

Parameters:

&$mObj

[ Top ]

void set_install_type(

$mType)

Tags:

access:

public

Parameters:

$mType

[ Top ]

void set_mysql(

&$mObj)

Tags:

access:

public

Parameters:

&$mObj

[ Top ]

void set_pgsql(

&$mObj)

Tags:

access:

public

Parameters:

&$mObj

[ Top ]

void set_space(

$mSpace)

Tags:

access:

public

Parameters:

$mSpace

[ Top ]

void set_version(

$mVer)

Tags:

access:

public

Parameters:

$mVer

[ Top ]

void set_website(

$mSite)

Tags:

access:

public

Parameters:

$mSite

[ Top ]

bool uninstall(

$mPath)

bool uninstall(string)

Uninstall an application, overrideable

Tags:

return:	uninstall succeeded
access:	public

Parameters:

$mPath

[ Top ]

void upgrade(

$mLocation, 
$mVersion)

Tags:

access:

public

Parameters:

	$mLocation
	$mVersion

[ Top ]

void uses_sql(
)

Tags:

access:

protected

[ Top ]

void __call(

$mFunc, 
$mArgs)

Tags:

access:

protected

Parameters:

	$mFunc
	$mArgs

[ Top ]

void __get(

$mItem)

Tags:

access:

protected

Parameters:

$mItem

[ Top ]

void __set(

$mVar, 
$mVal)

Tags:

access:

protected

Parameters:

	$mVar
	$mVal

[ Top ]

Class: One_Click_Generic

Class Overview

Author(s):

Variables

Methods

Child classes:

Class Details

Tags:

Class Variables

$application_config_opts =

Tags:

$configuration_options =

Tags:

$function_int =

Tags:

$installation_type =

Tags:

$mysql =

Tags:

$mysql_database =

Tags:

$mysql_password =

Tags:

$mysql_user =

Tags:

$pgsql =

Tags:

$pgsql_database =

Tags:

$pgsql_password =

Tags:

$pgsql_user =

Tags:

$site_id =

Tags:

Class Methods

constructor __construct [line 87]

Tags:

Parameters:

method call_proc [line 587]

Tags:

Parameters:

method call_proc_sudo [line 591]

Tags:

Parameters:

method compare_versions [line 397]

Tags:

Parameters:

method connect [line 469]

Tags:

Parameters:

method copy_storehouse [line 422]

Tags:

Parameters:

method copy_storehouse_raw [line 440]

Tags:

Parameters:

method fix_apache_perms [line 409]

Tags:

Parameters:

method generate_locales [line 166]

Tags:

method get_application_installs [line 363]

Tags:

method get_audit_status [line 156]

Tags:

method get_author [line 148]

Tags:

method get_author_address [line 624]

Tags:

method get_database_prefix [line 537]

Tags:

method get_dependencies [line 561]

Tags:

method get_description [line 138]

Tags:

method get_install_database [line 726]

Tags:

method get_install_path [line 453]

Tags: