CorePlugins

# Class: ClientStatictools Source Location: /coreplugins/statictools/client/ClientStatictools.php
### Class Overview
    PluginBase
       |
       --ClientPlugin
          |
          --ClientStatictools
A client plugin class for displaying static tools, like tools for measrurement. | ### Variables $log | ### Constants TOOL_DISTANCE TOOL_SURFACE | ### Methods __construct getTools handleApplicationTool handleHttpGetRequest handleHttpPostRequest handleKeymapTool handleMainmapTool renderForm
### 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 29] A client plugin class for displaying static tools, like tools for measrurement. [ Top ] ### Class Variables #### $log = [line 34] #### Tags:
access: | private
Type: | Logger
Overrides: | Array
[ Top ] ### Class Methods ### constructor __construct [line 45]
`ClientStatictools __construct( )`
Constructor #### Tags:
access: | public
Overrides ClientPlugin::__construct() (Constructor) [ Top ] ### method getTools [line 91]
`void getTools( )`
#### Tags:
access: | public
see: | ToolProvider::getTools()
[ Top ] ### method handleApplicationTool [line 86]
`void handleApplicationTool( ToolDescription $tool)`
#### Tags:
access: | public
see: | ToolProvider::handleApplicationTool()
[ Top ] ### method handleHttpGetRequest [line 58]
`void handleHttpGetRequest( mixed $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpPostRequest()
[ Top ] ### method handleHttpPostRequest [line 53]
`void handleHttpPostRequest( mixed $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpPostRequest()
[ Top ] ### method handleKeymapTool [line 80]
`void handleKeymapTool( ToolDescription $tool, Shape $keymapShape)`
#### Tags:
access: | public
see: | ToolProvider::handleKeymapTool()
[ Top ] ### method handleMainmapTool [line 74]
`void handleMainmapTool( ToolDescription $tool, Shape $mainmapShape)`
#### Tags:
access: | public
see: | ToolProvider::handleMainmapTool()
[ Top ] ### method renderForm [line 63]
`void renderForm( Smarty $template)`
#### Tags:
access: | public
see: | GuiProvider::renderForm()
[ Top ] ### Class Constants #### TOOL_DISTANCE = 'distance' [line 39] Tools constants [ Top ] #### TOOL_SURFACE = 'surface' [line 40] [ Top ] Documentation generated on Fri, 21 Sep 2007 13:30:43 +0200 by phpDocumentor 1.3.0RC3