FieldDefinitionCreateStruct

FieldDefinitionCreateStruct.php : 16 Copy path

Extends ValueObject

this class is used to create a field definition.

Properties¶

$defaultValue ¶

FieldDefinitionCreateStruct.php : 114 Copy path

Default value of the field.

public mixed $defaultValue

$descriptions ¶

FieldDefinitionCreateStruct.php : 50 Copy path

An array of descriptions with languageCode keys.

public array<string|int, mixed> $descriptions

an array of string

$fieldGroup ¶

FieldDefinitionCreateStruct.php : 57 Copy path

Field group name.

public string $fieldGroup

$fieldSettings ¶

FieldDefinitionCreateStruct.php : 107 Copy path

The settings supported by the field type.

public mixed $fieldSettings

$fieldTypeIdentifier ¶

FieldDefinitionCreateStruct.php : 25 Copy path

String identifier of the field type.

public string $fieldTypeIdentifier

Required.

$identifier ¶

FieldDefinitionCreateStruct.php : 36 Copy path

Readable string identifier of a field definition.

public string $identifier

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

Required.

$isInfoCollector ¶

FieldDefinitionCreateStruct.php : 93 Copy path

Indicates if this attribute is used for information collection.

public bool $isInfoCollector

$isRequired ¶

FieldDefinitionCreateStruct.php : 79 Copy path

Indicates if the field is required.

public bool $isRequired

$isSearchable ¶

FieldDefinitionCreateStruct.php : 121 Copy path

Indicates if th the content is searchable by this attribute.

public bool $isSearchable

$isThumbnail ¶

FieldDefinitionCreateStruct.php : 86 Copy path

Indicates if the field can be a thumbnail.

public bool $isThumbnail

$isTranslatable ¶

FieldDefinitionCreateStruct.php : 72 Copy path

Indicates if the field is translatable.

public bool $isTranslatable

$names ¶

FieldDefinitionCreateStruct.php : 43 Copy path

An array of names with languageCode keys.

public array<string|int, mixed> $names

an array of string

$position ¶

FieldDefinitionCreateStruct.php : 65 Copy path

The position of the field definition in the content type if not set the field is added at the end.

public int $position

$validatorConfiguration ¶

FieldDefinitionCreateStruct.php : 100 Copy path

The validator configuration supported by the field type.

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>