CorePlugins

# Class: LayersInitProvider Source Location: /coreplugins/layers/server/LayersInitProvider.php
### Class Overview
Creates the LayersInit structure for the layers server plugin. This class is separated from the ServerLayer class for code speratation and lisibility. | ### Variables $layersInit $log $mapId $projectHandler $serverContext $serverLayers | ### Methods __construct fillDynamicLayer fillDynamicLayerBase fillDynamicLayers fillDynamicMap getClassIcon getIconsRelativePath getIconUrl getInit getSymPath getWmsIcon
### Class Details [line 29] Creates the LayersInit structure for the layers server plugin. This class is separated from the ServerLayer class for code speratation and lisibility. [ Top ] ### Class Variables #### $layersInit = [line 44] #### Tags:
access: | public
Type: | MapInfo
[ Top ] #### $log = [line 34] #### Tags:
access: | private
Type: | Logger
[ Top ] #### $mapId = [line 54] #### Tags:
access: | protected
Type: | string
[ Top ] #### $projectHandler = [line 49] #### Tags:
access: | protected
Type: | ProjectHandler
[ Top ] #### $serverContext = [line 39] #### Tags:
access: | protected
Type: | ServerContext
[ Top ] #### $serverLayers = [line 59] #### Tags:
access: | protected
Type: | ServerLayers
[ Top ] ### Class Methods ### constructor __construct [line 68]
`LayersInitProvider __construct( ServerContext $serverContext, ServerLayers $serverLayers, ProjectHandler 2, ServerLayers 3)`
Constructor #### Tags:
access: | public
#### Parameters:
ProjectHandler | 2 |
ServerLayers | 3 |
ServerContext | $serverContext |
string | $serverLayers | map id
[ Top ] ### method fillDynamicLayer [line 291]
`void fillDynamicLayer( Layer $layer)`
Fills properties of the given Layer object. It opens the underlying corresponding mapserver layer object. #### Tags:
access: | public
#### Parameters:
Layer | $layer |
[ Top ] ### method fillDynamicLayerBase [line 99]
`void fillDynamicLayerBase( LayerBase $layerBase)`
Fills properties of the given LayerBase object. #### Tags:
access: | public
#### Parameters:
LayerBase | $layerBase |
[ Top ] ### method fillDynamicLayers [line 359]
`void fillDynamicLayers( )`
Fills dynamic properties of all layer objects. It calls specific methods for each kind of LayerBase and Layer objects. #### Tags:
access: | protected
[ Top ] ### method fillDynamicMap [line 81]
`void fillDynamicMap( )`
Fills dynamic general map information, like map name. #### Tags:
access: | protected
[ Top ] ### method getClassIcon [line 165]
`string getClassIcon( string $classId, MapObj $msMapObj, ClassObj $msLayerObj, mixed $msClassIndex)`
Generates an icon image for classes, and returns its URL. #### Tags:
access: | protected
#### Parameters:
string | $classId | class id
MapObj | $msMapObj |
ClassObj | $msLayerObj |
[ Top ] ### method getIconsRelativePath [line 139]
`string getIconsRelativePath( )`
Returns the relative path to the icons. It is relative to the directory where generated images are stored. #### Tags:
access: | protected
[ Top ] ### method getIconUrl [line 120]
`string getIconUrl( string $icon, [boolean $generated = false])`
Returns the URL to the given icon. The URL is calculated using the Resource handler. #### Tags:
access: | protected
#### Parameters:
string | $icon | icon relative path
boolean | $generated | indicates if icon has been generated by Cartoserver
[ Top ] ### method getInit [line 422]
`void getInit( )`
#### Tags:
access: | public
see: | InitProvider::getInit()
[ Top ] ### method getSymPath [line 149]
`string getSymPath( )`
Returns symbols file path. #### Tags:
access: | protected
[ Top ] ### method getWmsIcon [line 224]
`string getWmsIcon( string $LayerId, MapObj $msMapObj, LayerObj $msLayer)`
Retrieve an icon from a distant WMS/SLD server #### Tags:
access: | protected
#### Parameters:
string | $LayerId | layer id
MapObj | $msMapObj |
LayerObj | $msLayer |
[ Top ] Documentation generated on Fri, 21 Sep 2007 13:30:51 +0200 by phpDocumentor 1.3.0RC3