Copied!

FieldDefinitionUpdateStruct

FieldDefinitionUpdateStruct.php : 16
Extends ValueObject

this class is used to update a field definition.

Properties

public $defaultValue

FieldDefinitionUpdateStruct.php : 86

If set the default value for this field is changed to the given value.

public mixed $defaultValue = null

public $descriptions

FieldDefinitionUpdateStruct.php : 37

If set this array of descriptions with languageCode keys replace the complete description collection.

public array<string, mixed>|null $descriptions = null

public $fieldGroup

FieldDefinitionUpdateStruct.php : 42

If set the field group is changed to this name.

public string|null $fieldGroup = null

public $fieldSettings

FieldDefinitionUpdateStruct.php : 81

If set this settings supported by the field type replaces the existing ones.

public array<string, mixed>|null $fieldSettings = null

public $identifier

FieldDefinitionUpdateStruct.php : 23

If set the identifier of a field definition is changed to this value.

public string|null $identifier = null

Needs to be unique within the context of the content type this is added to.

public $isInfoCollector

FieldDefinitionUpdateStruct.php : 67

If set the information collector flag is set to this value.

public bool|null $isInfoCollector = null

public $isRequired

FieldDefinitionUpdateStruct.php : 57

If set the required flag is set to this value.

public bool|null $isRequired = null

public $isSearchable

FieldDefinitionUpdateStruct.php : 91

If set the searchable flag is set to this value.

public bool|null $isSearchable = null

public $isThumbnail

FieldDefinitionUpdateStruct.php : 62

Indicates if the field can be a thumbnail.

public bool|null $isThumbnail = null

public $isTranslatable

FieldDefinitionUpdateStruct.php : 52

If set translatable flag is set to this value.

public bool|null $isTranslatable = null

public $names

FieldDefinitionUpdateStruct.php : 30

If set this array of names with languageCode keys replace the complete name collection.

public array<string, string>|null $names = null

public $position

FieldDefinitionUpdateStruct.php : 47

If set the position of the field in the content type.

public int|null $position = null

public $validatorConfiguration

FieldDefinitionUpdateStruct.php : 74

If set this validator configuration supported by the field type replaces the existing one.

public array<string, mixed>|null $validatorConfiguration = null

Methods

public__construct()

ValueObject.php : 32

Construct object optionally with a set of properties.

public __construct([array<string, mixed> $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> [] -

protectedgetProperties()

ValueObject.php : 53

Returns list of available properties' names.

protected getProperties([array<int, string> $dynamicProperties = [] ]) : array<int, string>

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>

Attributes
#[Ignore]