VectorLayer
extends BaseQgisObject
in package
QGIS Vector layer.
Table of Contents
Properties
- $abstract : null|string
- $aliases : array<string|int, VectorLayerAlias>
- $attributetableconfig : AttributeTableConfig
- $constraintExpressions : array<string|int, VectorLayerConstraintExpression>
- $constraints : array<string|int, VectorLayerConstraint>
- $datasource : string
- $defaults : array<string|int, VectorLayerDefault>
- $editable : array<string|int, VectorLayerEditableField>
- $embedded : bool
- $excludeAttributesWFS : null|array<string|int, string>
- $excludeAttributesWMS : null|array<string|int, string>
- $fieldConfiguration : array<string|int, VectorLayerField>
- $id : string
- $keywordList : null|array<string|int, string>
- $layername : string
- $layerOpacity : float
- $previewExpression : null|string
- $provider : string
- $rendererV2 : null|RendererV2
- $shortname : null|string
- $srs : SpatialRefSys
- $styleManager : MapLayerStyleManager
- $styleManager : MapLayerStyleManager
- $title : null|string
- $type : string
- $vectorjoins : array<string|int, VectorLayerJoin>
- $defaultValues : array<string|int, mixed>
- $mandatoryProperties : array<string|int, string>
- $optionTypes : array<string, 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>
- getFieldAlias() : null|string
- Get field alias.
- getFieldEditable() : bool
- Get field editable.
- getFormControls() : array<string|int, QgisFormControlProperties>
- Get form controls.
- getLayerOpacity() : float
- Get layer opacity.
- getPreviewField() : string
- Get preview field.
- jsonSerialize() : mixed
- toKeyArray() : array<string|int, mixed>
- Get vector layer as key array.
- arrayToData() : array<string|int, mixed>
- convertTypeOptions() : mixed
- Update options value by converting them.
- getMarkup() : string
- Get the HTML markup.
- readUploadOptions() : mixed
- Update upload config options.
- readWebDavStorageOptions() : mixed
- update the upload options with the property 'webDAVStorageUrl'.
- set() : void
Properties
$abstract
public
null|string
$abstract
$aliases
public
array<string|int, VectorLayerAlias>
$aliases
$attributetableconfig
public
AttributeTableConfig
$attributetableconfig
$constraintExpressions
public
array<string|int, VectorLayerConstraintExpression>
$constraintExpressions
$constraints
public
array<string|int, VectorLayerConstraint>
$constraints
$datasource
public
string
$datasource
$defaults
public
array<string|int, VectorLayerDefault>
$defaults
$editable
public
array<string|int, VectorLayerEditableField>
$editable
$embedded
public
bool
$embedded
$excludeAttributesWFS
public
null|array<string|int, string>
$excludeAttributesWFS
$excludeAttributesWMS
public
null|array<string|int, string>
$excludeAttributesWMS
$fieldConfiguration
public
array<string|int, VectorLayerField>
$fieldConfiguration
$id
public
string
$id
$keywordList
public
null|array<string|int, string>
$keywordList
$layername
public
string
$layername
$layerOpacity
public
float
$layerOpacity
$previewExpression
public
null|string
$previewExpression
$provider
public
string
$provider
$rendererV2
public
null|RendererV2
$rendererV2
$shortname
public
null|string
$shortname
$srs
public
SpatialRefSys
$srs
$styleManager
public
MapLayerStyleManager
$styleManager
$styleManager
public
MapLayerStyleManager
$styleManager
$title
public
null|string
$title
$type
public
string
$type
$vectorjoins
public
array<string|int, VectorLayerJoin>
$vectorjoins
$defaultValues
protected
array<string|int, mixed>
$defaultValues
= array('layerOpacity' => 1)
The default values for properties
$mandatoryProperties
protected
array<string|int, string>
$mandatoryProperties
= array('id', 'embedded', 'type', 'layername', 'srs', 'datasource', 'provider', 'styleManager')
The not null properties
$optionTypes
protected
static array<string, string>
$optionTypes
= array('Min' => 'f', 'Max' => 'f', 'Step' => 'i', 'Precision' => 'i', 'AllowMulti' => 'b', 'AllowNull' => 'b', 'UseCompleter' => 'b', 'DocumentViewer' => 'b', 'fieldEditable' => 'b', 'editable' => 'b', 'Editable' => 'b', 'notNull' => 'b', 'MapIdentification' => 'b', 'IsMultiline' => 'b', 'UseHtml' => 'b', 'field_iso_format' => 'b')
The options type
$properties
protected
array<string|int, string>
$properties
= array('id', 'embedded', 'type', 'layername', 'srs', 'datasource', 'provider', 'styleManager', 'shortname', 'title', 'abstract', 'keywordList', 'previewExpression', 'layerOpacity', 'fieldConfiguration', 'aliases', 'defaults', 'constraints', 'constraintExpressions', 'editable', 'excludeAttributesWFS', 'excludeAttributesWMS', 'attributetableconfig', 'vectorjoins', 'rendererV2')
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>getFieldAlias()
Get field alias.
public
getFieldAlias(mixed $fieldName) : null|string
Parameters
- $fieldName : mixed
Return values
null|stringgetFieldEditable()
Get field editable.
public
getFieldEditable(mixed $fieldName) : bool
Parameters
- $fieldName : mixed
Return values
boolgetFormControls()
Get form controls.
public
getFormControls() : array<string|int, QgisFormControlProperties>
Return values
array<string|int, QgisFormControlProperties>getLayerOpacity()
Get layer opacity.
public
getLayerOpacity() : float
Return values
floatgetPreviewField()
Get preview field.
public
getPreviewField() : string
Return values
stringjsonSerialize()
public
jsonSerialize() : mixed
toKeyArray()
Get vector 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>convertTypeOptions()
Update options value by converting them.
protected
convertTypeOptions(array<string|int, mixed> &$options) : mixed
Parameters
- $options : array<string|int, mixed>
getMarkup()
Get the HTML markup.
protected
getMarkup(string $fieldEditType, array<string|int, mixed> $fieldEditOptions) : string
Parameters
- $fieldEditType : string
-
Field edit type
- $fieldEditOptions : array<string|int, mixed>
-
Field edit config options
Return values
string —The HTML markup corresponding to field edit type and config options
readUploadOptions()
Update upload config options.
protected
readUploadOptions(string $fieldEditType, array<string|int, mixed> &$fieldEditOptions) : mixed
Parameters
- $fieldEditType : string
-
Field edit type
- $fieldEditOptions : array<string|int, mixed>
-
Field edit config options
readWebDavStorageOptions()
update the upload options with the property 'webDAVStorageUrl'.
protected
readWebDavStorageOptions(array<string|int, mixed> &$fieldEditOptions) : mixed
Parameters
- $fieldEditOptions : array<string|int, mixed>
set()
protected
set(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>