Class: ClientPlugin

Source Location: /client/ClientPlugin.php

Class Overview

PluginBase
   |
   --ClientPlugin

Client plugin

Author(s):

Variables

Constants

Methods

Child classes:

ExportPlugin: Export plugin

ClientThrottling: Client Throttling

ClientViews: Handles the views creation/edition/deletion interface.

ClientLayerFilter

ClientGeoloc: This plugin let the user select a point on the map and recover the coordinate

ClientWmsBrowserLight: Client WmsBrowserLight class

ClientExportImg: Client part of exportImg plugin

ClientMapOverlay: Client MapOverlay class

ClientStatsReports: Client plugin

ClientBboxHistory: Client plugin

ClientEdit: Client Edit class

ClientSearch: Client search plugin

ClientAdjustMapsize

ClientGeostat: Client Geostat

ClientLocate: Locate web service

ClientAuth: Client authentication plugin based on PEAR:Auth

ClientOgcLayerLoader: Client OgcLayerLoader class

ClientOutline: Client Outline class

ClientRouting

ClientLayerReorder: Client layereReorder class

ClientAccounting: Client part of Accounting plugin

ClientToolTips: Client part of ClientToolTips plugin

ClientImages: Client part of Images plugin

ClientLocation: Client part of Location plugin

ClientLayers: Handles layers selection interface

ClientStatictools: A client plugin class for displaying static tools, like tools for measrurement.

ClientQuery: Client part of Query plugin

ClientTables: Client part of Tables plugin

: Plugin which shows a failure message in case the demo data is not installed

ClientTestMainTableRules: Plugin to test tables rules creation

ClientHello: Demo plugin, shows how to output messages and use sessions.

ClientFilterIdrecenter

ClientProjectTableRules: Plugin to test tables rules creation

ClientProjectplugin

ClientProjectTable: Plugin to test tables management

Inherited Variables

Class: PluginBase

PluginBase::$basePath
PluginBase::$name
PluginBase::$overriddenRequest

Inherited Methods

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 352]
Client plugin

Tags:

abstract:

[ Top ]

Class Variables

$cartoclient =

[line 383]

Tags:

access:

protected

Type:

Cartoclient

[ Top ]

$config =

[line 388]

Tags:

access:

private

Type:

ClientConfig

[ Top ]

$enabledLevel = ClientPlugin::ENABLE_LEVEL_FULL

[line 361]

Enable level of the plugin (used for AJAX calls).

Tags:

access:	protected
see:	Cartoclient::callEnabledPluginsImplementing()
see:	Cartoclient::callEnabledPluginImplementing()
see:	PluginEnabler

Type:

int

[ Top ]

$log =

[line 378]

Tags:

access:

private

Type:	Logger
Overrides:	Array

[ Top ]

Class Methods

constructor __construct [line 393]

ClientPlugin __construct(
)

Constructor

method checkBool [line 448]

boolean checkBool(
mixed
$value, string
$variable)

Checks if variable $variable has a boolean (0 or 1) value $value.

Tags:

access:

public

Parameters:

mixed	$value	variable value
string	$variable	variable name

[ Top ]

method checkInt [line 431]

boolean checkInt(
mixed
$value, string
$variable)

Checks if variable $variable has an integer positive or zero value $value.

Tags:

access:

public

Parameters:

mixed	$value	variable value
string	$variable	variable name

[ Top ]

method checkNumeric [line 468]

boolean checkNumeric(
mixed
$value, string
$variable)

Checks if variable $variable has a numeric value $value.

Tags:

access:

public

Parameters:

mixed	$value	variable value
string	$variable	variable name

[ Top ]

method disable [line 521]

void disable(
)

Sets the enable level to ClientPlugin::ENABLE_LEVEL_SERVERCALL.

Tags:

access:

public

[ Top ]

method enable [line 514]

void enable(
)

Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL.

Tags:

access:

public

[ Top ]

method getCartoclient [line 420]

Cartoclient getCartoclient(
)

Tags:

access:

public

[ Top ]

method getConfig [line 413]

ClientConfig getConfig(
)

Tags:

access:

public

[ Top ]

method getEnabledLevel [line 507]

int getEnabledLevel(
)

Returns the enable level.

Tags:

return:	the current enable level.
access:	public

[ Top ]

method getFolderId [line 538]

string getFolderId(
)

get folder id if set in plugin config

Tags:

access:

protected

[ Top ]

method getHttpValue [line 482]

string getHttpValue(
array
$request, string
$key)

Returns the user-submitted $key data if it is set.

Tags:

access:

public

Parameters:

array	$request
string	$key

[ Top ]

method initializeConfig [line 403]

void initializeConfig(
Cartoclient
$initArgs)

Initializes plugin configuration

Tags:

access:

public

Overrides PluginBase::initializeConfig() (Initializes plugin)

Parameters:

Cartoclient

$initArgs

Cartoclient

[ Top ]

method isEnabledAtLevel [line 530]

bool isEnabledAtLevel(
mixed
$enableLevel)

Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL.

Tags:

return:	true if the current enable level is equal or greater than the given enable level, false otherwise.
access:	public

[ Top ]

method setEnableLevel [line 494]

void setEnableLevel(
int
$enableLevel)

Sets the enable level (to be used with the AJAX mode).

Tags:

access:

public

Parameters:

int

$enableLevel

[ Top ]

Class Constants

ENABLE_LEVEL_FULL = 3

[line 373]

[ Top ]

ENABLE_LEVEL_LOAD = 0

[line 370]

[ Top ]

ENABLE_LEVEL_PROCESS = 1

[line 371]

[ Top ]

ENABLE_LEVEL_SERVERCALL = 2

[line 372]

[ Top ]

Documentation generated on Wed, 08 Feb 2012 13:30:46 +0100 by phpDocumentor 1.3.0RC3