Base SPI Value object.
Properties¶
$defaultValue
¶
FieldDefinition.php
:
111
Default value of the field.
|
|
|
$description
¶
FieldDefinition.php
:
38
Description.
|
|
|
$fieldGroup
¶
FieldDefinition.php
:
52
Field group name.
|
|
|
$fieldType
¶
FieldDefinition.php
:
66
String identifier of the field type.
|
|
|
$fieldTypeConstraints
¶
FieldDefinition.php
:
104
A map of field type constraints.
|
|
|
2 constraints are available (as keys):
- validators
- fieldSettings.
$id
¶
FieldDefinition.php
:
24
Primary key.
|
|
|
$identifier
¶
FieldDefinition.php
:
45
Readable string identifier of a field definition.
|
|
|
$isInfoCollector
¶
FieldDefinition.php
:
94
Just a flag.
|
|
|
$isRequired
¶
FieldDefinition.php
:
80
Is the field required.
|
|
|
$isSearchable
¶
FieldDefinition.php
:
118
|
|
|
Tags
$isThumbnail
¶
FieldDefinition.php
:
87
If the field type can be a thumbnail.
|
|
|
$isTranslatable
¶
FieldDefinition.php
:
73
If the field type is translatable.
|
|
|
$mainLanguageCode
¶
FieldDefinition.php
:
125
Based on mainLanguageCode of contentType.
|
|
|
$name
¶
FieldDefinition.php
:
31
Name.
|
|
|
$position
¶
FieldDefinition.php
:
59
Position.
|
|
|
Methods¶
__construct()
¶
FieldDefinition.php
:
130
Constructor.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $properties | array<string|int, mixed> | [] | - |
getProperties()
¶
ValueObject.php
:
50
Function where list of properties are returned.
|
|
|
Used by attributes(), override to add dynamic properties
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $dynamicProperties | array<string|int, mixed> | [] |
Additional dynamic properties exposed on the object |
Return values
array<string|int, mixed>