Docs For Class ClientLayers

$childrenCache = array()

[line 299]

Tags:

access:

protected

Type:

array

[ Top ]

$currentScale =

[line 309]

Tags:

access:

protected

Type:

float

[ Top ]

$frozenLayers = array()

[line 269]

Tags:

access:

protected

Type:

array

[ Top ]

$frozenSelectedLayers =

[line 244]

Tags:

access:

protected

Type:

array

[ Top ]

$frozenUnselectedLayers =

[line 249]

Tags:

access:

protected

Type:

array

[ Top ]

$hiddenLayers = array()

[line 264]

Tags:

access:

protected

Type:

array

[ Top ]

$hiddenSelectedLayers =

[line 234]

Tags:

access:

protected

Type:

array

[ Top ]

$hiddenUnselectedLayers =

[line 239]

Tags:

access:

protected

Type:

array

[ Top ]

$layerIds = array()

[line 294]

Tags:

access:

protected

Type:

array

[ Top ]

$layers =

[line 254]

Tags:

access:

protected

Type:

array

[ Top ]

$layersData =

[line 229]

List of LayerState objects. See LayerState.

Tags:

access:

protected

Type:

array

[ Top ]

$layersInit =

[line 218]

Tags:

access:

protected

Type:

LayersInit

[ Top ]

$layersState =

[line 223]

Tags:

access:

protected

Type:

LayersState

[ Top ]

$log =

[line 208]

Tags:

access:

private

Type:	Logger
Overrides:	Array

[ Top ]

$mapId =

[line 314]

Tags:

access:

protected

Type:

string

[ Top ]

$nodeId = array()

[line 284]

Tags:

access:

protected

Type:

array

[ Top ]

$nodesIds = array()

[line 289]

Tags:

access:

protected

Type:

array

[ Top ]

$notAvailableIcon =

[line 319]

Availability information icons

Tags:

access:

protected

Type:

mixed

[ Top ]

$notAvailableMinusIcon =

[line 321]

Tags:

access:

protected

Type:

mixed

[ Top ]

$notAvailablePlusIcon =

[line 320]

Tags:

access:

protected

Type:

mixed

[ Top ]

$overrideSwitch = false

[line 332]

True if switch was overrided by another plugin

Tags:

access:

protected

Type:

mixed

[ Top ]

$selectedLayers = array()

[line 259]

Tags:

access:

protected

Type:

array

[ Top ]

$smarty =

[line 213]

Tags:

access:

protected

Type:

Smarty_Plugin

[ Top ]

$unauthorizedSwitches = array()

[line 304]

Tags:

access:

protected

Type:

array

[ Top ]

$unfoldedIds = array()

[line 279]

Tags:

access:

protected

Type:

array

[ Top ]

$unfoldedLayerGroups = array()

[line 274]

Tags:

access:

protected

Type:

array

[ Top ]

$useNewSwitch = false

[line 326]

Tags:

access:

protected

Type:

boolean

[ Top ]

constructor __construct [line 341]

ClientLayers __construct(
)

Constructor

Tags:

access:

public

Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method adjustExportMapRequest [line 1853]

void adjustExportMapRequest(
ExportConfiguration
$configuration, MapRequest
$mapRequest)

Tags:

access:	public
see:	Exportable::adjustExportMapRequest()

[ Top ]

method ajaxGetPluginResponse [line 1527]

void ajaxGetPluginResponse(
AjaxPluginResponse
$ajaxPluginResponse)

Tags:

access:	public
see:	Ajaxable::ajaxGetPluginResponse()

[ Top ]

method ajaxHandleAction [line 1540]

void ajaxHandleAction(
mixed
$actionName, PluginEnabler
$pluginEnabler)

Tags:

access:	public
see:	Ajaxable::ajaxHandleAction()

[ Top ]

method buildRequest [line 1028]

void buildRequest(
)

Tags:

access:	public
see:	ServerCaller::buildRequest()

