Plugins

# Class: ServerToolTips Source Location: /plugins/toolTips/server/ServerToolTips.php
### Class Overview
    PluginBase
       |
       --ServerPlugin
          |
          --ClientResponderAdapter
             |
             --ServerToolTips
Server ToolTips class | ### Variables $imagemapLayers $imagemapLayersNames $log | ### Methods __construct computeFeatures computeImagemap getAttributes getImagemapLayersNames handlePostDrawing initializeRequest isAttributesRetrievable prepareQuery queryLayer setMsLayerTemplate
### Inherited Variables #### Class: ServerPlugin ServerPlugin::$config ServerPlugin::$serverContext #### Class: PluginBase PluginBase::$basePath PluginBase::$name PluginBase::$overriddenRequest | ### Inherited Methods #### Class: ClientResponderAdapter ClientResponderAdapter::handleDrawing() ClientResponderAdapter::handlePostDrawing() ClientResponderAdapter::handlePreDrawing() ClientResponderAdapter::initializeRequest() #### Class: ServerPlugin ServerPlugin::__construct() Constructor ServerPlugin::getConfig() ServerPlugin::getServerContext() ServerPlugin::initializeConfig() Initializes plugin configuration ServerPlugin::useExtendedInit() ServerPlugin::useExtendedRequest() ServerPlugin::useExtendedResult() #### 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 29] Server ToolTips class [ Top ] ### Class Variables #### $imagemapLayers = array() [line 41] List of imagemapable layer #### Tags:
access: | protected
Type: | array
[ Top ] #### $imagemapLayersNames = array() [line 47] List of imagemapable layer names #### Tags:
access: | protected
Type: | array
[ Top ] #### $log = [line 33] #### Tags:
access: | private
Type: | Logger
Overrides: | Array
[ Top ] ### Class Methods ### constructor __construct [line 52]
`ServerToolTips __construct( )`
Constructor #### Tags:
access: | public
Overrides ServerPlugin::__construct() (Constructor) [ Top ] ### method computeFeatures [line 182]
`array computeFeatures( )`
Builds the imagemapable features attributes #### Tags:
return: | of features
access: | protected
[ Top ] ### method computeImagemap [line 164]
`generated computeImagemap( )`
Builds the imagemap html code #### Tags:
return: | html code
access: | protected
[ Top ] ### method getAttributes [line 263]
`array getAttributes( string $layerId)`
Returns list of attributes to be returned #### Tags:
access: | protected
#### Parameters:
string | $layerId | layer id
[ Top ] ### method getImagemapLayersNames [line 75]
`array getImagemapLayersNames( mixed $layers)`
Returns list of msLayers' names with given imagemapable layers' id #### Tags:
return: | array of imagemapable layers' names
access: | protected
[ Top ] ### method handlePostDrawing [line 102]
`void handlePostDrawing( mixed $requ)`
#### Tags:
access: | public
see: | ClientResponder::handlePostDrawing()
Overrides ClientResponderAdapter::handlePostDrawing() (parent method not documented) [ Top ] ### method initializeRequest [line 95]
`void initializeRequest( mixed $requ)`
#### Tags:
access: | public
see: | ClientResponder::initializeRequest
Overrides ClientResponderAdapter::initializeRequest() (parent method not documented) [ Top ] ### method isAttributesRetrievable [line 61]
`array isAttributesRetrievable( mixed $layerId)`
Tells if we should retrieve attributes #### Tags:
return: | array of imagemapable layers' names
access: | protected
[ Top ] ### method prepareQuery [line 125]
`void prepareQuery( )`
Prepares the map query i.e. set STATUS, set TEMPLATE for imagemapable layers #### Tags:
access: | protected
[ Top ] ### method queryLayer [line 215]
`Table queryLayer( Bbox $bbox, QuerySelection $querySelection)`
Executes query on layer Query can be done using a Bbox, a list of Ids, or both #### Tags:
access: | protected
#### Parameters:
Bbox | $bbox |
QuerySelection | $querySelection |
[ Top ] ### method setMsLayerTemplate [line 144]
`void setMsLayerTemplate( msLayer $layer)`
Sets TEMPLATE paramater for given layer #### Tags:
access: | protected
#### Parameters:
msLayer | $layer |
[ Top ] Documentation generated on Fri, 25 May 2007 13:32:09 +0200 by phpDocumentor 1.3.0RC3