Plugins

# Class: ClientOgcLayerLoader Source Location: /plugins/ogcLayerLoader/client/ClientOgcLayerLoader.php
### Class Overview
    PluginBase
       |
       --ClientPlugin
          |
          --ClientOgcLayerLoader
Client OgcLayerLoader class | ### Variables $addedOGCLayers $addedOGCLayersParams $log $removeAllWmsLayers | ### Constants DEFAULT_FORMAT DEFAULT_METHOD DEFAULT_SERVICE DEFAULT_SRS DEFAULT_TIMEOUT DEFAULT_WCS_VERSION DEFAULT_WFS_VERSION DEFAULT_WMS_VERSION SCALEFACTOR | ### Methods AddOgcLayer buildRequest computeScale createSession __construct handleHttpGetRequest handleHttpPostRequest handleHttpRequest handleResult initialize initializeResult loadSession renderForm saveSession setAddedOGCLayersParams
### 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::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 41] Client OgcLayerLoader class [ Top ] ### Class Variables #### $addedOGCLayers = [line 60] List of wms layers ever added in the map object #### Tags:
var: | of LayerOverlay
access: | protected
Type: | array
[ Top ] #### $addedOGCLayersParams = [line 54] List of WMS layers to add and parameters. #### Tags:
access: | protected
Type: | array
[ Top ] #### $log = [line 48] Logger #### Tags:
access: | private
Type: | string
Overrides: | Array
[ Top ] #### $removeAllWmsLayers = false [line 67] Remove all wms layers #### Tags:
access: | protected
todo: | Add a method to remove all WMS layers
Type: | boolean
[ Top ] ### Class Methods ### method AddOgcLayer [line 280]
`void AddOgcLayer( mixed $layerParams)`
#### Tags:
access: | protected
[ Top ] ### method buildRequest [line 378]
`void buildRequest( )`
#### Tags:
access: | public
see: | ServerCaller::buildRequest() Add ogc layer using epsg:4326 by default, without scales and SLD if provided. Send server-side list of wms layers to dynamically insert in the mapfile
[ Top ] ### method computeScale [line 267]
`void computeScale( int $scale)`
#### Tags:
access: | protected
#### Parameters:
int | $scale | scale
[ Top ] ### method createSession [line 113]
`void createSession( MapInfo $mapInfo, InitialMapState $initialMapState)`
#### Tags:
access: | public
see: | Sessionable::createSession()
[ Top ] ### constructor __construct [line 87]
`ClientOgcLayerLoader __construct( )`
Constructor #### Tags:
access: | public
Overrides ClientPlugin::__construct() (Constructor) [ Top ] ### method handleHttpGetRequest [line 255]
`void handleHttpGetRequest( array $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpGetRequest()
#### Parameters:
array | $request | HTTP request
[ Top ] ### method handleHttpPostRequest [line 247]
`void handleHttpPostRequest( array $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpPostRequest()
#### Parameters:
array | $request | HTTP request
[ Top ] ### method handleHttpRequest [line 131]
`void handleHttpRequest( array $request)`
Common processing for {@see ClientOgcLayerLoader::handleHttpPostRequest} and {@see ClientOgcLayerLoader::handleHttpGetRequest}. #### Tags:
access: | protected
#### Parameters:
array | $request | HTTP request
[ Top ] ### method handleResult [line 275]
`void handleResult( mixed $result)`
#### Tags:
access: | public
see: | ServerCaller::handleResult()
[ Top ] ### method initialize [line 103]
`void initialize( )`
#### Tags:
access: | public
see: | PluginBase::initialize()
Overrides PluginBase::initialize() (Plugin initialization (can be extended in custom plugins)) [ Top ] ### method initializeResult [line 262]
`void initializeResult( mixed $result)`
#### Tags:
access: | public
see: | ServerCaller::initializeResult()
[ Top ] ### method loadSession [line 122]
`void loadSession( mixed $sessionObject)`
#### Tags:
access: | public
see: | Sessionable::loadSession()
[ Top ] ### method renderForm [line 457]
`void renderForm( Smarty $template)`
#### Tags:
access: | public
see: | GuiProvider::renderForm()
[ Top ] ### method saveSession [line 469]
`void saveSession( )`
#### Tags:
access: | public
see: | Sessionable::saveSession()
[ Top ] ### method setAddedOGCLayersParams [line 96]
`void setAddedOGCLayersParams( mixed $newLayers, array $newLayer)`
Public fonction to add new layers in array addedOGCLayersParams #### Tags:
access: | public
#### Parameters:
array | $newLayer |
[ Top ] ### Class Constants #### DEFAULT_FORMAT = 'image/png' [line 80] [ Top ] #### DEFAULT_METHOD = 'POST' [line 77] [ Top ] #### DEFAULT_SERVICE = 'WMS' [line 81] [ Top ] #### DEFAULT_SRS = 'EPSG:4326' [line 78] [ Top ] #### DEFAULT_TIMEOUT = '30' [line 79] [ Top ] #### DEFAULT_WCS_VERSION = '1.0.0' [line 76] [ Top ] #### DEFAULT_WFS_VERSION = '1.0.0' [line 75] [ Top ] #### DEFAULT_WMS_VERSION = '1.1.1' [line 74] Constants for ClientOgcLayerLoader [ Top ] #### SCALEFACTOR = 2000 [line 82] [ Top ] Documentation generated on Fri, 21 Sep 2007 13:30:39 +0200 by phpDocumentor 1.3.0RC3