Class: ClientLayerFilter

Source Location: /plugins/layerFilter/client/ClientLayerFilter.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientLayerFilter

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::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 26]

[ Top ]

Class Variables

$criteria =

[line 47]

Tags:

access:

protected

Type:

array

[ Top ]

$formObjects =

[line 42]

Tags:

access:

protected

Type:

stdClass

[ Top ]

$i18n = false

[line 37]

Tags:

access:

protected

Type:

boolean

[ Top ]

$log =

[line 32]

Tags:

access:

private

Type:	Logger
Overrides:	Array

[ Top ]

$reset = false

[line 52]

Tags:

access:

protected

Type:

boolean

[ Top ]

Class Methods

constructor __construct [line 57]

ClientLayerFilter __construct(
)

Constructor

Tags:

access:

public

Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method ajaxGetPluginResponse [line 247]

void ajaxGetPluginResponse(
AjaxPluginResponse
$ajaxPluginResponse)

Tags:

access:	public
see:	Ajaxable::ajaxGetPluginResponse()

[ Top ]

method ajaxHandleAction [line 256]

void ajaxHandleAction(
mixed
$actionName, PluginEnabler
$pluginEnabler)

Tags:

access:	public
see:	Ajaxable::ajaxHandleAction()

[ Top ]

method buildRequest [line 221]

void buildRequest(
)

Tags:

access:	public
see:	ServerCaller::buildRequest()

[ Top ]

method drawFilterForm [line 193]

string drawFilterForm(
)

Draws filter form.

Tags:

access:

protected

[ Top ]

method getFormObjects [line 205]

stdClass getFormObjects(
)

Gets criteria config.

Tags:

access:

protected

[ Top ]

method handleHttpGetRequest [line 179]

void handleHttpGetRequest(
array
$request)

Tags:

access:	public
see:	GuiProvider::handleHttpGetRequest()

Parameters:

array

$request

HTTP request

[ Top ]

method handleHttpPostRequest [line 67]

void handleHttpPostRequest(
array
$request)

Tags:

access:	public
see:	GuiProvider::handleHttpPostRequest()

Parameters:

array

$request

HTTP request

[ Top ]

method handleResult [line 242]

void handleResult(
mixed
$result)

Tags:

access:	public
see:	ServerCaller::handleResult()

[ Top ]

method initializeResult [line 237]

void initializeResult(
mixed
$result)

Tags:

access:	public
see:	ServerCaller::initializeResult()

[ Top ]

method renderForm [line 185]

void renderForm(
Smarty
$template)

Tags:

access:	public
see:	GuiProvider::renderForm()

Parameters:

Smarty

$template

[ Top ]

method retrieveCriteria [line 132]

void retrieveCriteria(
)

Makes sure filter criteria are set.

Tags:

access:

protected

[ Top ]

Documentation generated on Thu, 09 Feb 2012 13:30:43 +0100 by phpDocumentor 1.3.0RC3