FieldDefinitionUpdateStruct

FieldDefinitionUpdateStruct.php : 16 Copy path

Extends ValueObject

this class is used to update a field definition.

Properties¶

$defaultValue ¶

FieldDefinitionUpdateStruct.php : 102 Copy path

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

public mixed $defaultValue

$descriptions ¶

FieldDefinitionUpdateStruct.php : 39 Copy path

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

public array<string|int, mixed> $descriptions

an array of string

$fieldGroup ¶

FieldDefinitionUpdateStruct.php : 46 Copy path

If set the field group is changed to this name.

public string $fieldGroup

$fieldSettings ¶

FieldDefinitionUpdateStruct.php : 95 Copy path

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

public mixed $fieldSettings

$identifier ¶

FieldDefinitionUpdateStruct.php : 25 Copy path

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

public string $identifier

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

$isInfoCollector ¶

FieldDefinitionUpdateStruct.php : 81 Copy path

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

public bool $isInfoCollector

$isRequired ¶

FieldDefinitionUpdateStruct.php : 67 Copy path

If set the required flag is set to this value.

public bool $isRequired

$isSearchable ¶

FieldDefinitionUpdateStruct.php : 109 Copy path

If set the the searchable flag is set to this value.

public bool $isSearchable

$isThumbnail ¶

FieldDefinitionUpdateStruct.php : 74 Copy path

Indicates if the field can be a thumbnail.

public bool $isThumbnail

$isTranslatable ¶

FieldDefinitionUpdateStruct.php : 60 Copy path

If set translatable flag is set to this value.

public bool $isTranslatable

$names ¶

FieldDefinitionUpdateStruct.php : 32 Copy path

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

public array<string|int, mixed> $names

an array of string

$position ¶

FieldDefinitionUpdateStruct.php : 53 Copy path

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

public int $position

$validatorConfiguration ¶

FieldDefinitionUpdateStruct.php : 88 Copy path

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

public mixed $validatorConfiguration

Methods¶

__construct() ¶

ValueObject.php : 30 Copy path

Construct object optionally with a set of properties.

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

ValueObject.php : 50 Copy path

Function where list of properties are returned.

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

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>