Plugins

# Class: ClientWmsBrowser Source Location: /plugins/wmsBrowser/client/ClientWmsBrowser.php
### Class Overview
    PluginBase
       |
       --ClientPlugin
          |
          --ClientWmsBrowser
Client wmsBrowser class | ### Variables $activeServerUrl $addedWmsLayers $listLayers $log $newServerUrl $noFirstLoad $openNodes $project $removeAllWmsLayers $selectedServerUrl $userCommand $userComment $userLog $userLogStatus $wmsBrowserInit $wmsBrowserState $wmsLayerToAdd $wmsServerManager | ### Methods __construct add buildRequest buildServerLayersTree connect controlUrl createSession disconnect drawExploreWmsLayers drawExploreWmsLayersIframe drawManageServersPopup handleHttpGetRequest handleHttpPostRequest handleHttpRequest handleInit handleResult initialize initializeResult loadSession refresh remove renderForm saveSession test update
### 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 62] Client wmsBrowser class [ Top ] ### Class Variables #### $activeServerUrl = [line 98] Url of active wms server #### Tags:
access: | protected
Type: | string
[ Top ] #### $addedWmsLayers = [line 104] List of wms layers ever added in the map object #### Tags:
var: | of LayerOverlay
access: | protected
Type: | array
[ Top ] #### $listLayers = false [line 123] Control listing of layers from 'active' server #### Tags:
access: | protected
Type: | boolean
[ Top ] #### $log = [line 69] Logger #### Tags:
access: | private
Type: | string
Overrides: | Array
[ Top ] #### $newServerUrl = [line 154] New server url #### Tags:
access: | protected
Type: | string
[ Top ] #### $noFirstLoad = false [line 174] Popup first load #### Tags:
access: | protected
Type: | boolean
[ Top ] #### $openNodes = array() [line 129] Open nodes in wms layers tree #### Tags:
access: | protected
Type: | array
[ Top ] #### $project = [line 81] Current project #### Tags:
access: | protected
Type: | string
[ Top ] #### $removeAllWmsLayers = false [line 116] Remove all wms layers #### Tags:
access: | protected
Type: | boolean
[ Top ] #### $selectedServerUrl = [line 148] Url of user 's selected server #### Tags:
access: | protected
Type: | string
[ Top ] #### $userCommand = '' [line 136] User command #### Tags:
access: | protected
Type: | string
[ Top ] #### $userComment = [line 142] User comment #### Tags:
access: | protected
Type: | string
[ Top ] #### $userLog = array('action' => '', 'case' => -1, 'nServers' => 0) [line 160] User log #### Tags:
access: | protected
Type: | string
[ Top ] #### $userLogStatus = true [line 168] User log status (OK | Failed) #### Tags:
access: | protected
Type: | boolean
[ Top ] #### $wmsBrowserInit = [line 75] Server side initialised #### Tags:
access: | private
Type: | boolean
[ Top ] #### $wmsBrowserState = [line 87] WmsBrowser State object (session object) #### Tags:
access: | protected
Type: | object
[ Top ] #### $wmsLayerToAdd = [line 110] Layer to add name #### Tags:
access: | protected
Type: | string
[ Top ] #### $wmsServerManager = [line 93] WmsServerManager instance #### Tags:
access: | protected
Type: | object
[ Top ] ### Class Methods ### constructor __construct [line 179]
`ClientWmsBrowser __construct( )`
Constructor #### Tags:
access: | public
Overrides ClientPlugin::__construct() (Constructor) [ Top ] ### method add [line 560]
`void add( string $newServerUrl, string $userComment)`
Adds a server to the servers database and print user log. #### Tags:
access: | protected
#### Parameters:
string | $newServerUrl | server url
string | $userComment | user comment.
[ Top ] ### method buildRequest [line 333]
`void buildRequest( )`
#### Tags:
access: | public
see: | ServerCaller::buildRequest() Send server-side list of wms layers to dynamically insert in the mapfile
[ Top ] ### method buildServerLayersTree [line 430]
`array buildServerLayersTree( string $serverUrl)`
Open wms cache databases, find server whose url is passed and build the server layers tree. #### Tags:
return: | server layers tree
access: | protected
#### Parameters:
string | $serverUrl | server url (this server must ever be registred in server database)
[ Top ] ### method connect [line 622]
`void connect( string $serverUrl)`
Sets a server's status to connected and print user log. #### Tags:
access: | public
#### Parameters:
string | $serverUrl | server url
[ Top ] ### method controlUrl [line 528]
`boolean controlUrl( string $url)`
Control wether url doesn't contain any WMS stuff #### Tags:
return: | true if url is valid, else return false
access: | protected
#### Parameters:
string | $url | url
[ Top ] ### method createSession [line 214]
`void createSession( MapInfo $mapInfo, InitialMapState $initialMapState)`
#### Tags:
access: | public
see: | Sessionable::createSession()
[ Top ] ### method disconnect [line 643]
`void disconnect( string $serverUrl)`
Sets a server status to disconnected and print user log. #### Tags:
access: | public
#### Parameters:
string | $serverUrl | server url
[ Top ] ### method drawExploreWmsLayers [line 413]
`string drawExploreWmsLayers( )`
Draws ExploreWmsLayers popup #### Tags:
return: | Smarty generated HTML content
access: | protected
[ Top ] ### method drawExploreWmsLayersIframe [line 499]
`string drawExploreWmsLayersIframe( )`
Draws ExploreWmsLayersIframe iframe #### Tags:
return: | Smarty generated HTML content
access: | protected
[ Top ] ### method drawManageServersPopup [line 716]
`string drawManageServersPopup( )`
Draws ManageServers popup #### Tags:
return: | Smarty generated HTML content
access: | protected
[ Top ] ### method handleHttpGetRequest [line 325]
`void handleHttpGetRequest( array $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpGetRequest()
#### Parameters:
array | $request | HTTP request
[ Top ] ### method handleHttpPostRequest [line 317]
`void handleHttpPostRequest( array $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpPostRequest()
#### Parameters:
array | $request | HTTP request
[ Top ] ### method handleHttpRequest [line 245]
`void handleHttpRequest( array $request)`
Common processing for {@see ClientWmsBrowser::handleHttpPostRequest} and {@see ClientWmsBrowser::handleHttpGetRequest}. #### Tags:
access: | protected
#### Parameters:
array | $request | HTTP request
[ Top ] ### method handleInit [line 207]
`void handleInit( mixed $wmsBrowserInit)`
#### Tags:
access: | public
see: | InitUser::handleInit()
[ Top ] ### method handleResult [line 377]
`void handleResult( mixed $result)`
#### Tags:
access: | public
see: | ServerCaller::handleResult()
[ Top ] ### method initialize [line 187]
`void initialize( )`
#### Tags:
access: | public
see: | PluginBase::initialize()
Overrides PluginBase::initialize() (Plugin initialization (can be extended in custom plugins)) [ Top ] ### method initializeResult [line 372]
`void initializeResult( mixed $result)`
#### Tags:
access: | public
see: | ServerCaller::initializeResult()
[ Top ] ### method loadSession [line 233]
`void loadSession( mixed $sessionObject)`
#### Tags:
access: | public
see: | Sessionable::loadSession()
[ Top ] ### method refresh [line 674]
`void refresh( string $serverUrl)`
Refreshs server entries by removing all related records and re-downloading/parsing the capabilities file and print user log. #### Tags:
access: | public
#### Parameters:
string | $serverUrl | server url
[ Top ] ### method remove [line 658]
`void remove( string $serverUrl)`
Removes a server from the servers database and print user log. #### Tags:
access: | public
#### Parameters:
string | $serverUrl | server url
[ Top ] ### method renderForm [line 382]
`void renderForm( Smarty $template)`
#### Tags:
access: | public
see: | GuiProvider::renderForm()
[ Top ] ### method saveSession [line 392]
`void saveSession( )`
#### Tags:
access: | public
see: | Sessionable::saveSession()
[ Top ] ### method test [line 698]
`void test( string $serverUrl)`
Tests the availablility of a server and print user log. #### Tags:
access: | public
#### Parameters:
string | $serverUrl | server url
[ Top ] ### method update [line 594]
`void update( string $serverUrl, string $newServerUrl, string $userComment)`
Updates the given servers with the specified information and print user log. #### Tags:
access: | protected
#### Parameters:
string | $serverUrl | server url
string | $newServerUrl | new url.
string | $userComment | new user comment.
[ Top ] Documentation generated on Mon, 16 Jul 2007 13:31:50 +0200 by phpDocumentor 1.3.0RC3