[ Top ]

method createSession [line 409]

void createSession(
MapInfo
$mapInfo, InitialMapState
$initialMapState)

Initializes layers session data and initially populates some properties.

Tags:

access:	public
see:	Sessionable::CreateSession()

[ Top ]

method drawLayersList [line 1455]

string drawLayersList(
)

Initializes layers selector interface.

Tags:

return:	result of a Smarty fetch
access:	protected

[ Top ]

method drawSwitches [line 1481]

string drawSwitches(
)

Draws switches dropdown

Tags:

return:	result of a smarty fetch
access:	protected

[ Top ]

method fetchChildrenFromLayerGroup [line 940]

array fetchChildrenFromLayerGroup(
array
$layersList, [boolean
$listLayerGroups = false])

Determines activated layers by recursively browsing LayerGroups.

Only keeps Layer objects that are not detected as {hidden AND not selected}.

Tags:

return:	list of children, grand-children... of given layers
access:	public

Parameters:

array	$layersList	list of layers names
boolean	$listLayerGroups	if true, layerGroups will be listed as well (default: false)

[ Top ]

method fetchFrozenSelectedLayers [line 873]

array fetchFrozenSelectedLayers(
string
$layerId, [boolean
$forceFrozen = false], [boolean
$forceSelected = false])

Recursively retrieves selected frozen layers.

Tags:

access:	protected
see:	ClientLayers::fetchHiddenSelectedLayers()

Parameters:

string	$layerId	layer name
boolean	$forceFrozen	(default: false) if true, transmits 'frozen' status to children layers
boolean	$forceSelected	(default: false) if true, transmits 'selected' status to children layers

[ Top ]

method fetchHiddenSelectedLayers [line 853]

array fetchHiddenSelectedLayers(
string
$layerId, [boolean
$forceHidden = false], [boolean
$forceSelected = false])

Recursively retrieves selected hidden layers (not transmitted by the browser). Since "hidden" property is inheritated by layers from their declared-as-hidden parents, those layers selection statuses are retrieved as well.

Tags:

access:

protected

Parameters:

string	$layerId	layer name
boolean	$forceHidden	(default: false) if true, transmits 'hidden' status to children layers
boolean	$forceSelected	(default: false) if true, transmits 'selected' status to children layers

[ Top ]

method fetchLayer [line 1294]

array fetchLayer(
LayerBase
$layer, [boolean
$forceSelection = false], [boolean
$forceFrozen = false], [string
$layerRendering = self::RENDERING_TREE], [int
$parentId = 0])

Deals with every single layer and recursively calls itself to build sublayers.

Tags:

return:	array of layer children and grand-children... data
access:	protected

Parameters:

LayerBase	$layer
boolean	$forceSelection	(default: false) if true transmits 'selected' status to children
boolean	$forceFrozen	(default: false) if true transmits 'frozen' status to children
string	$layerRendering	(default: 'tree') rendering of layers
int	$parentId	(default: 0) id of parent layer in displayed interface

[ Top ]

method fetchLayerIcon [line 1218]

string fetchLayerIcon(
LayerBase
$layer, [array
&$children = array()])

Returns layer icon filename if any.

Tags:

access:

protected

Parameters:

LayerBase	$layer
array	&$children	list of layer children names (default: empty array)

[ Top ]

method fetchRecursively [line 897]

array fetchRecursively(
LayerBase
$layer, string
$type, boolean
$forceFixed, boolean
$forceSelected)

Performs common recursive job for fetchHiddenSelectedLayers() and fetchFrozenSelectedLayers().

Tags:

access:	protected
see:	ClientLayers::fetchFrozenSelectedLayers()
see:	ClientLayers::fetchHiddenSelectedLayers()

Parameters:

LayerBase	$layer
string	$type	type of layers detection: 'hidden' or 'frozen'
boolean	$forceFixed	inherited status (see above type)
boolean	$forceSelected	inherited selection status

