Docs For Class Bootstrap

Description

abstract: Bootstrap, loads all of our configurations and required classes.
usedby: App

Located in /bootstrap.php (line 58)

Base
   |
   --Bootstrap

Direct descendents

Class	Description
App

Variable Summary

object $cache

object $db

object $error

object $file

object $form

object $html

object $install

object $json

object $log

object $mail

object $model

object $modules

object $params

object $prefs

object $router

object $scaffold

object $security

object $settings

object $sml

object $template

object $thumbnail

object $user

object $xml

Method Summary

static boolean checkUserConfigExists ([string $config_path = false])

static array loadAllConfigs ()

static array loadDefaultConfig ()

Bootstrap __construct ( $config)

void awaitingUpgrade ()

void callPluginHook ([string $hook_to_call = false], [array $plugins = false])

boolean checkDbConnection ()

mixed config ([string $key = false])

string formatVersionNumber (string $build)

array getConfig ()

array getInstalledModuleGuids ()

array getLoadedLibraries ()

void getModuleRegistry ()

boolean isInstalled ()

boolean isLibraryLoaded (string $library)

mixed latestVersion ()

boolean listModules ()

boolean loadModule (string $module)

boolean loadSystemLibraryArray (array $library_array)

object moduleRegistry ([string $guid = false], [string $name = false], [string $interface = false])

void parsePluginRegistries ()

boolean requireLogin ()

void setConfig (string $key, mixed $value)

string versionCompare (string $build, string $match)

Variables

object $cache = false (line 64)

var: Holds the cache control object
access: public

object $db = false (line 70)

var: Holds the database object
access: public

object $error = false (line 76)

var: Holds the error handler object
access: public

object $file = false (line 82)

var: Holds our file handling object
access: public

object $form = false (line 88)

var: Holds our form validation object
access: public

object $html = false (line 94)

var: Holds the HTMLPurifier object
access: public

object $install = false (line 100)

var: Holds our installer object
access: public

object $json = false (line 106)

var: Holds our json format functions
access: public

object $log = false (line 112)

var: System logging methods
access: public

object $mail = false (line 118)

var: Holds the mailer object
access: public

object $model = false (line 124)

var: Holds the model object
access: public

object $modules = false (line 130)

var: Holds the module object
access: public

object $params = false (line 136)

var: Holds the Inpeskt object
access: public

object $prefs = false (line 142)

var: Holds the preferences object
access: public

object $router = false (line 148)

var: Holds the router object
access: public

object $scaffold = false (line 154)

var: Holds the scaffolding object
access: public

object $security = false (line 160)

var: Holds the security object
access: public

object $settings = false (line 166)

var: Holds the settings object
access: public

object $sml = false (line 172)

var: Holds the session message log object
access: public

object $template = false (line 178)

var: Holds the template object
access: public

object $thumbnail = false (line 184)

var: Holds the thumbail object
access: public

object $user = false (line 190)

var: Holds the user object
access: public

object $xml = false (line 196)

var: Holds the xml format object
access: public

Methods

static method checkUserConfigExists (line 380)

abstract: Verifies whether or not the user config file exists
access: public

static boolean checkUserConfigExists ([string $config_path = false])

string $config_path: Path to configuration location

static method loadAllConfigs (line 401)

abstract: Loads all config files
access: public

static array loadAllConfigs ()

static method loadDefaultConfig (line 355)

abstract: Loads the default config file
access: public

static array loadDefaultConfig ()

Constructor __construct (line 241)

Constructor, loads configurations and required classes.

The order in which these items are processed is very important - do not move items around.

access: public

Bootstrap __construct ( $config)

$config

Redefined in descendants as:

App::__construct()

awaitingUpgrade (line 1102)

abstract: Determines whether or not the database is awaiting an auto-upgrade
access: public

void awaitingUpgrade ()

callPluginHook (line 844)

abstract: Calls plugins registered for any hooks
access: public

void callPluginHook ([string $hook_to_call = false], [array $plugins = false])

string $hook_to_call
array $plugins

checkDbConnection (line 718)

abstract: Returns whether or not our db connection was made, and tables exist
access: public

boolean checkDbConnection ()

config (line 454)

abstract: Returns a configuration value from config files
access: public

mixed config ([string $key = false])

string $key

formatVersionNumber (line 1178)

abstract: formats a version number to match a 1.2.3.456 or similar type format
access: public

string formatVersionNumber (string $build)

string $build

getConfig (line 467)

abstract: Returns the configuration array
access: public

array getConfig ()

getInstalledModuleGuids (line 960)

abstract: Returns the module list as an array
access: public

array getInstalledModuleGuids ()

getLoadedLibraries (line 692)

abstract: Returns the array of loaded system classes
access: public

array getLoadedLibraries ()

getModuleRegistry (line 929)

abstract: Returns the module registry (xml object)
access: public

void getModuleRegistry ()

isInstalled (line 327)

abstract: Determines whether or not the app has been installed
access: public

boolean isInstalled ()

isLibraryLoaded (line 703)

abstract: Returns whether or not a library is loaded
access: public

boolean isLibraryLoaded (string $library)

string $library

latestVersion (line 1200)

abstract: Returns the latest build number from the database
access: public

mixed latestVersion ()

listModules (line 939)

abstract: Gathers a list of installed modules from db, stores it in local array.
access: public

boolean listModules ()

loadModule (line 1009)

abstract: Loads a module
access: public

boolean loadModule (string $module)

string $module: GUID of module to load

loadSystemLibraryArray (line 637)

Accepted values for load_core_class are:

'classname' => 'Security', 'folder' => false, 'filename' => false, 'var' => false, 'autoload' => false, 'extends' => 'childclassname' 'root' => '/full/path/to/root/of/class'

Accepted values for custom_classes are: 'classname' => 'Myclass', 'root' => '/full/path/to/root/of/class', 'extends' => 'Settings'

abstract: Accepts an array of system libraries to load
access: public

boolean loadSystemLibraryArray (array $library_array)

array $library_array

moduleRegistry (line 891)

abstract: Returns a specific registry object for a selected module
access: public

object moduleRegistry ([string $guid = false], [string $name = false], [string $interface = false])

string $guid
string $name
string $interface

parsePluginRegistries (line 786)

abstract: Scans the file system for any plugins
access: public

void parsePluginRegistries ()

requireLogin (line 488)

abstract: Returns whether or not login is required for the current interface application.
access: public

boolean requireLogin ()

setConfig (line 478)

abstract: Sets a config value
access: public

void setConfig (string $key, mixed $value)

string $key
mixed $value

versionCompare (line 1137)

abstract: Compared two version strings for similarity
access: public

string versionCompare (string $build, string $match)

string $build
string $match