Plugins

# Class: ClientGeostat Source Location: /plugins/geostat/client/ClientGeostat.php
### Class Overview
    PluginBase
       |
       --ClientPlugin
          |
          --ClientGeostat
Client Geostat | ### Variables $geostatClientState $geostatInit $log | ### Methods __construct ajaxGetPluginResponse ajaxHandleAction buildRequest createSession formatBoundsArray handleHttpGetRequest handleHttpPostRequest handleHttpRequest handleInit handleResult initializeResult loadSession renderChoroplethDataset renderChoroplethRepresentation renderDataSource renderForm renderFormPrepare renderSwitch saveSession translateArrayElem
### 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 72] Client Geostat [ Top ] ### Class Variables #### $geostatClientState = [line 89] #### Tags:
access: | protected
Type: | GeostatClientState
[ Top ] #### $geostatInit = [line 84] #### Tags:
access: | protected
Type: | GeostatInit
[ Top ] #### $log = [line 79] #### Tags:
access: | private
Type: | Logger
Overrides: | Array
[ Top ] ### Class Methods ### constructor __construct [line 94]
`ClientGeostat __construct( )`
#### Tags:
access: | public
see: | ClientPlugin::__construct()
Overrides ClientPlugin::__construct() (Constructor) [ Top ] ### method ajaxGetPluginResponse [line 259]
`void ajaxGetPluginResponse( AjaxPluginResponse $ajaxPluginResponse)`
#### Tags:
access: | public
see: | Ajaxable::ajaxGetPluginResponse()
[ Top ] ### method ajaxHandleAction [line 311]
`void ajaxHandleAction( mixed $actionName, PluginEnabler $pluginEnabler)`
#### Tags:
access: | public
see: | Ajaxable::ajaxHandleAction()
[ Top ] ### method buildRequest [line 266]
`void buildRequest( )`
#### Tags:
access: | public
see: | ServerCaller::buildRequest()
[ Top ] ### method createSession [line 111]
`void createSession( MapInfo $mapInfo, InitialMapState $initialMapState)`
#### Tags:
access: | public
see: | Sessionable::createSession()
[ Top ] ### method formatBoundsArray [line 539]
`void formatBoundsArray( mixed $boundsArray)`
#### Tags:
access: | protected
[ Top ] ### method handleHttpGetRequest [line 184]
`void handleHttpGetRequest( array $request)`
Handles data coming from a get request #### Tags:
access: | public
#### Parameters:
array | $request | HTTP request
[ Top ] ### method handleHttpPostRequest [line 176]
`void handleHttpPostRequest( array $request)`
Handles data coming from a post request #### Tags:
access: | public
#### Parameters:
array | $request | HTTP request
[ Top ] ### method handleHttpRequest [line 192]
`void handleHttpRequest( mixed $requ)`
#### Tags:
access: | protected
see: | ClientGeostat::handleHttpGetRequest()
see: | ClientGeostat::handleHttpPostRequest()
[ Top ] ### method handleInit [line 102]
`void handleInit( mixed $geostatInit)`
#### Tags:
access: | public
see: | InitUser::handleInit()
[ Top ] ### method handleResult [line 306]
`void handleResult( mixed $geostatResult)`
#### Tags:
access: | public
see: | ServerCaller::handleResult()
[ Top ] ### method initializeResult [line 285]
`void initializeResult( mixed $geostatResult)`
#### Tags:
access: | public
see: | ServerCaller::initializeResult()
[ Top ] ### method loadSession [line 161]
`void loadSession( mixed $sessionObject)`
#### Tags:
access: | public
see: | Sessionable::loadSession()
[ Top ] ### method renderChoroplethDataset [line 434]
`string renderChoroplethDataset( )`
This function return form about choropleth dataset #### Tags:
access: | protected
[ Top ] ### method renderChoroplethRepresentation [line 489]
`string renderChoroplethRepresentation( )`
This function return form about choropleth representation #### Tags:
access: | protected
[ Top ] ### method renderDataSource [line 376]
`string renderDataSource( )`
This function return form about datasource #### Tags:
access: | protected
[ Top ] ### method renderForm [line 356]
`void renderForm( Smarty $template)`
#### Tags:
access: | public
see: | GuiProvider::renderForm()
[ Top ] ### method renderFormPrepare [line 338]
`string renderFormPrepare( )`
This function builds geostat template #### Tags:
access: | public
[ Top ] ### method renderSwitch [line 364]
`string renderSwitch( )`
This function return form about Geostat status #### Tags:
access: | protected
[ Top ] ### method saveSession [line 168]
`void saveSession( )`
#### Tags:
access: | public
see: | Sessionable::saveSession()
[ Top ] ### method translateArrayElem [line 535]
`void translateArrayElem( mixed &$item)`
Use this function with array_walk to translate array #### Tags:
access: | protected
[ Top ] Documentation generated on Fri, 21 Sep 2007 13:30:37 +0200 by phpDocumentor 1.3.0RC3