[ Top ]

method getClassChildren [line 1165]

array getClassChildren(
LayerBase
$layer)

Recursively retrieves the list of Mapserver Classes bound to the layer or its sublayers.

Tags:

return:	array of layers names
access:	protected

Parameters:

LayerBase

$layer

[ Top ]

method getCurrentScale [line 1186]

float getCurrentScale(
)

Retrieves current scale from location plugin

Tags:

access:

protected

[ Top ]

method getFrozenLayers [line 837]

array getFrozenLayers(
)

Returns the list of explicitely frozen layers.

Tags:

access:

protected

[ Top ]

method getHiddenLayers [line 829]

array getHiddenLayers(
)

Returns the list of explicitely hidden layers.

Tags:

access:

protected

[ Top ]

method getLayerByName [line 608]

LayerBase getLayerByName(
string
$layername, [boolean
$strict = true])

Returns the Layer|LayerGroup|LayerClass object whose name is passed.

Tags:

return:	layer object of type Layer\|LayerGroup\|LayerClass
access:	public

Parameters:

string	$layername	name of layer
boolean	$strict	if true (default), throws exception if invalid layername

[ Top ]

method getLayerChildren [line 623]

array getLayerChildren(
LayerBase
$layer)

Returns a list of current layer children, taking into account some criteria such as aggregation, LayerClass name validity.

Tags:

return:	array of layers names
access:	protected

Parameters:

LayerBase

$layer

layer object of type Layer|LayerGroup|LayerClass

[ Top ]

method getLayerIds [line 583]

array getLayerIds(
)

Tags:

return:	layerIds, list of server-asked layers
access:	public

[ Top ]

method getLayerNode [line 543]

LayerNode getLayerNode(
)

Construct a new tree of layerNodes by getting the layers from the mapInfo.

Tags:

return:	The root node of the hierarchy of layerNodes.
access:	protected

[ Top ]

method getLayerParent [line 1804]

object layer getLayerParent(
string
$layerId, array
$allLayers)

Find and return the parent of a layer

Tags:

return:	node
access:	public

Parameters:

string	$layerId	layer id
array	$allLayers	structure containing data of all layers available with current switch and rights

[ Top ]

method getLayers [line 593]

array getLayers(
[boolean
$forceRefresh = false])

Returns the list of Layer|LayerGroup|LayerClass objects available in MapInfo.

Tags:

access:

public

Parameters:

boolean

$forceRefresh

if true, force refresh list (default: false)

[ Top ]

method getLayersInit [line 1846]

array getLayersInit(
)

Tags:

return:	layersInit
access:	public

[ Top ]

method getLayersMask [line 983]

array getLayersMask(
[string
$layerId = 'root'], [bool
$resetCache = false])

Recursively determines layers that can be selected in layers selector.

Tags:

return:	layers list
access:	public

Parameters:

string	$layerId	layer id
bool	$resetCache	if true, children cache is ignored (default: false)

[ Top ]

method getLayersSecurityFiltered [line 564]

array getLayersSecurityFiltered(
)

Filters the layers which are not allowed to be viewed by the current user. It returns a flat map of (layerId => Layer object).

Tags:

return:	An array of LayerBase object.
access:	protected

[ Top ]

method getMatchingLayers [line 792]

array getMatchingLayers(
string
$stateProperty, string
$storageName, [boolean
$refresh = false])

Returns a list of layers that match passed condition.

Is in fact a code factorizer for get*Layers() methods.

Tags:

access:

protected

Parameters:

string	$stateProperty	name of some LayerBase property. See LayerBase.
string	$storageName	name of ClientLayers property that contains data
boolean	$refresh	if true, refreshes storage content (default to false)

[ Top ]

method getNewSessionObject [line 401]

LayersState getNewSessionObject(
)

Gets a new instance of layers-plugin session-storage class.

