Bonfire includes the Installer_lib library to simplify the installation process.
For additional information, see Installing Bonfire.
This documentation is primarily intended for those who wish to improve or extend the Installer_lib.
The library is not intended for use within an application, and should be removed once the application is installed.
The library can be configured by setting the following values in /application/config/installer_lib.php.
An array of directory paths to be checked to determine whether they are writable during installation (or in the sysinfo module's Developer controller).
Each path should start with application or public, directory separators (slash or backslash) should not be used at either the beginning or end of a directory path in this array.
The library will automatically replace application with the absolute value of APPPATH and public with the absolute value of FCPATH.
An array of file paths to be checked to determine whether they are writable during installation (or in the sysinfo module's Developer controller).
The format of these paths should be the same as the format of the writable_folders values.
Boolean property to indicate to the install controller whether the default database settings were found.
Boolean property to indicate to the install controller whether the database settings were found/loaded.
The version of the currently-running PHP parser/extension.
Set to the result of phpversion() by the php_acceptable() method.
Checks an array of files/folders to see if they are writable and returns the results in a format usable in the requirements check step of the installation.
This is called by check_files() and check_folders() (both listed below).
If nothing is passed to this method, the default files and folders will be checked, but the returned data will not be separated as expected by the Install controller.
Note that this method may not currently work properly if you attempt to check files/directories in locations other than public/ and application/, though it will replace paths starting with application/ with the value of APPPATH.
The files/directories used by this method and the check_files() and check_folders() methods by default can be configured in /application/config/installer_lib.php as arrays in $config['writable_folders'] and $config['writable_files'].
Determine whether the installed version of PHP is above $version.
Returns true if the installed version is at or above $version, else it returns false.
Checks for the existence of the class/function required to use the posted driver.
Attempts to connect ot the database given by the posted settings.
If the db_available() method fails or the posted settings cause a connection failure, this method will return false.
Performs some basic checks to determine whether the application has been installed.
Each of the checks below runs in sequence, so later items are not checked if an earlier checks returns a value.
- If /application/config/installed.txt is found, returns true.
- If the database config could not be found, returns false.
- If $db['default'] has not been defined by the database config, returns false.
- If the default database settings could not be found, returns false.
- If the 'users' table does not exist, returns false.
- If the 'users' table is empty, returns false.
- If the method has not returned yet, returns true.
Determines whether the curl_init() function exists.
Checks an array of folders to determine whether they are writable and returns the results in a format usable in the requirements check step of the installation process.
If $folders is not provided, uses the configured writable_folders value.
Checks an array of files to see if they are writable and returns the results in a format usable in the requirements check step of the installation.
If $files is not provided, uses the configured writable_files value.
Perform the actual installation:
- Loads the database.
- Installs the Bonfire core migrations.
- Configures the site settings.
- Creates the admin user.
- Creates a unique encryption key for the site.
- Runs any application module migrations.
- Creates the installed.txt file in /application/config/ to speed up the process of checking whether the application is installed in the future.
- Adds $config['bonfire.installed'] = "1"; to /application/config/application.php, which is checked by App_hooks to determine whether certain hooks (which don't work properly during installation) should be run.