this class is used to create a field definition.
Properties¶
$defaultValue¶
Default value of the field.
|
|
$descriptions¶
An array of descriptions with languageCode keys.
|
|
an array of string
$fieldGroup¶
Field group name.
|
|
$fieldSettings¶
The settings supported by the field type.
|
|
$fieldTypeIdentifier¶
String identifier of the field type.
|
|
Required.
$identifier¶
Readable string identifier of a field definition.
|
|
Needs to be unique within the context of the content type this is added to.
Required.
$isInfoCollector¶
Indicates if this attribute is used for information collection.
|
|
$isRequired¶
Indicates if the field is required.
|
|
$isSearchable¶
Indicates if th the content is searchable by this attribute.
|
|
$isThumbnail¶
Indicates if the field can be a thumbnail.
|
|
$isTranslatable¶
Indicates if the field is translatable.
|
|
$names¶
An array of names with languageCode keys.
|
|
an array of string
$position¶
The position of the field definition in the content type if not set the field is added at the end.
|
|
$validatorConfiguration¶
The validator configuration supported by the field type.
|
|
Methods¶
__construct() ¶
Construct object optionally with a set of properties.
|
|
Readonly properties values must be set using $properties as they are not writable anymore after object has been created.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$properties | array<string|int, mixed> | [] | - |
getProperties() ¶
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>