CorePlugins

# Class: ClientTestMainLocation Source Location: /projects/test_main/coreplugins/testMainLocation/client/ClientTestMainLocation.php
### Class Overview
    PluginBase
       |
       --ClientPlugin
          |
          --ClientLocation
             |
             --ClientTestMainLocation
| ### Methods filterGetRequest filterPostRequest replacePlugin
### Inherited Constants #### Class: ClientLocation ClientLocation::TOOL_FULLEXTENT ClientLocation::TOOL_PAN ClientLocation::TOOL_ZOOMIN ClientLocation::TOOL_ZOOMOUT #### Class: ClientPlugin ClientPlugin::ENABLE_LEVEL_FULL ClientPlugin::ENABLE_LEVEL_LOAD ClientPlugin::ENABLE_LEVEL_PROCESS ClientPlugin::ENABLE_LEVEL_SERVERCALL | ### Inherited Variables #### Class: ClientLocation ClientLocation::$fullExtent ClientLocation::$locationRequest ClientLocation::$locationResult ClientLocation::$locationState ClientLocation::$log ClientLocation::$scales ClientLocation::$shortcuts ClientLocation::$smarty #### Class: ClientPlugin ClientPlugin::$cartoclient ClientPlugin::$config ClientPlugin::$enabledLevel #### Class: PluginBase PluginBase::$basePath PluginBase::$name PluginBase::$overriddenRequest | ### Inherited Methods #### Class: ClientLocation ClientLocation::__construct() Constructor ClientLocation::adjustExportMapRequest() ClientLocation::ajaxGetPluginResponse() ClientLocation::ajaxHandleAction() ClientLocation::buildRequest() ClientLocation::buildZoomPointRequest() Constructs a ZoomPointLocationRequest ClientLocation::createSession() ClientLocation::drawIdRecenter() Draws recenter on Ids form ClientLocation::drawRecenter() Draws recenter form ClientLocation::drawScales() Draws scales form ClientLocation::drawShortcuts() Draws shortcuts form ClientLocation::getCurrentScale() Returns current scale ClientLocation::getLocation() Returns current bbox ClientLocation::getLocationInformation() Returns a string with some location information (scale, bbox, etc.) ClientLocation::getShortcuts() Returns shortcuts ClientLocation::getTools() ClientLocation::getZoomInFactor() Returns zoom factor depending on selected rectangle ClientLocation::handleApplicationTool() ClientLocation::handleBboxRecenter() Handles recenter on bbox HTTP request ClientLocation::handleFullExtent() Handles full extent ClientLocation::handleHttpGetRequest() ClientLocation::handleHttpPostRequest() ClientLocation::handleIdRecenter() Handles recenter on Ids HTTP request ClientLocation::handleInit() ClientLocation::handleKeymapButton() Handles clicks on key map ClientLocation::handleKeymapTool() ClientLocation::handleMainmapTool() ClientLocation::handlePanButtons() Handles panning buttons ClientLocation::handleRecenterScales() Handles recenter/scales HTTP request ClientLocation::handleResult() ClientLocation::handleShortcuts() Handles shortcuts HTTP request ClientLocation::initializeResult() ClientLocation::loadSession() ClientLocation::panDirectionToFactor() Transforms PanDirection orientation to increments ClientLocation::renderForm() ClientLocation::renderFormPrepare() This method factors the plugin output for both GuiProvider::renderForm() and Ajaxable::ajaxGetPluginResponse(). ClientLocation::saveSession() #### 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 27] [ Top ] ### Class Methods ### method filterGetRequest [line 46]
`void filterGetRequest( FilterRequestModifier $request)`
#### Tags:
access: | public
see: | FilterProvider::filterGetRequest()
[ Top ] ### method filterPostRequest [line 41]
`void filterPostRequest( FilterRequestModifier $request)`
#### Tags:
access: | public
see: | FilterProvider::filterPostRequest()
[ Top ] ### method replacePlugin [line 34]
`void replacePlugin( )`
Tells that this plugin should be used instead of plugin 'location'. #### Tags:
access: | public
see: | PluginManager::replacePlugin()
Overrides PluginBase::replacePlugin() (Returns name of parent plugin in case of plugin extension) [ Top ] Documentation generated on Fri, 21 Sep 2007 13:30:43 +0200 by phpDocumentor 1.3.0RC3