PHPDS: the main class for the PHPDevShell engine
It can be used either standalone or embedded
NOTE: none of these methods are meant to be called by you. For standalone mode, consult PHPDevShell programmers' guide. For embedded mode, use the PHPDSlib
Located in /PHPDS.inc.php (line 38)
The textual path of PHPDS directory on disk (not the URL).
The higher the less backward-compatible.
Core system configuration settings.
Core object.
Core database object.
Main instance of the debug module, which handles startup init.
PHPDS is used throught the lib (true) or standalone (false).
Core system language values.
Core navigation object.
Main instance of the notification module
Contains array of installed supportive plugin classes.
Core security object.
Execution stage (i.e. run level)
Main instance of the tagger module
Core template object.
Core user object.
Constructor: initialize the instance and starts the configuration process
Destruct Class.
Simply returns basepath
An optional postfix (i.e. folder name) can be given to retrieve the path a subfolder
Main configuration method: load settings, create menus, templates, and so on After that, everything is ready to run all config_*() methods are meant to be called only at startup time by config()
Fetch core settings from the site configuration stored in the database Also fetch some settings from the session and the locales
Deal with the "session" part of the configuration
In standalone mode, create the sessions ; in embedded mode, fetch the current session (we hijack the session, we don't create a new one)
NOTE: in embedded mode you MUST create a session before using PHPDSlib
Copy an array to another and defaults to false if the value isn't set
Copy settings from the database-loaded array. Converts and defaults to false if the value isn't set
This is a generic accessor to allow field access through an homogeneous and controlled way.
For example:
$instance->get('core')
will return the core object as returned by the core() accessor method
Load one config file, if it exists
If it's ok, its name is added to $configuration['config_files']
Check if instance is embedded.
Create a config from the config files, and store it in the instance field
The actual configuration is loaded from two files (one is generic, the other is specific) from the config/ folder.
Load one config file, if it exists; also tried a ".local" with the same name
Loads extra broad based system functions.
Load plugin-specific host-style config
This allows plugins to provide a configuration, for example when 1 plugin <=> 1 site
Send info data to the debug subsystem (console, firebug, ...)
The goal of this function is to be called all thourough the code to be able to track bugs.
Autoloader: when a class is instanciated, this method will load the proper php file
Note: the various folders where the files are looked for depends on the instance configuration, and on the current plugin
A model file is also loaded if present
Allow access to configuration, either read (no param) or write
This makes possible to start with a forced configuration, for testing for example
It returns the configuration array
CAUTION: an array is not an object so be carefull to use & if you need to modify it
Allow access to the (formerly) global core subsystem
One is created if necessary.
You can override to use you own core subsystem
Allow access to the (formerly) global database subsystem
One is created if necessary.
You can override to use you own database subsystem
Allow access to the global debugging subsystem
One is created if necessary.
You can override to use you own core subsystem
Custom Error Handler.
One is created if necessary.
You can override to use you own core subsystem
Allow access to the (formerly) global templating subsystem
One is created if necessary.
You can override to use you own templating subsystem
Allow access to the (formerly) global navigation subsystem
One is created if necessary.
You can override to use you own navigation subsystem
Allow access to the aynschronous notifications subsystem
One is created if necessary.
You can override to use you own tagging subsystem
Allow access to the (formerly) global security subsystem
One is created if necessary.
You can override to use you own security subsystem
Allow access to the tagging subsystem
One is created if necessary.
You can override to use you own tagging subsystem
Allow access to the (formerly) global templating subsystem
One is created if necessary.
You can override to use you own templating subsystem
Provides a variaty of user functions.
One is created if necessary.
You can override to use you own core subsystem
Actual starting point of the (non-embedded) PHPDS engine
Try to load a class from a file
NOTE: for performance reason we DON'T try first to see if the class already exists
Try to load a class from a file
NOTE: for performance reason we DON'T try first to see if the class already exists
Create a new instance of the given class and link it as dependant (arguments as an array)
Alias for log() - don't use it doesn't follow the guidelines
Documentation generated on Tue, 09 Aug 2011 09:05:00 +0200 by phpDocumentor 1.4.3