MapLayer
extends BaseQgisXmlObject
in package
QGIS Map layer.
Table of Contents
Properties
- $abstract : null|string
- $datasource : string
- $embedded : bool
- $id : string
- $keywordList : null|array<string|int, string>
- $layername : string
- $layerOpacity : float
- $provider : string
- $shortname : null|string
- $srs : SpatialRefSys
- $styleManager : MapLayerStyleManager
- $title : null|string
- $type : string
- $childParsers : mixed
- $children : array<string|int, string>
- $childrenCollection : array<string, string>
- $defaultValues : array<string|int, mixed>
- $mandatoryChildren : array<string|int, string>
- $mandatoryProperties : array<string|int, string>
- $properties : array<string|int, string>
- $qgisLocalName : string
- $data : array<string|int, mixed>
Methods
- __construct() : mixed
- Base QGIS object constructor.
- __get() : mixed
- __isset() : bool
- __set() : void
- __unset() : void
- fromXmlReader() : BaseQgisObject
- Get an QGIS object instance from an XMLReader instance at an element.
- getData() : array<string|int, mixed>
- getLayerOpacity() : float
- Get layer opacity.
- jsonSerialize() : mixed
- registerChildParser() : mixed
- toKeyArray() : array<string|int, mixed>
- Get map layer as key array.
- unRegisterChildParser() : mixed
- arrayToData() : array<string|int, mixed>
- buildInstance() : EmbeddedLayer|MapLayer|RasterLayer|VectorLayer
- Build an instance with data as an array.
- getAttributes() : array<string|int, mixed>
- Get attributes from an XMLReader instance at an element.
- parseChild() : mixed
- Parse from an XMLReader instance at a child of an element.
- set() : void
Properties
$abstract
public
null|string
$abstract
$datasource
public
string
$datasource
$embedded
public
bool
$embedded
$id
public
string
$id
$keywordList
public
null|array<string|int, string>
$keywordList
$layername
public
string
$layername
$layerOpacity
public
float
$layerOpacity
$provider
public
string
$provider
$shortname
public
null|string
$shortname
$srs
public
SpatialRefSys
$srs
$styleManager
public
MapLayerStyleManager
$styleManager
$title
public
null|string
$title
$type
public
string
$type
$childParsers
protected
static mixed
$childParsers
= array()
$children
protected
static array<string|int, string>
$children
= array('id', 'layername', 'shortname', 'title', 'abstract', 'srs', 'datasource', 'provider', 'keywordList', 'previewExpression', 'layerOpacity')
The XML element parsed children
$childrenCollection
protected
static array<string, string>
$childrenCollection
= array()
The XML element tagname associated with a collector property name
$defaultValues
protected
array<string|int, mixed>
$defaultValues
= array('layerOpacity' => 1)
The default values for properties
$mandatoryChildren
protected
static array<string|int, string>
$mandatoryChildren
= array()
The XML element needed children
$mandatoryProperties
protected
array<string|int, string>
$mandatoryProperties
= array('id', 'embedded', 'type', 'layername', 'srs', 'datasource', 'provider', 'styleManager')
The not null properties
$properties
protected
array<string|int, string>
$properties
= array('id', 'embedded', 'type', 'layername', 'srs', 'datasource', 'provider', 'styleManager', 'shortname', 'title', 'abstract', 'keywordList', 'layerOpacity')
The instance properties
$qgisLocalName
protected
static string
$qgisLocalName
= 'maplayer'
The XML element local name
$data
private
array<string|int, mixed>
$data
= array()
The instance data for properties
Methods
__construct()
Base QGIS object constructor.
public
__construct(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
-
the instance data
__get()
public
__get(mixed $property) : mixed
Parameters
- $property : mixed
__isset()
public
__isset(mixed $property) : bool
Parameters
- $property : mixed
Return values
bool__set()
public
final __set(string $key, mixed $val) : void
Parameters
- $key : string
- $val : mixed
__unset()
public
final __unset(string $key) : void
Parameters
- $key : string
fromXmlReader()
Get an QGIS object instance from an XMLReader instance at an element.
public
static fromXmlReader(XMLReader $oXmlReader) : BaseQgisObject
Parameters
- $oXmlReader : XMLReader
-
An XMLReader instance at an element
Return values
BaseQgisObject —the QGIS object instance corresponding to the element
getData()
public
getData() : array<string|int, mixed>
Return values
array<string|int, mixed>getLayerOpacity()
Get layer opacity.
public
getLayerOpacity() : float
Return values
floatjsonSerialize()
public
jsonSerialize() : mixed
registerChildParser()
public
static registerChildParser(mixed $localName, mixed $parser) : mixed
Parameters
- $localName : mixed
- $parser : mixed
toKeyArray()
Get map layer as key array.
public
toKeyArray() : array<string|int, mixed>
Return values
array<string|int, mixed>unRegisterChildParser()
public
static unRegisterChildParser(mixed $localName, mixed $parser) : mixed
Parameters
- $localName : mixed
- $parser : mixed
arrayToData()
protected
arrayToData(mixed $vArray) : array<string|int, mixed>
Parameters
- $vArray : mixed
Return values
array<string|int, mixed>buildInstance()
Build an instance with data as an array.
protected
static buildInstance(array<string|int, mixed> $data) : EmbeddedLayer|MapLayer|RasterLayer|VectorLayer
Parameters
- $data : array<string|int, mixed>
-
the instance data
Return values
EmbeddedLayer|MapLayer|RasterLayer|VectorLayer —the instance
getAttributes()
Get attributes from an XMLReader instance at an element.
protected
static getAttributes(mixed $oXmlReader) : array<string|int, mixed>
Parameters
- $oXmlReader : mixed
-
An XMLReader instance at an element
Return values
array<string|int, mixed> —the element attributes as keys / values
parseChild()
Parse from an XMLReader instance at a child of an element.
protected
static parseChild(XMLReader $oXmlReader) : mixed
Parameters
- $oXmlReader : XMLReader
-
An XMLReader instance at a child of an element
Return values
mixed —the result of the parsing
set()
protected
set(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>