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
ClientHello
Demo plugin, shows how to output messages and use sessions.
ClientOutline
Client Outline 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
ClientProjectTable
Plugin to test tables management
ClientProjectTableRules
Plugin to test tables rules creation
ClientProjectplugin

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::replacePlugin()
Returns name of parent plugin in case of plugin extension
PluginBase::setBasePath()
PluginBase::setExtendedName()
PluginBase::setName()

Class Details

[line 394]
Client plugin



Tags:

abstract:  


[ Top ]


Class Variables

$cartoclient =

[line 404]



Tags:

access:  protected

Type:   Cartoclient


[ Top ]

$config =

[line 409]



Tags:

access:  private

Type:   ClientConfig


[ Top ]

$log =

[line 399]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]



Class Methods


constructor __construct [line 414]

ClientPlugin __construct( )

Constructor



Tags:

access:  public


Overridden in child classes as:

ClientExportCsv::__construct()
Constructor
ClientExportHtml::__construct()
Constructor
ClientExportPdf::__construct()
Constructor
ClientHello::__construct()
Constructor
ClientOutline::__construct()
Constructor
ClientImages::__construct()
Constructor
ClientLayers::__construct()
Constructor
ClientLocation::__construct()
Constructor
ClientQuery::__construct()
Constructor
ClientStatictools::__construct()
Constructor
ClientTables::__construct()
Constructor
ClientProjectTableRules::__construct()
Constructor
ClientProjectplugin::__construct()
Constructor

Overrides PluginBase::__construct() (Constructor)

[ Top ]

method checkBool [line 469]

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

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

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

Cartoclient getCartoclient( )



Tags:

access:  public


[ Top ]

method getConfig [line 434]

ClientConfig getConfig( )



[ Top ]

method getHttpValue [line 499]

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

void initializeConfig( Cartoclient $initArgs)

Initializes plugin configuration



Tags:

access:  public


Overrides PluginBase::initializeConfig() (Initializes plugin)

Parameters:

Cartoclient   $initArgs   Cartoclient

[ Top ]


Documentation generated on Wed, 6 Apr 2005 12:06:33 +0200 by phpDocumentor 1.3.0RC3