![]() |
CMS
Version 3.9
|
ComponentManager provides the core functionality for building the component map describing the application configuration. More...
Public Member Functions | |
ComponentManager () | |
Creates a new ComponentManager object. More... | |
scanComponents ($root, $subdir) | |
Scan the specified root and sub-directory for components. More... | |
scanAdminPages ($component) | |
Builds the administration page map for the specified component. More... | |
scanComponentPages ($component) | |
Scan and build the compoment page map for the specified component. More... | |
scan ($verbosity=0) | |
Scans the application home directory and PHP include path and builds the component and administration page map that describe the configuration of the application. More... | |
getComponent ($component) | |
Retrieve the component definition record for the specified component. More... | |
dispatchAction ($process=null) | |
Dispatch an incoming user action to the appropriate component handler script. More... | |
dispatchLocalAction ($action, $process=null) | |
Static Public Member Functions | |
static | scanTrace ($message, $level) |
static | findComponentPath ($name) |
Locate the component path for the named component using the standard precedence rules. More... | |
static | getEventHandlers () |
Retrieve the event handler map. More... | |
static | compareByPriority ($item1, $item2) |
Priority comparison callback - not for external use. More... | |
static | fireEvent ($event, $parameter=null, $mustBeConsumed=false) |
Fire an event to all subscribers as detailed in their manifests. More... | |
static | fireEventTo ($event, $component, $parameter=null) |
Fire an event to the specificed component. More... | |
static | displayPage ($identifier, &$continue) |
static | enumerateComponentPages ($items) |
static | deleteRole ($del_role) |
static | setComponentVersion ($component_name) |
static | upgradeComponent ($version) |
static | componentListTabs () |
static | componentPageTabs ($key) |
static | componentFormTabs ($key) |
static | setDefaults () |
static | getComponentSignature () |
Retrieves a unique signature for the application's enabled components, based on their installed version numbers. More... | |
Public Attributes | |
$found = array() | |
Static Public Attributes | |
static | $verbosityLevel = 0 |
Verbosity level for component scan (same as trace level) More... | |
static | $plainOutput = false |
Set to true for plain text output during component scan. More... | |
ComponentManager provides the core functionality for building the component map describing the application configuration.
It also scans components to build the administration section page map, and provides an event dispatching mechanism allowing PHP or client-side scripts to pass events or perform actions on a component without directly instantiating any classes related to the component.
Definition at line 49 of file component_manager.inc.
|
static |
Priority comparison callback - not for external use.
array | $item1 | |
array | $item2 |
Definition at line 430 of file component_manager.inc.
|
static |
Definition at line 795 of file component_manager.inc.
|
static |
Definition at line 772 of file component_manager.inc.
ComponentManager::ComponentManager | ( | ) |
Creates a new ComponentManager object.
Definition at line 80 of file component_manager.inc.
|
static |
|
static |
Definition at line 730 of file component_manager.inc.
ComponentManager::dispatchAction | ( | $process = null | ) |
Dispatch an incoming user action to the appropriate component handler script.
string | $process | (optional) process identifier if running as a background process |
Definition at line 545 of file component_manager.inc.
ComponentManager::dispatchLocalAction | ( | $action, | |
$process = null |
|||
) |
Definition at line 625 of file component_manager.inc.
|
static |
Definition at line 688 of file component_manager.inc.
|
static |
Definition at line 722 of file component_manager.inc.
|
static |
Locate the component path for the named component using the standard precedence rules.
string | $name |
Definition at line 333 of file component_manager.inc.
|
static |
Fire an event to all subscribers as detailed in their manifests.
string | $event | the name of the event |
array | $parameter | any parameters being passed to the event |
boolean | $mustBeConsumed | if set to true, throws FakoliEventNotConsumed if no event handler has indicated consumption of the event by setting $continue to false |
Definition at line 442 of file component_manager.inc.
|
static |
Fire an event to the specificed component.
If the component is not subscribed the event is ignored.
string | $event | the name of the event |
string | $component | The name of the target component |
array | $parameter | any parameters being passed to the event |
Definition at line 504 of file component_manager.inc.
ComponentManager::getComponent | ( | $component | ) |
Retrieve the component definition record for the specified component.
$component | the name of the component |
Definition at line 370 of file component_manager.inc.
|
static |
Retrieves a unique signature for the application's enabled components, based on their installed version numbers.
This enables the administrator to determine at a glance if the configuration of two Fakoli servers is the same.
Definition at line 827 of file component_manager.inc.
|
static |
Retrieve the event handler map.
The map is generated on the first request and cached for future reference.
Definition at line 386 of file component_manager.inc.
ComponentManager::scan | ( | $verbosity = 0 | ) |
Scans the application home directory and PHP include path and builds the component and administration page map that describe the configuration of the application.
Definition at line 246 of file component_manager.inc.
ComponentManager::scanAdminPages | ( | $component | ) |
Builds the administration page map for the specified component.
$component | the component being scanned |
Definition at line 166 of file component_manager.inc.
ComponentManager::scanComponentPages | ( | $component | ) |
Scan and build the compoment page map for the specified component.
$component | the component to be scanned. |
Definition at line 198 of file component_manager.inc.
ComponentManager::scanComponents | ( | $root, | |
$subdir | |||
) |
Scan the specified root and sub-directory for components.
$root | |
$subdir |
Definition at line 90 of file component_manager.inc.
|
static |
Definition at line 57 of file component_manager.inc.
|
static |
Definition at line 741 of file component_manager.inc.
|
static |
Definition at line 808 of file component_manager.inc.
|
static |
Definition at line 765 of file component_manager.inc.
ComponentManager::$found = array() |
Definition at line 51 of file component_manager.inc.
|
static |
Set to true for plain text output during component scan.
Definition at line 54 of file component_manager.inc.
|
static |
Verbosity level for component scan (same as trace level)
Definition at line 53 of file component_manager.inc.