CWIS Developer Documentation
|
Manager to load and invoke plugins. More...
Public Member Functions | |
__construct ($AppFramework, $PluginDirectories) | |
PluginManager class constructor. More... | |
LoadPlugins () | |
Load and initialize plugins. More... | |
GetErrorMessages () | |
Retrieve any error messages generated during plugin loading. More... | |
GetPlugin ($PluginName, $EvenIfNotReady=FALSE) | |
Retrieve specified plugin. More... | |
GetPlugins () | |
Retrieve all loaded plugins. 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... | |
Static Public Member Functions | |
static | SetConfigValueLoader ($Func) |
Set function to load plugin configuration values from 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 25 of file PluginManager.php.
References ApplicationFramework\ORDER_LAST, and Plugin\SetApplicationFramework().
Referenced by SetConfigValueLoader().
PluginManager::GetActivePluginList | ( | ) |
Get list of active (i.e.
enabled and ready) plugins.
Definition at line 260 of file PluginManager.php.
PluginManager::GetDependents | ( | $PluginName | ) |
Returns a list of plugins dependent on the specified plugin.
string | $PluginName | Base name of plugin. |
Definition at line 240 of file PluginManager.php.
References GetPluginAttributes().
PluginManager::GetErrorMessages | ( | ) |
Retrieve any error messages generated during plugin loading.
Definition at line 155 of file PluginManager.php.
PluginManager::GetPlugin | ( | $PluginName, | |
$EvenIfNotReady = FALSE |
|||
) |
Retrieve specified plugin.
string | $PluginName | Base name of plugin. |
bool | $EvenIfNotReady | Return the plugin even if it's not marked as ready for use. (OPTIONAL, defaults to FALSE) |
Exception | If plugin is not initialized and ready. |
Definition at line 168 of file PluginManager.php.
Referenced by GetPluginForCurrentPage().
PluginManager::GetPluginAttributes | ( | ) |
Retrieve info about currently loaded plugins.
Definition at line 208 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 198 of file PluginManager.php.
References GetPlugin().
Referenced by SetConfigValueLoader().
PluginManager::GetPlugins | ( | ) |
Retrieve all loaded plugins.
Definition at line 186 of file PluginManager.php.
PluginManager::LoadPlugins | ( | ) |
Load and initialize plugins.
Definition at line 49 of file PluginManager.php.
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 279 of file PluginManager.php.
|
static |
Set function to load plugin configuration values from data.
callable | $Func | Loading function. |
InvalidArgumentException | If function is not callable. |
Definition at line 323 of file PluginManager.php.
References __construct(), ApplicationFramework\AddObjectDirectory(), and GetPluginForCurrentPage().
PluginManager::UninstallPlugin | ( | $PluginName | ) |
Uninstall plugin and (optionally) delete any associated data.
string | $PluginName | Base name of plugin. |
Definition at line 290 of file PluginManager.php.