Usefull in extended ClientLayers class when using extended session storage class.

Tags:

access:

protected

[ Top ]

method getPrintedIconPath [line 1559]

string getPrintedIconPath(
string
$icon)

Returns icon full path.

Tags:

return:	full path
access:	protected

Parameters:

string

$icon

icon filename

[ Top ]

method getPrintedLayerData [line 1572]

array getPrintedLayerData(
string
$layerId, mixed
$resolution)

Returns given layer printing data (icon, label, children...).

Tags:

access:

protected

Parameters:

string

$layerId

layer id

[ Top ]

method getPrintedLayers [line 1774]

array getPrintedLayers(
array
$selectedLayers, float
$scale, [mixed
$resolution = 0])

Returns the list of layers actually printed on mainmap as well as their classes and parent LayerGroups if any (mainly used for PDF printing).

Tags:

return:	complete list of printed layers, layergroups, layerclasses
access:	public

Parameters:

array	$selectedLayers	list of layers explicitely asked to CartoServer
float	$scale	scale value

[ Top ]

method getPrintedParents [line 1643]

void getPrintedParents(
string
$layerId, array
$allLayers, array
&$printedNodes, string
$childIdRef)

Add into $printedNodes the parent nodes which are 'aggregate' or 'showInPdfLegend'

Tags:

access:

protected

Parameters:

string	$layerId	id of layer, we will seek it's parent node info
array	$allLayers	structure containing data of all layers available with current switch and rights
array	&$printedNodes	structure containing data of layers to print
string	$childIdRef	child node id, by reference to the printed list, not the complet children list

[ Top ]

method getSelectedLayers [line 812]

array getSelectedLayers(
[boolean
$refresh = false])

Returns the list of activated layers.

Tags:

access:

public

Parameters:

boolean

$refresh

optional (default: false), if true, forces result refresh

[ Top ]

method getSwitchTargetId [line 1878]

string getSwitchTargetId(
)

get target id for switch

Tags:

access:

protected

[ Top ]

method getUnfoldedLayerGroups [line 821]

array getUnfoldedLayerGroups(
)

Returns the list of LayerGroups that must be rendered unfolded.

Tags:

access:

protected

[ Top ]

method handleHttpGetRequest [line 757]

void handleHttpGetRequest(
mixed
$request)

Handles data from GET request.

Tags:

access:	public
see:	GuiProvider::handleHttpGetRequest()

[ Top ]

method handleHttpPostRequest [line 701]

void handleHttpPostRequest(
mixed
$request)

Handles layers-related POST'ed data and updates layers statuses.

Tags:

access:	public
see:	GuiProvider::handleHttpPostRequest()

[ Top ]

method handleInit [line 349]

void handleInit(
mixed
$layersInit)

Tags:

access:	public
see:	InitUser::handleInit()

[ Top ]

method handleResult [line 1157]

void handleResult(
mixed
$layersResult)

Tags:

access:	public
see:	ServerCaller::handleResult()

[ Top ]

method handleSwitches [line 659]

void handleSwitches(
array
$request)

Handles switches form

Tags:

access:

protected

Parameters:

array

$request

[ Top ]

method initializeResult [line 1046]

void initializeResult(
mixed
$layersResult)

Tags:

access:	public
see:	ServerCaller::initializeResult()

[ Top ]

method initUnauthorizedSwitches [line 469]

void initUnauthorizedSwitches(
LayerContainer
$layer)

Initializes list of unauthorized layers due to switches marked as unauthorized.

Tags:

access:

protected

Parameters:

current

$layer

layer

[ Top ]

method isLayerVisibleAtCurrentScale [line 1608]

boolean isLayerVisibleAtCurrentScale(
string
$layerId)

Tells if given layer is visible at current scale

Checks for classes scale visibility

Tags:

access:

public

Parameters:

string

$layerId

layer id

[ Top ]

method isLayerVisibleAtScale [line 1621]

