Client

# Class: PluginEnabler Source Location: /client/AjaxHelper.php
### Class Overview
Abstraction class for defining plugins' enable level | ### Variables $cartoclient | ### Methods __construct checkLoaded disableCoreplugins disablePlugin disablePlugins enablePlugin getCorepluginNames getPlugin getPlugins isCoreplugin isLoaded setEnableLevel
### Class Details [line 114] Abstraction class for defining plugins' enable level This object is used by plugins in Ajaxable::ajaxHandleAction() to set plugins' enableLevel in AJAX mode [ Top ] ### Class Variables #### $cartoclient = [line 119] #### Tags:
var: | Cartoclient instance
access: | protected
Type: | Cartoclient
[ Top ] ### Class Methods ### constructor __construct [line 125]
`PluginEnabler __construct( Cartoclient &$cartoclient)`
Constructor #### Tags:
access: | public
#### Parameters:
Cartoclient | &$cartoclient | cartoclient instance
[ Top ] ### method checkLoaded [line 168]
`void checkLoaded( mixed $pluginName)`
#### Tags:
access: | protected
[ Top ] ### method disableCoreplugins [line 189]
`void disableCoreplugins( )`
Disables all coreplugins: set their enable level to ClientPlugin::ENABLE_LEVEL_LOAD. #### Tags:
access: | public
[ Top ] ### method disablePlugin [line 226]
`void disablePlugin( string $pluginName)`
Disables the given plugin name: set its enable level to to ClientPlugin::ENABLE_LEVEL_LOAD. #### Tags:
access: | public
#### Parameters:
string | $pluginName | name of the coreplugin to enable
[ Top ] ### method disablePlugins [line 202]
`void disablePlugins( )`
Disables all plugins that are not coreplugins: set their enable level to ClientPlugin::ENABLE_LEVEL_LOAD. #### Tags:
access: | public
[ Top ] ### method enablePlugin [line 216]
`void enablePlugin( string $pluginName)`
Enables the given plugin name: set its enable level to to ClientPlugin::ENABLE_LEVEL_LOAD. #### Tags:
access: | public
#### Parameters:
string | $pluginName | name of the plugin to enable
[ Top ] ### method getCorepluginNames [line 155]
`array getCorepluginNames( )`
Wrapper method for PluginManager::getCorepluginNames(). #### Tags:
return: | array of coreplugins names (string)
access: | protected
see: | PluginManager::getCorepluginNames()
[ Top ] ### method getPlugin [line 137]
`ClientPlugin getPlugin( string $pluginName)`
Wrapper method for PluginManager::getPlugin(). #### Tags:
access: | protected
see: | PluginManager::getPlugin()
#### Parameters:
string | $pluginName | name of the plugin whose instance is to be returned
[ Top ] ### method getPlugins [line 146]
`array getPlugins( )`
Wrapper method for PluginManager::getPlugins(). #### Tags:
return: | array of all loaded client plugin objects (ClientPlugin)
access: | protected
see: | PluginManager::getPlugins()
[ Top ] ### method isCoreplugin [line 180]
`bool isCoreplugin( string $pluginName)`
Returns true if the given plugin is a coreplugin #### Tags:
return: | true if the given plugin name is a coreplugin
access: | protected
#### Parameters:
string | $pluginName | name of the plugin
[ Top ] ### method isLoaded [line 164]
`bool isLoaded( string $pluginName)`
Returns true if the given plugin name is loaded. #### Tags:
return: | true if the given plugin name is loaded
access: | protected
#### Parameters:
string | $pluginName | name of the plugin
[ Top ] ### method setEnableLevel [line 239]
`void setEnableLevel( string $pluginName, int $enableLevelValue)`
Sets the enable level of the given plugin name to the given enable level value. to ClientPlugin::ENABLE_LEVEL_LOAD. #### Tags:
access: | public
see: | ClientPlugin
#### Parameters:
string | $pluginName | name of the plugin to enable
int | $enableLevelValue | value of the enable level to set
[ Top ] Documentation generated on Fri, 21 Sep 2007 13:30:29 +0200 by phpDocumentor 1.3.0RC3