Class: ClientLayers
Source Location: /coreplugins/layers/client/ClientLayers.php
Inherited Constants
|
Inherited Variables
|
Inherited Methods
|
Class Details
[line 202]
Handles layers selection interface
Class Variables
Class Methods
constructor __construct [line 336]
method adjustExportMapRequest [line 1626]
void adjustExportMapRequest(
ExportConfiguration
$configuration, MapRequest
$mapRequest)
|
|
Tags:
method ajaxGetPluginResponse [line 1443]
void ajaxGetPluginResponse(
AjaxPluginResponse
$ajaxPluginResponse)
|
|
Tags:
method ajaxHandleAction [line 1454]
void ajaxHandleAction(
mixed
$actionName, PluginEnabler
$pluginEnabler)
|
|
Tags:
method buildRequest [line 950]
method createSession [line 404]
void createSession(
MapInfo
$mapInfo, InitialMapState
$initialMapState)
|
|
Initializes layers session data and initially populates some properties.
Tags:
method drawLayersList [line 1377]
Initializes layers selector interface.
Tags:
method drawSwitches [line 1403]
Draws switches dropdown
Tags:
method fetchChildrenFromLayerGroup [line 871]
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:
Parameters:
method fetchFrozenSelectedLayers [line 804]
array fetchFrozenSelectedLayers(
string
$layerId, [boolean
$forceFrozen = false], [boolean
$forceSelected = false])
|
|
Recursively retrieves selected frozen layers.
Tags:
Parameters:
method fetchHiddenSelectedLayers [line 784]
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:
Parameters:
method fetchLayer [line 1216]
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:
Parameters:
method fetchLayerIcon [line 1140]
string fetchLayerIcon(
LayerBase
$layer, [array
&$children = array()])
|
|
Returns layer icon filename if any.
Tags:
Parameters:
method fetchRecursively [line 828]
array fetchRecursively(
LayerBase
$layer, string
$type, boolean
$forceFixed, boolean
$forceSelected)
|
|
Performs common recursive job for fetchHiddenSelectedLayers() and fetchFrozenSelectedLayers().
Tags:
Parameters:
method getClassChildren [line 1087]
Recursively retrieves the list of Mapserver Classes bound to the layer or its sublayers.
Tags:
Parameters:
method getCurrentScale [line 1108]
Retrieves current scale from location plugin
Tags:
method getFrozenLayers [line 768]
Returns the list of explicitely frozen layers.
Tags:
method getHiddenLayers [line 760]
Returns the list of explicitely hidden layers.
Tags:
method getLayerByName [line 547]
LayerBase getLayerByName(
string
$layername, [boolean
$strict = true])
|
|
Returns the Layer|LayerGroup|LayerClass object whose name is passed.
Tags:
Parameters:
method getLayerChildren [line 562]
Returns a list of current layer children, taking into account some criteria such as aggregation, LayerClass name validity.
Tags:
Parameters:
method getLayerIds [line 522]
method getLayerNode [line 483]
Construct a new tree of layerNodes by getting the layers from the mapInfo.
Tags:
method getLayers [line 532]
array getLayers(
[boolean
$forceRefresh = false])
|
|
Returns the list of Layer|LayerGroup|LayerClass objects available in MapInfo.
Tags:
Parameters:
method getLayersInit [line 1619]
method getLayersMask [line 914]
array getLayersMask(
[string
$layerId = 'root'], [bool
$resetCache = false])
|
|
Recursively determines layers that can be selected in layers selector.
Tags:
Parameters:
method getLayersSecurityFiltered [line 504]
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:
method getMatchingLayers [line 723]
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:
Parameters:
method getNewSessionObject [line 396]
Gets a new instance of layers-plugin session-storage class. Usefull in extended ClientLayers class when using extended session storage class.
Tags:
method getPrintedIconPath [line 1473]
string getPrintedIconPath(
string
$icon)
|
|
Returns icon full path.
Tags:
Parameters:
method getPrintedLayerData [line 1486]
array getPrintedLayerData(
string
$layerId, mixed
$resolution)
|
|
Returns given layer printing data (icon, label, children...).
Tags:
Parameters:
method getPrintedLayers [line 1589]
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:
Parameters:
method getPrintedParents [line 1546]
void getPrintedParents(
string
$layerId, array
&$selectedLayers, array
&$printedNodes)
|
|
Recursively detects selected layers parent nodes and substitutes them if parents are aggregated.
Tags:
Parameters:
method getSelectedLayers [line 743]
array getSelectedLayers(
[boolean
$refresh = false])
|
|
Returns the list of activated layers.
Tags:
Parameters:
method getUnfoldedLayerGroups [line 752]
array getUnfoldedLayerGroups(
)
|
|
Returns the list of LayerGroups that must be rendered unfolded.
Tags:
method handleHttpGetRequest [line 688]
void handleHttpGetRequest(
mixed
$request)
|
|
Handles data from GET request.
Tags:
method handleHttpPostRequest [line 632]
void handleHttpPostRequest(
mixed
$request)
|
|
Handles layers-related POST'ed data and updates layers statuses.
Tags:
method handleInit [line 344]
void handleInit(
mixed
$layersInit)
|
|
Tags:
method handleResult [line 1079]
void handleResult(
mixed
$layersResult)
|
|
Tags:
method handleSwitches [line 598]
void handleSwitches(
array
$request)
|
|
Handles switches form
Tags:
Parameters:
method initializeResult [line 968]
void initializeResult(
mixed
$layersResult)
|
|
Tags:
method isLayerVisibleAtCurrentScale [line 1523]
boolean isLayerVisibleAtCurrentScale(
string
$layerId)
|
|
Tells if given layer is visible at current scale Checks for classes scale visibility
Tags:
Parameters:
method isOutOfRangeIcon [line 1128]
boolean isOutOfRangeIcon(
string
$icon)
|
|
Tags:
Parameters:
method loadSession [line 356]
void loadSession(
mixed
$sessionObject)
|
|
Retrieves session-saved layers data.
Tags:
method nodesFilterSecurity [line 465]
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:
Parameters:
method renderForm [line 1433]
void renderForm(
Smarty
$template)
|
|
Assigns the layers interface output in the general Cartoclient template.
Tags:
method saveSession [line 1609]
Saves layers data in session.
Tags:
method setOutofScaleIcon [line 1186]
Substitutes out-of-scale icons if current scale is out of the layer range of scales.
Tags:
Parameters:
method setSwitch [line 611]
void setSwitch(
string
$newSwitch)
|
|
Changes switch from another plugin
Tags:
Parameters:
Class Constants
|