boolean isLayerVisibleAtScale(
string
$layerId, int
$scale)

Tells if given layer is visible at given scale

Checks for classes scale visibility

Tags:

access:

public

Parameters:

string	$layerId	layer id
int	$scale	scale

[ Top ]

method isOutOfRangeIcon [line 1206]

boolean isOutOfRangeIcon(
string
$icon)

Tags:

return:	True if this icon is an out of range icon (below or above scale).
access:	protected

Parameters:

string

$icon

icon filename

[ Top ]

method loadSession [line 361]

void loadSession(
mixed
$sessionObject)

Retrieves session-saved layers data.

Tags:

access:	public
see:	Sessionable::loadSession()

[ Top ]

method nodesFilterSecurity [line 522]

boolean nodesFilterSecurity(
LayerNode
$node)

Callback used to remove nodes which are not visible by the current user.

If it returns true, the node will be ignored in the tree.

Tags:

return:	True if this node is not accepted (meaning access denied)
access:	public

Parameters:

LayerNode

$node

The node on which to check access

[ Top ]

method orderPrintedNodes [line 1709]

void orderPrintedNodes(
array
$printedNodes, array
$nodesToSort, [bool
$checkOrphan = true])

Hierarchicaly reorder the nodes

Tags:

access:

protected

Parameters:

array	$printedNodes	structure containing data of layers to print
array	$nodesToSort	list of nodes to sort
bool	$checkOrphan	prevent infinite loop, default true

[ Top ]

method renderForm [line 1517]

void renderForm(
Smarty
$template)

Assigns the layers interface output in the general Cartoclient template.

Tags:

access:	public
see:	GuiProvider::renderForm()

[ Top ]

method saveSession [line 1836]

void saveSession(
)

Saves layers data in session.

Tags:

access:	public
see:	Sessionable::saveSession()

[ Top ]

method setOutofScaleIcon [line 1264]

boolean setOutofScaleIcon(
LayerBase
$layer)

Substitutes out-of-scale icons if current scale is out of the layer range of scales.

Tags:

access:

protected

Parameters:

LayerBase

$layer

[ Top ]

method setSwitch [line 672]

void setSwitch(
string
$newSwitch)

Changes switch from another plugin

Tags:

access:

public

Parameters:

string

$newSwitch

[ Top ]

Class: ClientLayers

Class Overview

Variables

Constants

Methods

Inherited Constants

Class: ClientPlugin

Inherited Variables

Class: ClientPlugin

Class: PluginBase

Inherited Methods

Class: ClientPlugin

Class: PluginBase

Class Details

Class Variables

$childrenCache = array()

Tags:

$currentScale =

Tags:

$frozenLayers = array()

Tags:

$frozenSelectedLayers =

Tags:

$frozenUnselectedLayers =

Tags:

$hiddenLayers = array()

Tags:

$hiddenSelectedLayers =

Tags:

$hiddenUnselectedLayers =

Tags:

$layerIds = array()

Tags:

$layers =

Tags:

$layersData =

Tags:

$layersInit =

Tags:

$layersState =

Tags:

$log =

Tags:

$mapId =

Tags:

$nodeId = array()

Tags:

$nodesIds = array()

Tags:

$notAvailableIcon =

Tags:

$notAvailableMinusIcon =

Tags:

$notAvailablePlusIcon =

Tags:

$overrideSwitch = false

Tags:

$selectedLayers = array()

Tags:

$smarty =

Tags:

$unauthorizedSwitches = array()

Tags:

$unfoldedIds = array()

Tags:

$unfoldedLayerGroups = array()

Tags:

$useNewSwitch = false

Tags:

Class Methods

constructor __construct [line 341]

Tags:

method adjustExportMapRequest [line 1853]

Tags:

method ajaxGetPluginResponse [line 1527]

Tags:

method ajaxHandleAction [line 1540]

Tags:

method buildRequest [line 1028]

Tags: