CorePlugins
[ class tree: CorePlugins ] [ index: CorePlugins ] [ all elements ]

Class: LayersInit

Source Location: /coreplugins/layers/common/Layers.php

Class Overview

Serializable
   |
   --LayersInit

Layers initialization information. It contains all the layer related static information.


Variables

Methods


Inherited Variables

Inherited Methods

Class: Serializable

Serializable::__construct()
Constructor
Serializable::copyAllVars()
Copy all properties from one object to another (overwriting previous ones)
Serializable::getValue()
Returns structure's property value if property exists
Serializable::guessClassName()
Tries to guess the class to use from the property being unserialised.
Serializable::unserialize()
Unserializes from a stdClass structure
Serializable::unserializeArray()
Returns an array of typed values
Serializable::unserializeObject()
Returns an unserialized object from a stdClass structure
Serializable::unserializeObjectMap()
Returns an array of unserialized objects from a stdClass structure
Serializable::unserializeStringArray()
Returns an array of typed values from a string
Serializable::unserializeValue()
Returns a typed value from a structure property

Class Details

[line 239]
Layers initialization information. It contains all the layer related static information.



[ Top ]


Class Variables

$autoClassLegend =

[line 245]

If true, legend's icons will be generated



Tags:

access:  public

Type:   boolean


[ Top ]

$layers =

[line 272]

Array of all available layers.



Tags:

access:  public

Type:   array


[ Top ]

$notAvailableIcon =

[line 252]

Icon to show when layer not available (current scale is above or below

this layer max scale)




Tags:

access:  public

Type:   string


[ Top ]

$notAvailableMinusIcon =

[line 266]

Icon to show when layer not available (current scale is below this

layer max scale)




Tags:

access:  public

Type:   string


[ Top ]

$notAvailablePlusIcon =

[line 259]

Icon to show when layer not available (current scale is above this

layer max scale)




Tags:

access:  public

Type:   string


[ Top ]



Class Methods


method addChildLayerBase [line 331]

void addChildLayerBase( LayerBase $parentLayer, LayerBase $childLayer)

Adds a layer as a child of another



Tags:

access:  public


Parameters:

LayerBase   $parentLayer   The parent layer where to add this layer, or NULL if no parent
LayerBase   $childLayer   The child layer to be added.

[ Top ]

method getInitialMapStateById [line 309]

InitialMapState getInitialMapStateById( string $mapStateId)

Returns a map state identified by its ID



Tags:

access:  public


Parameters:

string   $mapStateId  

[ Top ]

method getLayerById [line 279]

LayerBase getLayerById( string $layerId)

Returns a layer identified by its ID



Tags:

access:  public


Parameters:

string   $layerId  

[ Top ]

method getLayers [line 322]

array getLayers( )

Returns the array of all available layers



Tags:

access:  public


[ Top ]

method getMsLayerById [line 294]

MsLayer getMsLayerById( MsMapObj $msMapObj, string $layerId)

Helper function to get a mapserver layer from a layerId



Tags:

return:  MapServer layer object
access:  public


Parameters:

MsMapObj   $msMapObj   MapServer object
string   $layerId  

[ Top ]

method unserialize [line 349]

void unserialize( mixed $struct)



Tags:

access:  public
see:  Serializable::unserialize()


Overrides Serializable::unserialize() (Unserializes from a stdClass structure)

[ Top ]


Documentation generated on Wed, 6 Apr 2005 12:06:42 +0200 by phpDocumentor 1.3.0RC3