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

Class: ClientPlugin

Source Location: /client/ClientPlugin.php

Class Overview

PluginBase
   |
   --ClientPlugin

Client plugin


Author(s):

Variables

Methods


Child classes:

ExportPlugin
Export plugin
ClientAuth
Client authentification plugin based on PEAR:Auth
ClientLayerReorder
Client layereReorder class
ClientOutline
Client Outline class
ClientRouting
ClientEdit
Client Edit class
ClientViews
Handles the views creation/edition/deletion interface.
ClientMapOverlay
Client MapOverlay class
ClientImages
Client part of Images plugin
ClientLayers
Handles layers selection interface
ClientLocation
Client part of Location plugin
ClientQuery
Client part of Query plugin
ClientStatictools
A client plugin class for displaying static tools, like tools for measrurement.
ClientTables
Client part of Tables plugin
ClientFilterIdrecenter
ClientFilterSimple
Plugin to test tables management
Plugin to test tables rules creation
ClientHello
Demo plugin, shows how to output messages and use sessions.
ClientTestMainTableRules
Plugin to test tables rules creation
Plugin which shows a failure message in case the demo data is not installed

Inherited Variables

Inherited Methods

Class: PluginBase

PluginBase::__construct()
Constructor
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 313]
Client plugin



Tags:

abstract:  


[ Top ]


Class Variables

$cartoclient =

[line 323]



Tags:

access:  protected

Type:   Cartoclient


[ Top ]

$config =

[line 328]



Tags:

access:  private

Type:   ClientConfig


[ Top ]

$log =

[line 318]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]



Class Methods


constructor __construct [line 333]


method checkBool [line 388]

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

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

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 getCartoclient [line 360]

Cartoclient getCartoclient( )



Tags:

access:  public


[ Top ]

method getConfig [line 353]

ClientConfig getConfig( )



[ Top ]

method getHttpValue [line 418]

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

void initializeConfig( Cartoclient $initArgs)

Initializes plugin configuration



Tags:

access:  public


Overrides PluginBase::initializeConfig() (Initializes plugin)

Parameters:

Cartoclient   $initArgs   Cartoclient

[ Top ]


Documentation generated on Mon, 13 Feb 2006 11:43:36 +0100 by phpDocumentor 1.3.0RC3