Plugins

# Class: ClientWmsBrowserLight Source Location: /plugins/wmsBrowserLight/client/ClientWmsBrowserLight.php
### Class Overview
    PluginBase
       |
       --ClientPlugin
          |
          --ClientWmsBrowserLight
Client WmsBrowserLight class | ### Variables $catalogtype $log $project $servers $userServer $wmsBrowserLightState | ### Constants GnWmsProtocol | ### Methods __construct createSession handleHttpGetRequest handleHttpPostRequest handleHttpRequest initialize loadSession owsInfoHarwester queryGeonetwork renderForm saveSession
### 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 49] Client WmsBrowserLight class [ Top ] ### Class Variables #### $catalogtype = [line 83] catalogtype in order if the catalogue is from the config file (ini) or from GeoNetwork (gn). #### Tags:
access: | private
Type: | string
[ Top ] #### $log = [line 65] Logger #### Tags:
access: | private
Type: | string
Overrides: | Array
[ Top ] #### $project = [line 89] Current project #### Tags:
access: | protected
Type: | string
[ Top ] #### $servers = [line 71] Servers #### Tags:
access: | private
Type: | array
[ Top ] #### $userServer = [line 77] User server #### Tags:
access: | public
Type: | string
[ Top ] #### $wmsBrowserLightState = [line 59] Session object used to store list of servers. The list of servers is coming from the ini file or from the GeoNetwork node defined in the configuration file. #### Tags:
access: | protected
Type: | object
[ Top ] ### Class Methods ### constructor __construct [line 104]
`ClientWmsBrowserLight __construct( )`
Constructor #### Tags:
access: | public
Overrides ClientPlugin::__construct() (Constructor) [ Top ] ### method createSession [line 127]
`void createSession( MapInfo $mapInfo, InitialMapState $initialMapState)`
Session in wmsBrowserLight is used to store the list of servers comming from the ini file or the GeoNetwork node used. #### Tags:
access: | public
see: | Sessionable::createSession()
[ Top ] ### method handleHttpGetRequest [line 301]
`void handleHttpGetRequest( array $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpGetRequest()
#### Parameters:
array | $request | HTTP request
[ Top ] ### method handleHttpPostRequest [line 293]
`void handleHttpPostRequest( array $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpPostRequest()
#### Parameters:
array | $request | HTTP request
[ Top ] ### method handleHttpRequest [line 212]
`void handleHttpRequest( array $request)`
Common processing for {@see ClientWmsBrowserLight::handleHttpPostRequest} and {@see ClientWmsBrowserLight::handleHttpGetRequest} #### Tags:
access: | protected
#### Parameters:
array | $request | HTTP request
[ Top ] ### method initialize [line 114]
`void initialize( )`
You need the ogcLayerLoader in order to add the layer to your project. #### Tags:
access: | public
see: | PluginBase::initialize()
Overrides PluginBase::initialize() (Plugin initialization (can be extended in custom plugins)) [ Top ] ### method loadSession [line 136]
`void loadSession( mixed $sessionObject)`
#### Tags:
access: | public
see: | Sessionable::loadSession()
[ Top ] ### method owsInfoHarwester [line 283]
`void owsInfoHarwester( array $url)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpPostRequest()
#### Parameters:
array | $url | HTTP request
[ Top ] ### method queryGeonetwork [line 158]
`void queryGeonetwork( string $queryType, [string $item = null])`
Query GeoNetwork node to search for metadata about services. Login to the node if required. #### Tags:
access: | private
#### Parameters:
string | $queryType | queryType to specify you search for a list of services according to the query or get one metadata record
string | $item | item is the identifier of the metadata record to search for
[ Top ] ### method renderForm [line 309]
`void renderForm( Smarty $template)`
#### Tags:
access: | public
see: | GuiProvider::renderForm()
[ Top ] ### method saveSession [line 144]
`void saveSession( )`
#### Tags:
access: | public
see: | Sessionable::saveSession()
[ Top ] ### Class Constants #### GnWmsProtocol = 'OGC:WMS-1.1.1-http-get-map' [line 98] Value of the protocol to search for in a GeoNetwork node. Usually the value is OGC:WMS-1.1.1-http-get-map in GeoNetwork 2.0.2. It is used to search for WMS layers. [ Top ] Documentation generated on Fri, 21 Sep 2007 13:30:44 +0200 by phpDocumentor 1.3.0RC3