EmbeddedLayer
extends BaseQgisObject
in package
QGIS Embedded layer.
Table of Contents
Properties
- $embedded : bool
- $id : string
- $project : string
- $type : string
- $defaultValues : array<string|int, mixed>
- $mandatoryProperties : array<string|int, string>
- $properties : array<string|int, string>
- $data : array<string|int, mixed>
Methods
- __construct() : mixed
- Base QGIS object constructor.
- __get() : mixed
- __isset() : bool
- __set() : void
- __unset() : void
- getData() : array<string|int, mixed>
- getEmbeddedLayer() : null|MapLayer|RasterLayer|VectorLayer
- Get embedded layer from parent project path.
- getEmbeddedProject() : ProjectInfo
- Get embedded project from parent project path.
- getEmbeddedProjectFullPath() : string
- Get embedded project path relative from parent project path.
- jsonSerialize() : mixed
- toKeyArray() : array<string|int, mixed>
- Get embedded layer as key array.
- arrayToData() : array<string|int, mixed>
- set() : void
Properties
$embedded
public
bool
$embedded
$id
public
string
$id
$project
public
string
$project
$type
public
string
$type
$defaultValues
protected
array<string|int, mixed>
$defaultValues
= array()
The default values for properties
$mandatoryProperties
protected
array<string|int, string>
$mandatoryProperties
= array('id', 'embedded', 'project')
The not null properties
$properties
protected
array<string|int, string>
$properties
= array('id', 'embedded', 'type', 'project')
The instance properties
$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
getData()
public
getData() : array<string|int, mixed>
Return values
array<string|int, mixed>getEmbeddedLayer()
Get embedded layer from parent project path.
public
getEmbeddedLayer(string $parentProjectPath) : null|MapLayer|RasterLayer|VectorLayer
Parameters
- $parentProjectPath : string
-
The parent project path
Return values
null|MapLayer|RasterLayer|VectorLayer —The embedded layer
getEmbeddedProject()
Get embedded project from parent project path.
public
getEmbeddedProject(string $parentProjectPath) : ProjectInfo
Parameters
- $parentProjectPath : string
-
The parent project path
Return values
ProjectInfo —The embedded project
getEmbeddedProjectFullPath()
Get embedded project path relative from parent project path.
public
getEmbeddedProjectFullPath(string $parentProjectPath) : string
Parameters
- $parentProjectPath : string
-
The parent project path
Return values
string —The embedded project path
jsonSerialize()
public
jsonSerialize() : mixed
toKeyArray()
Get embedded layer as key array.
public
toKeyArray() : array<string|int, mixed>
Return values
array<string|int, mixed>arrayToData()
protected
arrayToData(mixed $vArray) : array<string|int, mixed>
Parameters
- $vArray : mixed
Return values
array<string|int, mixed>set()
protected
set(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>