Class: ClientToolTips

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

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientToolTips

Client part of ClientToolTips plugin

Variables

Methods

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

[ Top ]

Class Variables

$imagemap = ''

[line 56]

html code containing map and area tags

Tags:

access:

protected

Type:

string

[ Top ]

$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 ]

Class Methods

constructor __construct [line 61]

ClientToolTips __construct(
)

Constructor

Tags:

access:

public

Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method ajaxGetPluginResponse [line 219]

void ajaxGetPluginResponse(
AjaxPluginResponse
$ajaxPluginResponse)

Tags:

access:	public
see:	Ajaxable::ajaxGetPluginResponse()

[ Top ]

method ajaxHandleAction [line 229]

void ajaxHandleAction(
mixed
$actionName, PluginEnabler
$pluginEnabler)

Tags:

access:	public
see:	Ajaxable::ajaxHandleAction()

[ Top ]

method buildRequest [line 192]

void buildRequest(
)

Tags:

access:	public
see:	ServerCaller::buildRequest()

[ Top ]

method drawCustomForm [line 138]

string drawCustomForm(
)

Handles a toolTipsService, run it and build toolTips HTML

code (timeout_async or area_async) Used when flow is interrupted

Tags:

access:

private

[ Top ]

method drawImagemap [line 120]

string drawImagemap(
)

Renders imagemap HTML code (map and area tags)

Used in standard flow (i.e. no interrupt flow)

Tags:

access:

protected

[ Top ]

method drawImagemapJavascriptCode [line 107]

string drawImagemapJavascriptCode(
)

Renders imagemap javascript code

Tags:

access:

protected

[ Top ]

method getImagemapLayers [line 161]

array getImagemapLayers(
)

Gets the list of imagemapable layers (area_async, area_direct)

TODO get it from saved session

Tags:

access:

protected

[ Top ]

method handleHttpCommonRequest [line 69]

void handleHttpCommonRequest(
mixed
$request)

Handles Get and Post requests

Tags:

access:

protected

[ Top ]

method handleHttpGetRequest [line 89]

void handleHttpGetRequest(
mixed
$request)

Tags:

access:	public
see:	GuiProvider::handleHttpGetRequest()

[ Top ]

method handleHttpPostRequest [line 82]

void handleHttpPostRequest(
mixed
$request)

Tags:

access:	public
see:	GuiProvider::handleHttpPostRequest()

[ Top ]

method handleResult [line 208]

void handleResult(
mixed
$toolTipsResult)

Tags:

access:	public
see:	ServerCaller::handleResult()

[ Top ]

method initializeResult [line 203]

void initializeResult(
mixed
$toolTipsResult)

Tags:

access:	public
see:	ServerCaller::initializeResult()

[ Top ]

method renderForm [line 96]

void renderForm(
Smarty
$template)

Tags:

access:	public
see:	GuiProvider::renderForm()

[ Top ]

Documentation generated on Wed, 30 Aug 2006 21:57:07 +0200 by phpDocumentor 1.3.0RC3