LayerTreeGroup
extends BaseQgisXmlObject
in package
QGIS Layer tree group.
Table of Contents
Properties
- $customproperties : array<string|int, mixed>
- $items : array<string|int, LayerTreeGroup|LayerTreeLayer>
- $mutuallyExclusive : bool
- $name : 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>
- getGroupShortNames() : array<string, string>
- Get group short names.
- getGroupsMutuallyExclusive() : array<string|int, string>
- Get groups mutually exclusive.
- getLayersShowFeatureCount() : array<string|int, string>
- Get layer show feature count.
- jsonSerialize() : mixed
- registerChildParser() : mixed
- unRegisterChildParser() : mixed
- arrayToData() : array<string|int, mixed>
- buildInstance() : BaseQgisXmlObject
- Build an instance with data as an array.
- getAttributes() : array{'name': string}
- 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
$customproperties
public
array<string|int, mixed>
$customproperties
$items
public
array<string|int, LayerTreeGroup|LayerTreeLayer>
$items
$mutuallyExclusive
public
bool
$mutuallyExclusive
$name
public
string
$name
$childParsers
protected
static mixed
$childParsers
= array()
$children
protected
static array<string|int, string>
$children
= array()
The XML element parsed children
$childrenCollection
protected
static array<string, string>
$childrenCollection
= array('layer-tree-group' => 'items', 'layer-tree-layer' => 'items')
The XML element tagname associated with a collector property name
$defaultValues
protected
array<string|int, mixed>
$defaultValues
= array()
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()
The not null properties
$properties
protected
array<string|int, string>
$properties
= array('name', 'mutuallyExclusive', 'customproperties', 'items')
The instance properties
$qgisLocalName
protected
static string
$qgisLocalName
= 'layer-tree-group'
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>getGroupShortNames()
Get group short names.
public
getGroupShortNames() : array<string, string>
Return values
array<string, string>getGroupsMutuallyExclusive()
Get groups mutually exclusive.
public
getGroupsMutuallyExclusive() : array<string|int, string>
Return values
array<string|int, string>getLayersShowFeatureCount()
Get layer show feature count.
public
getLayersShowFeatureCount() : array<string|int, string>
Return values
array<string|int, string>jsonSerialize()
public
jsonSerialize() : mixed
registerChildParser()
public
static registerChildParser(mixed $localName, mixed $parser) : mixed
Parameters
- $localName : mixed
- $parser : 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) : BaseQgisXmlObject
Parameters
- $data : array<string|int, mixed>
-
the instance data
Return values
BaseQgisXmlObject —the instance
getAttributes()
Get attributes from an XMLReader instance at an element.
protected
static getAttributes(XMLReader $oXmlReader) : array{'name': string}
Parameters
- $oXmlReader : XMLReader
-
An XMLReader instance at an element
Return values
array{'name': string} —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>