CorePlugins

# Class: ServerLayers Source Location: /coreplugins/layers/server/ServerLayers.php
### Class Overview
    PluginBase
       |
       --ServerPlugin
          |
          --ClientResponderAdapter
             |
             --ServerLayers
Server plugin for managing the set of layers to render. | ### Variables $imageType $log $requestedLayerNames $resRatio $switchId $userLayers | ### Methods __construct addUserLayers getImageType getInit getRequestedLayerNames getResRatio getSwitchId handleCorePlugin initializeRequest removeUserLayers updateProperties updateRatioClassParameters updateRatioParameters
### 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 30] Server plugin for managing the set of layers to render. [ Top ] ### Class Variables #### $imageType = [line 48] Image type to use for images (outputformat identifier declared in mapfile). May be null to use default one. #### Tags:
access: | protected
Type: | string
[ Top ] #### $log = [line 35] #### Tags:
access: | private
Type: | Logger
Overrides: | Array
[ Top ] #### $requestedLayerNames = [line 41] The list of layers requested to be drawn by the client. #### Tags:
var: | Array of string
access: | protected
Type: | array
[ Top ] #### $resRatio = [line 54] Ratio client-required resolution / Mapserver resolution. #### Tags:
access: | protected
Type: | float
[ Top ] #### $switchId = [line 59] Current switch #### Tags:
access: | protected
Type: | mixed
[ Top ] #### $userLayers = [line 65] User added layers #### Tags:
access: | public
Type: | array
[ Top ] ### Class Methods ### constructor __construct [line 70]
`ServerLayers __construct( )`
Constructor #### Tags:
access: | public
Overrides ServerPlugin::__construct() (Constructor) [ Top ] ### method addUserLayers [line 82]
`void addUserLayers( mixed $userLayers)`
Adds user layers #### Tags:
var: | of UserLayer
access: | public
[ Top ] ### method getImageType [line 146]
`string getImageType( )`
Returns the image type to use for drawing, or null to use mapfile one. #### Tags:
access: | public
[ Top ] ### method getInit [line 351]
`void getInit( )`
#### Tags:
access: | public
see: | InitProvider::getInit()
[ Top ] ### method getRequestedLayerNames [line 137]
`array getRequestedLayerNames( )`
Returns the list of layers requested to be drawn by the client. #### Tags:
access: | public
[ Top ] ### method getResRatio [line 153]
`float getResRatio( )`
#### Tags:
return: | ratio client-required resolution / Mapserver resolution.
access: | public
[ Top ] ### method getSwitchId [line 161]
`string getSwitchId( )`
Returns current switch #### Tags:
access: | public
[ Top ] ### method handleCorePlugin [line 267]
`void handleCorePlugin( mixed $requ)`
#### Tags:
access: | public
see: | CoreProvider::handleCorePlugin()
[ Top ] ### method initializeRequest [line 168]
`void initializeRequest( mixed $requ)`
#### Tags:
access: | public
see: | ClientResponder::initializeRequest()
Overrides ClientResponderAdapter::initializeRequest() (parent method not documented) [ Top ] ### method removeUserLayers [line 112]
`void removeUserLayers( mixed $userLayers)`
Removes user layers #### Tags:
var: | of UserLayer
access: | public
[ Top ] ### method updateProperties [line 196]
`void updateProperties( mixed $obj, array $properties, float $ratio)`
Generic function to multiply integer properties of a php mapscript object of a given ratio. #### Tags:
access: | protected
#### Parameters:
mixed | $obj | php mapscript object to update
array | $properties | array of numerical properties to update
float | $ratio | multiplicative coefficient
[ Top ] ### method updateRatioClassParameters [line 211]
`void updateRatioClassParameters( mixed $class, mixed $resRatio)`
#### Tags:
access: | public
[ Top ] ### method updateRatioParameters [line 242]
`void updateRatioParameters( ms_layer_obj $layer, float $resRatio)`
Updates mapfile objects (layers, classes, styles) properties according to the ratio between required resolution and mapserver one. #### Tags:
access: | public
#### Parameters:
ms_layer_obj | $layer | Mapserver layer object
float | $resRatio | resolutions ratio
[ Top ] Documentation generated on Fri, 21 Sep 2007 13:31:03 +0200 by phpDocumentor 1.3.0RC3