this class is used to update a field definition.
Properties¶
$defaultValue
¶
If set the default value for this field is changed to the given value.
|
|
|
$descriptions
¶
If set this array of descriptions with languageCode keys replace the complete description collection.
|
|
|
an array of string
$fieldGroup
¶
If set the field group is changed to this name.
|
|
|
$fieldSettings
¶
If set this settings supported by the field type replaces the existing ones.
|
|
|
$identifier
¶
If set the identifier of a field definition is changed to this value.
|
|
|
Needs to be unique within the context of the content type this is added to.
$isInfoCollector
¶
If set the information collector flag is set to this value.
|
|
|
$isRequired
¶
If set the required flag is set to this value.
|
|
|
$isSearchable
¶
If set the the searchable flag is set to this value.
|
|
|
$isThumbnail
¶
Indicates if the field can be a thumbnail.
|
|
|
$isTranslatable
¶
If set translatable flag is set to this value.
|
|
|
$names
¶
If set this array of names with languageCode keys replace the complete name collection.
|
|
|
an array of string
$position
¶
If set the position of the field in the content type.
|
|
|
$validatorConfiguration
¶
If set this validator configuration supported by the field type replaces the existing one.
|
|
|
Methods¶
__construct()
¶
Construct object optionally with a set of properties.
|
|
|
Readonly properties values must be set using $properties as they aren't writable anymore
after object has been created.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $properties | array<string, mixed> | [] | - |
getProperties()
¶
Returns list of available properties' names.
|
|
|
Override to add dynamic properties.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $dynamicProperties | array<int, string> | [] |
Additional dynamic properties exposed on the object |
Return values
array<int, string>