Client

# Class: ClientPlugin Source Location: /client/ClientPlugin.php
### Class Overview
    PluginBase
       |
       --ClientPlugin
Client plugin #### Author(s): | ### Variables $cartoclient $config $enabledLevel $log | ### Constants ENABLE_LEVEL_FULL ENABLE_LEVEL_LOAD ENABLE_LEVEL_PROCESS ENABLE_LEVEL_SERVERCALL | ### Methods __construct checkBool checkInt checkNumeric disable enable getCartoclient getConfig getEnabledLevel getHttpValue initializeConfig isEnabledAtLevel setEnableLevel
### Child classes: ExportPlugin Export plugin ClientViews Handles the views creation/edition/deletion interface. ClientBboxHistory Client plugin ClientOutline Client Outline class ClientGeostat Client Geostat ClientSearch Client search plugin ClientLocate Locate web service ClientExportImg Client part of exportImg plugin ClientAccounting Client part of Accounting plugin ClientOgcLayerLoader Client OgcLayerLoader class ClientAuth Client authentication plugin based on PEAR:Auth ClientEdit Client Edit class ClientMapOverlay Client MapOverlay class ClientWmsBrowserLight Client WmsBrowserLight class ClientLayerReorder Client layereReorder class ClientAdjustMapsize ClientRouting ClientToolTips Client part of ClientToolTips plugin ClientQuery Client part of Query plugin ClientLayers Handles layers selection interface ClientStatictools A client plugin class for displaying static tools, like tools for measrurement. ClientLocation Client part of Location plugin ClientTables Client part of Tables plugin ClientImages Client part of Images plugin Plugin to test tables rules creation Plugin to test tables management Plugin which shows a failure message in case the demo data is not installed ClientHello Demo plugin, shows how to output messages and use sessions. ClientTestMainTableRules Plugin to test tables rules creation ClientFilterIdrecenter ClientFilterSimple | ### Inherited Variables #### Class: PluginBase PluginBase::$basePath PluginBase::$name PluginBase::$overriddenRequest | ### Inherited Methods #### 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 332] Client plugin #### Tags:
abstract: |
[ Top ] ### Class Variables #### $cartoclient = [line 363] #### Tags:
access: | protected
Type: | Cartoclient
[ Top ] #### $config = [line 368] #### Tags:
access: | private
Type: | ClientConfig
[ Top ] #### $enabledLevel = ClientPlugin::ENABLE_LEVEL_FULL [line 341] Enable level of the plugin (used for AJAX calls). #### Tags:
access: | protected
see: | Cartoclient::callEnabledPluginsImplementing()
see: | Cartoclient::callEnabledPluginImplementing()
see: | PluginEnabler
Type: | int
[ Top ] #### $log = [line 358] #### Tags:
access: | private
Type: | Logger
Overrides: | Array
[ Top ] ### Class Methods ### constructor __construct [line 373]
`ClientPlugin __construct( )`
Constructor #### Tags:
access: | public
Overridden in child classes as: ClientExportHtml::__construct() Constructor ClientExportCsv::__construct() Constructor ClientExportDxf::__construct() Constructor ClientExportPdf::__construct() Constructor ClientExportRtf::__construct() Constructor ClientViews::__construct() Constructor ClientBboxHistory::__construct() Constructor ClientOutline::__construct() Constructor ClientGeostat::__construct() ClientLocate::__construct() Constructor ClientExportImg::__construct() Constructor ClientAccounting::__construct() Constructor ClientOgcLayerLoader::__construct() Constructor ClientEdit::__construct() Constructor ClientWmsBrowserLight::__construct() Constructor ClientLayerReorder::__construct() Constructor ClientRouting::__construct() Constructor ClientDemoRouting::__construct() Constructor ClientToolTips::__construct() Constructor ClientQuery::__construct() Constructor ClientLayers::__construct() Constructor ClientStatictools::__construct() Constructor ClientLocation::__construct() Constructor ClientTables::__construct() Constructor ClientImages::__construct() Constructor ClientProjectplugin::__construct() Constructor ClientProjectTableRules::__construct() Constructor ClientHello::__construct() Constructor ClientTestMainTableRules::__construct() Constructor Overrides PluginBase::__construct() (Constructor) [ Top ] ### method checkBool [line 428]
`boolean checkBool( mixed $value, string $variable)`
Checks if variable $variable has a boolean (0 or 1) value $value. #### Tags:
access: | public
#### Parameters:
mixed | $value | variable value
string | $variable | variable name
[ Top ] ### method checkInt [line 411]
`boolean checkInt( mixed $value, string $variable)`
Checks if variable $variable has an integer positive or zero value $value. #### Tags:
access: | public
#### Parameters:
mixed | $value | variable value
string | $variable | variable name
[ Top ] ### method checkNumeric [line 448]
`boolean checkNumeric( mixed $value, string $variable)`
Checks if variable $variable has a numeric value $value. #### Tags:
access: | public
#### Parameters:
mixed | $value | variable value
string | $variable | variable name
[ Top ] ### method disable [line 501]
`void disable( )`
Sets the enable level to ClientPlugin::ENABLE_LEVEL_SERVERCALL. #### Tags:
access: | public
[ Top ] ### method enable [line 494]
`void enable( )`
Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL. #### Tags:
access: | public
[ Top ] ### method getCartoclient [line 400]
`Cartoclient getCartoclient( )`
#### Tags:
access: | public
[ Top ] ### method getConfig [line 393]
`ClientConfig getConfig( )`
#### Tags:
access: | public
[ Top ] ### method getEnabledLevel [line 487]
`int getEnabledLevel( )`
Returns the enable level. #### Tags:
return: | the current enable level.
access: | public
[ Top ] ### method getHttpValue [line 462]
`string getHttpValue( array $request, string $key)`
Returns the user-submitted $key data if it is set. #### Tags:
access: | public
#### Parameters:
array | $request |
string | $key |
[ Top ] ### method initializeConfig [line 383]
`void initializeConfig( Cartoclient $initArgs)`
Initializes plugin configuration #### Tags:
access: | public
Overrides PluginBase::initializeConfig() (Initializes plugin) #### Parameters:
Cartoclient | $initArgs | Cartoclient
[ Top ] ### method isEnabledAtLevel [line 510]
`bool isEnabledAtLevel( mixed $enableLevel)`
Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL. #### Tags:
return: | true if the current enable level is equal or greater than the given enable level, false otherwise.
access: | public
[ Top ] ### method setEnableLevel [line 474]
`void setEnableLevel( int $enableLevel)`
Sets the enable level (to be used with the AJAX mode). #### Tags:
access: | public
#### Parameters:
int | $enableLevel |
[ Top ] ### Class Constants #### ENABLE_LEVEL_FULL = 3 [line 353] [ Top ] #### ENABLE_LEVEL_LOAD = 0 [line 350] [ Top ] #### ENABLE_LEVEL_PROCESS = 1 [line 351] [ Top ] #### ENABLE_LEVEL_SERVERCALL = 2 [line 352] [ Top ] Documentation generated on Fri, 21 Sep 2007 13:30:40 +0200 by phpDocumentor 1.3.0RC3