Plugins
[ class tree: Plugins ] [ index: Plugins ] [ all elements ]

Class: ClientBboxHistory

Source Location: /plugins/bboxHistory/client/ClientBboxHistory.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientBboxHistory

Client plugin


Variables

Methods


Inherited Constants

Inherited Variables

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::getFolderId()
get folder id if set in plugin config
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 41]
Client plugin



[ Top ]


Class Variables

$log =

[line 49]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]

$state =

[line 54]



Tags:

access:  private



[ Top ]



Class Methods


constructor __construct [line 59]

ClientBboxHistory __construct( )

Constructor



Tags:

access:  public


Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method ajaxGetPluginResponse [line 159]

void ajaxGetPluginResponse( AjaxPluginResponse $ajaxPluginResponse)



Tags:

access:  public
see:  Ajaxable::ajaxGetPluginResponse()


[ Top ]

method ajaxHandleAction [line 166]

void ajaxHandleAction( mixed $actionName, PluginEnabler $pluginEnabler)



Tags:

access:  public
see:  Ajaxable::ajaxHandleAction()


[ Top ]

method buildRequest [line 173]

void buildRequest( )



Tags:

access:  public
see:  ServerCaller::buildRequest()


[ Top ]

method createSession [line 68]

void createSession( MapInfo $mapInfo, InitialMapState $initialMapState)



Tags:

access:  public
see:  Sessionable::createSession()


[ Top ]

method drawForm [line 109]

void drawForm( )



Tags:

access:  protected


[ Top ]

method filterGetRequest [line 152]

void filterGetRequest( FilterRequestModifier $request)



Tags:

access:  public
see:  FilterProvider::filterGetRequest()


[ Top ]

method filterPostRequest [line 124]

void filterPostRequest( FilterRequestModifier $request)



Tags:

access:  public
see:  FilterProvider::filterPostRequest()


[ Top ]

method handleHttpGetRequest [line 99]

void handleHttpGetRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpGetRequest()


[ Top ]

method handleHttpPostRequest [line 93]

void handleHttpPostRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpPostRequest()


[ Top ]

method handleResult [line 200]

void handleResult( mixed $result)



Tags:

access:  public
see:  ServerCaller::handleResult()


[ Top ]

method initializeResult [line 180]

void initializeResult( mixed $result)



Tags:

access:  public
see:  ServerCaller::initializeResult()


[ Top ]

method loadSession [line 77]

void loadSession( mixed $sessionObject)



Tags:

access:  public
see:  Sessionable::loadSession()


[ Top ]

method renderForm [line 105]

void renderForm( Smarty $template)



Tags:

access:  public
see:  GuiProvider::renderForm()


[ Top ]

method saveSession [line 85]

void saveSession( )



Tags:

access:  public
see:  Sessionable::saveSession()


[ Top ]


Documentation generated on Thu, 04 Sep 2008 11:39:11 +0200 by phpDocumentor 1.3.0RC3