Plugins

# Class: ClientHello Source Location: /projects/test_main/plugins/hello/client/ClientHello.php
### Class Overview
    PluginBase
       |
       --ClientPlugin
          |
          --ClientHello
Demo plugin, shows how to output messages and use sessions. | ### Variables $count $log $message | ### Constants HELLO_INPUT | ### Methods __construct ajaxGetPluginResponse ajaxHandleAction createSession handleHttpGetRequest handleHttpPostRequest loadSession renderForm saveSession
### Inherited Constants #### Class: ClientPlugin ClientPlugin::ENABLE_LEVEL_FULL ClientPlugin::ENABLE_LEVEL_LOAD ClientPlugin::ENABLE_LEVEL_PROCESS ClientPlugin::ENABLE_LEVEL_SERVERCALL | ### Inherited Variables #### Class: ClientPlugin ClientPlugin::$cartoclient ClientPlugin::$config ClientPlugin::$enabledLevel #### Class: PluginBase PluginBase::$basePath PluginBase::$name PluginBase::$overriddenRequest | ### Inherited Methods #### Class: ClientPlugin ClientPlugin::__construct() Constructor ClientPlugin::checkBool() Checks if variable $variable has a boolean (0 or 1) value $value. ClientPlugin::checkInt() Checks if variable $variable has an integer positive or zero value $value. ClientPlugin::checkNumeric() Checks if variable $variable has a numeric value $value. ClientPlugin::disable() Sets the enable level to ClientPlugin::ENABLE_LEVEL_SERVERCALL. ClientPlugin::enable() Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL. ClientPlugin::getCartoclient() ClientPlugin::getConfig() ClientPlugin::getEnabledLevel() Returns the enable level. ClientPlugin::getHttpValue() Returns the user-submitted $key data if it is set. ClientPlugin::initializeConfig() Initializes plugin configuration ClientPlugin::isEnabledAtLevel() Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL. ClientPlugin::setEnableLevel() Sets the enable level (to be used with the AJAX mode). #### Class: PluginBase PluginBase::__construct() Constructor PluginBase::account() Records an accounting message for plugins PluginBase::getBasePath() PluginBase::getExtendedName() PluginBase::getName() PluginBase::getRequest() Get plugin's request or result out of MapRequest or MapResult PluginBase::initialize() Plugin initialization (can be extended in custom plugins) PluginBase::initializeConfig() Initializes plugin PluginBase::preInitialize() Plugin pre initialization. In most cases, plugins should use PluginBase::replacePlugin() Returns name of parent plugin in case of plugin extension PluginBase::setBasePath() PluginBase::setExtendedName() PluginBase::setName()
### Class Details [line 28] Demo plugin, shows how to output messages and use sessions. [ Top ] ### Class Variables #### $count = [line 46] #### Tags:
access: | protected
Type: | int
[ Top ] #### $log = [line 36] #### Tags:
access: | private
Type: | Logger
Overrides: | Array
[ Top ] #### $message = [line 41] #### Tags:
access: | protected
Type: | string
[ Top ] ### Class Methods ### constructor __construct [line 51]
`ClientHello __construct( )`
Constructor #### Tags:
access: | public
Overrides ClientPlugin::__construct() (Constructor) [ Top ] ### method ajaxGetPluginResponse [line 114]
`void ajaxGetPluginResponse( AjaxPluginResponse $ajaxPluginResponse)`
#### Tags:
access: | public
see: | Ajaxable::ajaxGetPluginResponse()
[ Top ] ### method ajaxHandleAction [line 124]
`void ajaxHandleAction( mixed $actionName, PluginEnabler $pluginsDirectives)`
#### Tags:
access: | public
see: | Ajaxable::ajaxHandleAction()
[ Top ] ### method createSession [line 69]
`void createSession( MapInfo $mapInfo, InitialMapState $initialMapState)`
Initializes session-saved var "count" to 0. #### Tags:
access: | public
see: | Sessionable::createSession()
[ Top ] ### method handleHttpGetRequest [line 96]
`void handleHttpGetRequest( mixed $request)`
Not used. #### Tags:
access: | public
see: | GuiProvider::handleHttpGetRequest()
[ Top ] ### method handleHttpPostRequest [line 86]
`void handleHttpPostRequest( mixed $request)`
Increments count number and retrieves POST'ed message. #### Tags:
access: | public
see: | GuiProvider::handleHttpPostRequest()
[ Top ] ### method loadSession [line 61]
`void loadSession( mixed $sessionObject)`
Retrieves count number from session. #### Tags:
access: | public
see: | Sessionable::loadSession()
[ Top ] ### method renderForm [line 102]
`void renderForm( Smarty $template)`
Draws plugins interface. #### Tags:
access: | public
see: | GuiProvider::renderForm()
[ Top ] ### method saveSession [line 78]
`void saveSession( )`
Saves count number in session. #### Tags:
access: | public
see: | Sessionable::saveSession()
[ Top ] ### Class Constants #### HELLO_INPUT = 'hello_input' [line 31] [ Top ] Documentation generated on Fri, 21 Sep 2007 13:30:37 +0200 by phpDocumentor 1.3.0RC3