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

Class: ClientPlugin

Source Location: /client/ClientPlugin.php

Class Overview

PluginBase
   |
   --ClientPlugin

Client plugin


Author(s):

Variables

Constants

Methods


Child classes:

ExportPlugin
Export plugin
ClientLayerReorder
Client layereReorder class
ClientStatsReports
Client plugin
ClientOgcLayerLoader
Client OgcLayerLoader class
ClientLayerFilter
ClientViews
Handles the views creation/edition/deletion interface.
ClientOutline
Client Outline class
ClientSearch
Client search plugin
ClientMapOverlay
Client MapOverlay class
ClientBboxHistory
Client plugin
ClientAdjustMapsize
ClientWmsBrowserLight
Client WmsBrowserLight class
ClientExportImg
Client part of exportImg plugin
ClientAuth
Client authentication plugin based on PEAR:Auth
ClientThrottling
Client Throttling
ClientEdit
Client Edit class
ClientLocate
Locate web service
ClientToolTips
Client part of ClientToolTips plugin
ClientRouting
ClientAccounting
Client part of Accounting plugin
ClientGeostat
Client Geostat
ClientTables
Client part of Tables 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.
ClientImages
Client part of Images 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
ClientProjectTable
Plugin to test tables management
ClientProjectplugin
ClientProjectTableRules
Plugin to test tables rules creation

Inherited Variables

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:


Type:   int


[ Top ]

$log =

[line 378]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]



Class Methods


constructor __construct [line 393]

ClientPlugin __construct( )

Constructor



Tags:

access:  public


Overridden in child classes as:

ClientExportRtf::__construct()
Constructor
ClientExportCsv::__construct()
Constructor
ClientExportPdf::__construct()
Constructor
ClientExportHtml::__construct()
Constructor
ClientExportDxf::__construct()
Constructor
ClientExportLinkIt::__construct()
Constructor
ClientLayerReorder::__construct()
Constructor
ClientOgcLayerLoader::__construct()
Constructor
ClientLayerFilter::__construct()
Constructor
ClientViews::__construct()
Constructor
ClientOutline::__construct()
Constructor
ClientBboxHistory::__construct()
Constructor
ClientWmsBrowserLight::__construct()
Constructor
ClientExportImg::__construct()
Constructor
ClientThrottling::__construct()
ClientEdit::__construct()
Constructor
ClientLocate::__construct()
Constructor
ClientToolTips::__construct()
Constructor
ClientRouting::__construct()
Constructor
ClientDemoRouting::__construct()
Constructor
ClientAccounting::__construct()
Constructor
ClientGeostat::__construct()
ClientTables::__construct()
Constructor
ClientLayers::__construct()
Constructor
ClientLocation::__construct()
Constructor
ClientQuery::__construct()
Constructor
ClientStatictools::__construct()
Constructor
ClientImages::__construct()
Constructor
ClientTestMainTableRules::__construct()
Constructor
ClientHello::__construct()
Constructor
ClientProjectplugin::__construct()
Constructor
ClientProjectTableRules::__construct()
Constructor

Overrides PluginBase::__construct() (Constructor)

[ Top ]

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


Overridden in child classes as:

ClientThrottling::initializeConfig()

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 Thu, 04 Sep 2008 11:39:20 +0200 by phpDocumentor 1.3.0RC3