Docs For Class InstallHandler

Description

The class which responds to installer actions

Located in /system/classes/installhandler.php (line 7)

ActionHandler
   |
   --InstallHandler

Method Summary

void activate_plugins ()

void act_begin_install ()

void ajax_check_mysql_credentials ()

void ajax_check_pgsql_credentials ()

void ajax_check_sqlite_credentials ()

void check_htaccess ()

void form_defaults ()

void get_plugins ()

void htaccess ()

bool secure_sqlite ()

void sqlite_contents ()

void upgrade_db ()

void write_htaccess ([bool $exists = FALSE], [bool $update = FALSE], [bool $rewritebase = TRUE])

Variables

Inherited Variables

Inherited from ActionHandler

ActionHandler::$action
ActionHandler::$handler_vars

Methods

activate_plugins (line 751)

access: public

void activate_plugins ()

act_begin_install (line 14)

Entry point for installation. The reason there is a begin_install method to handle is that conceivably, the user can stop installation mid-install and need an alternate entry point action at a later time.

access: public

void act_begin_install ()

ajax_check_mysql_credentials (line 1197)

Validate database credentials for MySQL

Try to connect and verify if database name exists

access: public

void ajax_check_mysql_credentials ()

ajax_check_pgsql_credentials (line 1261)

Validate database credentials for PostgreSQL

Try to connect and verify if database name exists

access: public

void ajax_check_pgsql_credentials ()

ajax_check_sqlite_credentials (line 1325)

Validate database credentials for SQLite

Try to connect and verify if database name exists

access: public

void ajax_check_sqlite_credentials ()

check_htaccess (line 809)

checks for the presence of an .htaccess file

invokes write_htaccess() as needed

access: public

void check_htaccess ()

form_defaults (line 246)

access: public

void form_defaults ()

get_plugins (line 184)

access: public

void get_plugins ()

htaccess (line 786)

returns an array of .htaccess declarations used by Habari

access: public

void htaccess ()

secure_sqlite (line 931)

attempts to write the Files clause to the .htaccess file if the clause for this sqlite doesn't exist.

return: success or failure
access: public

bool secure_sqlite ()

sqlite_contents (line 911)

returns an array of Files declarations used by Habari

access: public

void sqlite_contents ()

upgrade_db (line 1096)

Upgrade the database when the database version stored is lower than the one in source

todo: Make more db-independent
access: public

void upgrade_db ()

write_htaccess (line 861)

attempts to write the .htaccess file if none exists

or to write the Habari-specific portions to an existing .htaccess

access: public

void write_htaccess ([bool $exists = FALSE], [bool $update = FALSE], [bool $rewritebase = TRUE])

bool $exists: whether an .htaccess file already exists or not
bool $update: whether to remove and re-create any existing Habari block
bool $rewritebase: whether to try a rewritebase in the .htaccess

Inherited Methods

Inherited From ActionHandler

ActionHandler::act()
ActionHandler::act_redirect()
ActionHandler::__call()