RelationReferenceConfig
extends BaseQgisObject
in package
QGIS Vector layer edit widget RelationReference config <editWidget type="RelationReference"> <config> <Option type="Map"> <Option type="bool" value="false" name="AllowAddFeatures"/> <Option type="bool" value="true" name="AllowNULL"/> <Option type="bool" value="false" name="MapIdentification"/> <Option type="bool" value="false" name="OrderByValue"/> <Option type="bool" value="false" name="ReadOnly"/> <Option type="QString" value="service=lizmap sslmode=disable key=\'fid\' checkPrimaryKeyUnicity=\'0\' table="lizmap_data"."risque"" name="ReferencedLayerDataSource"/> <Option type="QString" value="risque_66cb8d43_86b7_4583_9217_f7ead54463c3" name="ReferencedLayerId"/> <Option type="QString" value="risque" name="ReferencedLayerName"/> <Option type="QString" value="postgres" name="ReferencedLayerProviderKey"/> <Option type="QString" value="tab_demand_risque_risque_66c_risque" name="Relation"/> <Option type="bool" value="false" name="ShowForm"/> <Option type="bool" value="true" name="ShowOpenFormButton"/> </Option> </config> </editWidget>.
Table of Contents
Properties
- $AllowAddFeatures : bool
- $AllowNULL : bool
- $MapIdentification : bool
- $OrderByValue : bool
- $ReadOnly : bool
- $ReferencedLayerDataSource : string
- $ReferencedLayerId : string
- $ReferencedLayerName : string
- $ReferencedLayerProviderKey : string
- $Relation : string
- $ShowForm : bool
- $ShowOpenFormButton : bool
- $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>
- jsonSerialize() : mixed
- arrayToData() : array<string|int, mixed>
- set() : void
Properties
$AllowAddFeatures
public
bool
$AllowAddFeatures
$AllowNULL
public
bool
$AllowNULL
$MapIdentification
public
bool
$MapIdentification
$OrderByValue
public
bool
$OrderByValue
$ReadOnly
public
bool
$ReadOnly
$ReferencedLayerDataSource
public
string
$ReferencedLayerDataSource
$ReferencedLayerId
public
string
$ReferencedLayerId
$ReferencedLayerName
public
string
$ReferencedLayerName
$ReferencedLayerProviderKey
public
string
$ReferencedLayerProviderKey
$Relation
public
string
$Relation
$ShowForm
public
bool
$ShowForm
$ShowOpenFormButton
public
bool
$ShowOpenFormButton
$defaultValues
protected
array<string|int, mixed>
$defaultValues
= array('OrderByValue' => true)
The default values for properties
$mandatoryProperties
protected
array<string|int, string>
$mandatoryProperties
= array()
The not null properties
$properties
protected
array<string|int, string>
$properties
= array(
'AllowAddFeatures',
'AllowNULL',
'MapIdentification',
'OrderByValue',
// TODO Remove when QGIS 3.32 will be the minimum version for allowing a QGIS project
'ReadOnly',
'ReferencedLayerDataSource',
'ReferencedLayerId',
'ReferencedLayerName',
'ReferencedLayerProviderKey',
'Relation',
'ShowForm',
'ShowOpenFormButton',
)
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>jsonSerialize()
public
jsonSerialize() : 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>