|
CWIS Developer Documentation
|
Manager to load and invoke plugins. More...
Public Member Functions | |
| __construct ($AppFramework, $PluginDirectories) | |
| PluginManager class constructor. More... | |
| LoadPlugins ($ForcePluginConfigOptLoad=FALSE) | |
| Load and initialize plugins. More... | |
| GetErrorMessages () | |
| Retrieve any error messages generated during plugin loading. More... | |
| GetStatusMessages () | |
| Get/set any status messages generated during plugin loading or via plugin method calls. More... | |
| GetPlugin ($PluginName) | |
| Retrieve specified plugin. More... | |
| GetPluginForCurrentPage () | |
| Retrieve plugin for current page (if any). More... | |
| GetPluginAttributes () | |
| Retrieve info about currently loaded plugins. More... | |
| GetDependents ($PluginName) | |
| Returns a list of plugins dependent on the specified plugin. More... | |
| GetActivePluginList () | |
| Get list of active (i.e. More... | |
| PluginEnabled ($PluginName, $NewValue=NULL) | |
| Get/set whether specified plugin is enabled. More... | |
| UninstallPlugin ($PluginName) | |
| Uninstall plugin and (optionally) delete any associated data. More... | |
Manager to load and invoke plugins.
Definition at line 13 of file PluginManager.php.
| PluginManager::__construct | ( | $AppFramework, | |
| $PluginDirectories | |||
| ) |
PluginManager class constructor.
| ApplicationFramework | $AppFramework | ApplicationFramework within which plugins should run. |
| array | $PluginDirectories | Array of names of directories containing plugins, in the order they should be searched. |
Definition at line 24 of file PluginManager.php.
| PluginManager::GetActivePluginList | ( | ) |
Get list of active (i.e.
enabled) plugins.
Definition at line 394 of file PluginManager.php.
References PluginEnabled().
| PluginManager::GetDependents | ( | $PluginName | ) |
Returns a list of plugins dependent on the specified plugin.
| string | $PluginName | Base name of plugin. |
Definition at line 374 of file PluginManager.php.
References GetPluginAttributes().
| PluginManager::GetErrorMessages | ( | ) |
Retrieve any error messages generated during plugin loading.
Definition at line 298 of file PluginManager.php.
| PluginManager::GetPlugin | ( | $PluginName | ) |
Retrieve specified plugin.
| string | $PluginName | Base name of plugin. |
Definition at line 319 of file PluginManager.php.
Referenced by GetPluginForCurrentPage().

| PluginManager::GetPluginAttributes | ( | ) |
Retrieve info about currently loaded plugins.
Definition at line 352 of file PluginManager.php.
Referenced by GetDependents().

| PluginManager::GetPluginForCurrentPage | ( | ) |
Retrieve plugin for current page (if any).
This method relies on the current page having been found within the plugin directory (usually via a "P_" prefix on the page name) via a call to the hooked FindPluginPhpFile() or FindPluginHtmlFile() methods..
Definition at line 343 of file PluginManager.php.
References GetPlugin().
| PluginManager::GetStatusMessages | ( | ) |
Get/set any status messages generated during plugin loading or via plugin method calls.
Definition at line 309 of file PluginManager.php.
| PluginManager::LoadPlugins | ( | $ForcePluginConfigOptLoad = FALSE | ) |
Load and initialize plugins.
The $ForcePluginConfigOptLoad value only applies to plugins that use Plugin::SetUpConfigOptions() to set up their configuration options; plugins that set up their config options via Plugin::Register() will always have them set up.
| bool | $ForcePluginConfigOptLoad | If TRUE, configuration options are loaded for all plugins, regardless of whether they are currently enabled. (OPTIONAL, defaults to FALSE) |
Definition at line 53 of file PluginManager.php.
References PluginEnabled().
| PluginManager::PluginEnabled | ( | $PluginName, | |
$NewValue = NULL |
|||
| ) |
Get/set whether specified plugin is enabled.
| string | $PluginName | Base name of plugin. |
| bool | $NewValue | TRUE to enable, FALSE to disable. (OPTIONAL) |
Definition at line 405 of file PluginManager.php.
Referenced by GetActivePluginList(), LoadPlugins(), and UninstallPlugin().

| PluginManager::UninstallPlugin | ( | $PluginName | ) |
Uninstall plugin and (optionally) delete any associated data.
| string | $PluginName | Base name of plugin. |
Definition at line 434 of file PluginManager.php.
References PluginEnabled().