Class: LayersInit

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

Class Overview

CwSerializable
   |
   --LayersInit

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

Variables

Methods

Inherited Variables

Class: CwSerializable

CwSerializable::$className

Inherited Methods

Class: CwSerializable

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

Class Details

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

[ Top ]

Class Variables

$autoClassLegend =

[line 463]

If true, legend's icons will be generated

Tags:

access:

public

Type:

boolean

[ Top ]

$layers =

[line 490]

Array of all available layers.

Tags:

access:

public

Type:

array

[ Top ]

$notAvailableIcon =

[line 470]

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 484]

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

layer max scale)

Tags:

access:

public

Type:

string

[ Top ]

$notAvailablePlusIcon =

[line 477]

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

layer max scale)

Tags:

access:

public

Type:

string

[ Top ]

$switches =

[line 496]

Array of switches

Tags:

access:

public

Type:

array

[ Top ]

Class Methods

method addChildLayerBase [line 555]

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 533]

InitialMapState getInitialMapStateById(
string
$mapStateId)

Returns a map state identified by its ID

Tags:

access:

public

Parameters:

string

$mapStateId

[ Top ]

method getLayerById [line 503]

LayerBase getLayerById(
string
$layerId)

Returns a layer identified by its ID

Tags:

access:

public

Parameters:

string

$layerId

[ Top ]

method getLayers [line 546]

array getLayers(
)

Returns the array of all available layers

Tags:

access:

public

[ Top ]

method getMsLayerById [line 518]

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 removeChildLayerBase [line 591]

void removeChildLayerBase(
LayerBase
$parentLayer, LayerBase
$childLayer)

Removes a layer.

Tags:

access:

public

Parameters:

LayerBase	$parentLayer	parent layer where to remove this layer or NULL if no parent
LayerBase	$childLayer	child layer to delete

[ Top ]

method unserialize [line 617]

void unserialize(
mixed
$struct)

Tags:

access:	public
see:	CwSerializable::unserialize()

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

[ Top ]

method __clone [line 639]

void __clone(
)

Clone array of layers

Tags:

access:

public

[ Top ]

Documentation generated on Fri, 21 Sep 2007 13:30:51 +0200 by phpDocumentor 1.3.0RC3