Plugins

# Class: ClientViews Source Location: /plugins/views/client/ClientViews.php
### Class Overview
    PluginBase
       |
       --ClientPlugin
          |
          --ClientViews
Handles the views creation/edition/deletion interface. | ### Variables $action $log $metasList $viewActive $viewManager $viewsList $viewsState | ### Methods __construct createSession drawUserForm getMetasList getViewManager getViewsList handleHttpGetRequest handleHttpPostRequest handleHttpRequest loadSession renderForm resetSession saveSession setFromForm
### 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 45] Handles the views creation/edition/deletion interface. [ Top ] ### Class Variables #### $action = [line 71] #### Tags:
access: | protected
Type: | string
[ Top ] #### $log = [line 51] #### Tags:
access: | private
Type: | Logger
Overrides: | Array
[ Top ] #### $metasList = [line 61] #### Tags:
access: | public
Type: | array
[ Top ] #### $viewActive = false [line 66] #### Tags:
access: | protected
Type: | boolean
[ Top ] #### $viewManager = [line 76] #### Tags:
access: | protected
Type: | ViewManager
[ Top ] #### $viewsList = [line 81] #### Tags:
access: | protected
Type: | array
[ Top ] #### $viewsState = [line 56] #### Tags:
access: | protected
Type: | ViewsState
[ Top ] ### Class Methods ### constructor __construct [line 86]
`ClientViews __construct( )`
Constructor #### Tags:
access: | public
Overrides ClientPlugin::__construct() (Constructor) [ Top ] ### method createSession [line 123]
`void createSession( MapInfo $mapInfo, InitialMapState $initialMapState)`
#### Tags:
access: | public
see: | Sessionable::createSession()
[ Top ] ### method drawUserForm [line 282]
`string drawUserForm( )`
Builds views edition interface #### Tags:
return: | Smarty fetch result
access: | protected
[ Top ] ### method getMetasList [line 106]
`array getMetasList( )`
Returns ClientViews::metasList, list of metadata fields. #### Tags:
access: | protected
[ Top ] ### method getViewManager [line 95]
`ViewManager getViewManager( )`
#### Tags:
access: | protected
[ Top ] ### method getViewsList [line 240]
`array getViewsList( [boolean $showAll = false])`
Populates and returns views list. #### Tags:
access: | protected
#### Parameters:
boolean | $showAll | if true all view are listed else only the "visible" ones
[ Top ] ### method handleHttpGetRequest [line 231]
`void handleHttpGetRequest( array $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpGetRequest()
#### Parameters:
array | $request | HTTP request
[ Top ] ### method handleHttpPostRequest [line 223]
`void handleHttpPostRequest( array $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpPostRequest()
#### Parameters:
array | $request | HTTP request
[ Top ] ### method handleHttpRequest [line 158]
`void handleHttpRequest( array $request)`
Common processing for {@see ClientViews::handleHttpPostRequest} and {@see ClientViews::handleHttpGetRequest}. #### Tags:
access: | protected
#### Parameters:
array | $request | HTTP request
[ Top ] ### method loadSession [line 116]
`void loadSession( mixed $sessionObject)`
#### Tags:
access: | public
see: | Sessionable::loadSession()
[ Top ] ### method renderForm [line 268]
`void renderForm( Smarty $template)`
#### Tags:
access: | public
see: | GuiProvider::renderForm()
#### Parameters:
Smarty | $template |
[ Top ] ### method resetSession [line 138]
`void resetSession( )`
Empties session values #### Tags:
access: | protected
[ Top ] ### method saveSession [line 131]
`void saveSession( )`
#### Tags:
access: | public
see: | Sessionable::saveSession()
[ Top ] ### method setFromForm [line 146]
`void setFromForm( array $request)`
Sets metadata using GET/POST values. #### Tags:
access: | protected
#### Parameters:
array | $request | HTTP request
[ Top ] Documentation generated on Fri, 21 Sep 2007 13:30:43 +0200 by phpDocumentor 1.3.0RC3