Class: punBB_Install

Source Location: /oneclick/punBB/punBB.php

Class Overview

Module_Skeleton
   |
   --One_Click_Generic
      |
      --punBB_Install

Author(s):

Matt Saladna <msaladna@apisnetworks.com>
Provides basic hooks for the punBB application in esprit's one-click installation system

Methods

Inherited Variables

Class: One_Click_Generic

One_Click_Generic::$application_config_opts
One_Click_Generic::$configuration_options
One_Click_Generic::$function_int
One_Click_Generic::$installation_type
One_Click_Generic::$mysql
One_Click_Generic::$mysql_database
One_Click_Generic::$mysql_password
One_Click_Generic::$mysql_user
One_Click_Generic::$pgsql
One_Click_Generic::$pgsql_database
One_Click_Generic::$pgsql_password
One_Click_Generic::$pgsql_user
One_Click_Generic::$site_id

Inherited Methods

Class: One_Click_Generic

One_Click_Generic::__construct()
One_Click_Generic::call_proc()
One_Click_Generic::call_proc_sudo()
One_Click_Generic::compare_versions(): int compare_versions(string, string, string)
One_Click_Generic::connect()
One_Click_Generic::copy_storehouse()
One_Click_Generic::copy_storehouse_raw()
One_Click_Generic::fix_apache_perms(): bool fix_apache_perms(string[, bool = false])
One_Click_Generic::generate_locales()
One_Click_Generic::get_application_installs()
One_Click_Generic::get_audit_status()
One_Click_Generic::get_author()
One_Click_Generic::get_author_address()
One_Click_Generic::get_database_prefix()
One_Click_Generic::get_dependencies()
One_Click_Generic::get_description()
One_Click_Generic::get_install_database()
One_Click_Generic::get_install_path()
One_Click_Generic::get_install_url()
One_Click_Generic::get_instance_configuration()
One_Click_Generic::get_logo()
One_Click_Generic::get_original_version()
One_Click_Generic::get_postback()
One_Click_Generic::get_site_id()
One_Click_Generic::get_space()
One_Click_Generic::get_target_version()
One_Click_Generic::get_version()
One_Click_Generic::get_versions()
One_Click_Generic::get_version_hierarchy()
One_Click_Generic::get_website()
One_Click_Generic::install()
One_Click_Generic::log_status()
One_Click_Generic::mysql_import()
One_Click_Generic::patch()
One_Click_Generic::patch_exists(): 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.
One_Click_Generic::pgsql_import()
One_Click_Generic::post_configuration()
One_Click_Generic::post_install()
One_Click_Generic::post_patch()
One_Click_Generic::pre_configuration()
One_Click_Generic::pre_install()
One_Click_Generic::pre_patch()
One_Click_Generic::process_installation()
One_Click_Generic::query()
One_Click_Generic::render_configuration()
One_Click_Generic::setup_mysql()
One_Click_Generic::setup_pgsql()
One_Click_Generic::set_database_prefix()
One_Click_Generic::set_dependencies()
One_Click_Generic::set_description()
One_Click_Generic::set_function_int()
One_Click_Generic::set_install_type()
One_Click_Generic::set_mysql()
One_Click_Generic::set_pgsql()
One_Click_Generic::set_space()
One_Click_Generic::set_version()
One_Click_Generic::set_website()
One_Click_Generic::uninstall(): bool uninstall(string)
One_Click_Generic::upgrade()
One_Click_Generic::uses_sql()
One_Click_Generic::__call()
One_Click_Generic::__get()
One_Click_Generic::__set()

Class Details

[line 10]

Tags:

author:

Matt Saladna <msaladna@apisnetworks.com>

Provides basic hooks for the punBB application in esprit's one-click installation system

[ Top ]

Class Methods

constructor __construct [line 11]

punBB_Install __construct(

$mApp)

Tags:

access:

public

Overrides One_Click_Generic::__construct() (parent method not documented)

Parameters:

$mApp

[ Top ]

method install [line 124]

void install(
)

Perform the application installation process

This includes copying files into the system and updating any databases

Tags:

access:

public

Overrides One_Click_Generic::install() (parent method not documented)

[ Top ]

method patch [line 747]

void patch(
)

Call diff command, patch application, do anything else...

Not yet implemented.

Tags:

access:

public

Overrides One_Click_Generic::patch() (parent method not documented)

[ Top ]

method post_configuration [line 95]

void post_configuration(
)

Validate input.

Return a value of false to force the user to reconfigure.

Return an exception of type ArgumentError to let the user know what options are invalid. Example:

if (!preg_match('/^[a-z]+$/',$password)) return new ArgumentError(array("password" => "Invalid password"));

Tags:

access:

public

Overrides One_Click_Generic::post_configuration() (parent method not documented)

[ Top ]

method post_install [line 729]

void post_install(
)

Clean-up any remaining files, reinitialize variables, et cetera

Tags:

access:

public

Overrides One_Click_Generic::post_install() (parent method not documented)

[ Top ]

method post_patch [line 754]

void post_patch(
)

Post-patch cleanup

Tags:

access:

public

Overrides One_Click_Generic::post_patch() (parent method not documented)

[ Top ]

method pre_configuration [line 37]

void 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.

Use: return false; at the end of the function to prohibit the user from configuring or installing the application.

return true; allows the user to proceed with configuration of the application.

Example:

if (!$this->sql_service_enabled('mysql')) return false; // MySQL is not enabled for the account

Alternatively you can be a bit more verbose by returning an Exception if (!$this->sql_service_enabled('mysql')) return new PermissionError("MySQL not enabled for account");

Tags:

access:

public

Overrides One_Click_Generic::pre_configuration() (parent method not documented)

[ Top ]

method pre_install [line 115]

void pre_install(
)

Ensure that the filesystem meets the needs of the application.

Tags:

access:

public

Overrides One_Click_Generic::pre_install() (parent method not documented)

[ Top ]

method pre_patch [line 739]

void pre_patch(
)

Double check files exist prior to patch

Tags:

access:

public

Overrides One_Click_Generic::pre_patch() (parent method not documented)

[ Top ]

Documentation generated on Sat, 05 Jul 2008 04:00:44 -0400 by phpDocumentor 1.4.0