FieldDefinition

FieldDefinition.php : 33 Copy path

Extends ValueObject

Implements MultiLanguageName, MultiLanguageDescription

This class represents a field definition.

Properties¶

$defaultValue read-only ¶

FieldDefinition.php Copy path

public mixed $defaultValue

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getDefaultValue() instead.

$fieldGroup read-only ¶

FieldDefinition.php Copy path

public string $fieldGroup

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getFieldGroup() instead.

$fieldSettings read-only ¶

FieldDefinition.php Copy path

public array<string|int, mixed> $fieldSettings

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getFieldSettings() instead.

$fieldTypeIdentifier read-only ¶

FieldDefinition.php Copy path

public string $fieldTypeIdentifier

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getFieldTypeIdentifier() instead.

$id read-only ¶

FieldDefinition.php Copy path

public int $id

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getId() instead.

$identifier read-only ¶

FieldDefinition.php Copy path

public string $identifier

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getIdentifier() instead.

$isInfoCollector read-only ¶

FieldDefinition.php Copy path

public bool $isInfoCollector

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::$isInfoCollector() instead.

$isRequired read-only ¶

FieldDefinition.php Copy path

public bool $isRequired

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::$isRequired() instead.

$isSearchable read-only ¶

FieldDefinition.php Copy path

public bool $isSearchable

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getIdentifier() instead.

$isThumbnail read-only ¶

FieldDefinition.php Copy path

public bool $isThumbnail

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::isThumbnail() instead.

$isTranslatable read-only ¶

FieldDefinition.php Copy path

public bool $isTranslatable

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::$isTranslatable() instead.

$mainLanguageCode read-only ¶

FieldDefinition.php Copy path

public string $mainLanguageCode

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getMainLanguageCode() instead.

$position read-only ¶

FieldDefinition.php Copy path

public int $position

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getPosition() instead.

$validatorConfiguration read-only ¶

FieldDefinition.php Copy path

public array<string|int, mixed> $validatorConfiguration

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getValidatorConfiguration() instead.

$defaultValue ¶

FieldDefinition.php : 117 Copy path

Default value of the field.

protected mixed $defaultValue

$fieldGroup ¶

FieldDefinition.php : 54 Copy path

Field group name.

protected string $fieldGroup

$fieldTypeIdentifier ¶

FieldDefinition.php : 68 Copy path

String identifier of the field type.

protected string $fieldTypeIdentifier

$id ¶

FieldDefinition.php : 40 Copy path

the unique id of this field definition.

protected int $id

$identifier ¶

FieldDefinition.php : 47 Copy path

Readable string identifier of a field definition.

protected string $identifier

$isInfoCollector ¶

FieldDefinition.php : 96 Copy path

the flag if this field is used for information collection.

protected bool $isInfoCollector

$isRequired ¶

FieldDefinition.php : 89 Copy path

Is the field required.

protected bool $isRequired

$isSearchable ¶

FieldDefinition.php : 124 Copy path

Indicates if th the content is searchable by this attribute.

protected bool $isSearchable

$isThumbnail ¶

FieldDefinition.php : 82 Copy path

Indicates if the field can be a thumbnail.

protected bool $isThumbnail

$isTranslatable ¶

FieldDefinition.php : 75 Copy path

If the field is translatable.

protected bool $isTranslatable

$mainLanguageCode ¶

FieldDefinition.php : 131 Copy path

Based on mainLanguageCode of contentType.

protected string $mainLanguageCode

$position ¶

FieldDefinition.php : 61 Copy path

the position of the field definition in the content type.

protected int $position

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>	[]	-

getDefaultValue() ¶

FieldDefinition.php : 166 Copy path

public getDefaultValue() : mixed

getFieldGroup() ¶

FieldDefinition.php : 138 Copy path

public getFieldGroup() : string

Return values

string

getFieldSettings() ¶

FieldDefinition.php : 110 Copy path

This method returns settings for the field definition supported by the field type.

public abstract getFieldSettings() : array<string|int, mixed>

Return values

array<string|int, mixed>

getFieldTypeIdentifier() ¶

FieldDefinition.php : 191 Copy path

public getFieldTypeIdentifier() : string

Return values

string

getId() ¶

FieldDefinition.php : 133 Copy path

public getId() : int

Return values

int

getIdentifier() ¶

FieldDefinition.php : 186 Copy path

public getIdentifier() : string

Return values

string

getMainLanguageCode() ¶

FieldDefinition.php : 176 Copy path

public getMainLanguageCode() : string

Return values

string

getPosition() ¶

FieldDefinition.php : 143 Copy path

public getPosition() : int

Return values

int

getValidatorConfiguration() ¶

FieldDefinition.php : 103 Copy path

This method returns the validator configuration of this field definition supported by the field type.

public abstract getValidatorConfiguration() : array<string|int, mixed>

Return values

array<string|int, mixed>

isInfoCollector() ¶

FieldDefinition.php : 158 Copy path

public isInfoCollector() : bool

Return values

bool

isRequired() ¶

FieldDefinition.php : 153 Copy path

public isRequired() : bool

Return values

bool

isSearchable() ¶

FieldDefinition.php : 171 Copy path

public isSearchable() : bool

Return values

bool

isThumbnail() ¶

FieldDefinition.php : 181 Copy path

public isThumbnail() : bool

Return values

bool

isTranslatable() ¶

FieldDefinition.php : 148 Copy path

public isTranslatable() : bool

Return values

bool

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>