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

Class: ClientToolTips

Source Location: /plugins/toolTips/client/ClientToolTips.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientToolTips

Client part of ClientToolTips plugin


Variables

Methods


Child classes:

ClientProjectToolTips
Client part of ClientToolTips plugin

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 38]
Client part of ClientToolTips plugin



[ Top ]


Class Variables

$log =

[line 44]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]

$sessionCreated =  false

[line 50]

True when self::createSession() has been called



Tags:

access:  protected

Type:   bool


[ Top ]

$toolTipsTimeoutBeforeHide =

[line 55]



Tags:

access:  protected

Type:   int


[ Top ]



Class Methods


constructor __construct [line 60]

ClientToolTips __construct( )

Constructor



Tags:

access:  public


Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method ajaxGetPluginResponse [line 149]

void ajaxGetPluginResponse( AjaxPluginResponse $ajaxPluginResponse)



Tags:

access:  public
see:  Ajaxable::ajaxGetPluginResponse()


[ Top ]

method ajaxHandleAction [line 156]

void ajaxHandleAction( mixed $actionName, PluginEnabler $pluginEnabler)



Tags:

access:  public
see:  Ajaxable::ajaxHandleAction()


[ Top ]

method drawCustomForm [line 106]

string drawCustomForm( )

Handles a toolTipsService, run it and build toolTips HTML

code (timeout_async or area_async) Used when flow is interrupted




Tags:

access:  protected


[ Top ]

method errorHandler [line 170]

void errorHandler( mixed $errno, mixed $errstr, mixed $errfile, mixed $errline)

Error handler for tooltips plugin



Tags:

static:  
access:  public


[ Top ]

method getToolTipsTimeoutBeforeHide [line 186]

int getToolTipsTimeoutBeforeHide( )

get timeout value (before tooltips result disappear)



Tags:

return:  toolTipsTimeoutBeforeHide
access:  protected


[ Top ]

method handleHttpCommonRequest [line 68]

void handleHttpCommonRequest( mixed $request)

Handles Get and Post requests



Tags:

access:  protected


[ Top ]

method handleHttpGetRequest [line 88]

void handleHttpGetRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpGetRequest()


[ Top ]

method handleHttpPostRequest [line 81]

void handleHttpPostRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpPostRequest()


[ Top ]

method isToolTipsActive [line 140]

boolean isToolTipsActive( )

Tells if tooltips can be activate

for example don't send ajax request if no tooltipsable layer is visible




Tags:

access:  protected


[ Top ]

method renderForm [line 95]

void renderForm( Smarty $template)



Tags:

access:  public
see:  GuiProvider::renderForm()


[ Top ]


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