Copied!

FieldDefinition

FieldDefinition.php : 33
Abstract
Extends ValueObject
Implements MultiLanguageName, MultiLanguageDescription

This class represents a field definition.

Properties

public $defaultValue read-only

FieldDefinition.php 
public mixed $defaultValue

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

protected $defaultValue

FieldDefinition.php : 117

Default value of the field.

 
protected mixed $defaultValue

public $fieldGroup read-only

FieldDefinition.php 
public string $fieldGroup

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

protected $fieldGroup

FieldDefinition.php : 54

Field group name.

 
protected string $fieldGroup

public $fieldSettings read-only

FieldDefinition.php 
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.

public $fieldTypeIdentifier read-only

FieldDefinition.php 
public string $fieldTypeIdentifier

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

protected $fieldTypeIdentifier

FieldDefinition.php : 68

String identifier of the field type.

 
protected string $fieldTypeIdentifier

public $id read-only

FieldDefinition.php 
public int $id

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

protected $id

FieldDefinition.php : 40

the unique id of this field definition.

 
protected int $id

public $identifier read-only

FieldDefinition.php 
public string $identifier

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

protected $identifier

FieldDefinition.php : 47

Readable string identifier of a field definition.

 
protected string $identifier

public $isInfoCollector read-only

FieldDefinition.php 
public bool $isInfoCollector

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

protected $isInfoCollector

FieldDefinition.php : 96

the flag if this field is used for information collection.

 
protected bool $isInfoCollector

public $isRequired read-only

FieldDefinition.php 
public bool $isRequired

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

protected $isRequired

FieldDefinition.php : 89

Is the field required.

 
protected bool $isRequired

public $isSearchable read-only

FieldDefinition.php 
public bool $isSearchable

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

protected $isSearchable

FieldDefinition.php : 124

Indicates if th the content is searchable by this attribute.

 
protected bool $isSearchable

public $isThumbnail read-only

FieldDefinition.php 
public bool $isThumbnail

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

protected $isThumbnail

FieldDefinition.php : 82

Indicates if the field can be a thumbnail.

 
protected bool $isThumbnail

public $isTranslatable read-only

FieldDefinition.php 
public bool $isTranslatable

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

protected $isTranslatable

FieldDefinition.php : 75

If the field is translatable.

 
protected bool $isTranslatable

public $mainLanguageCode read-only

FieldDefinition.php 
public string $mainLanguageCode

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

protected $mainLanguageCode

FieldDefinition.php : 131

Based on mainLanguageCode of contentType.

 
protected string $mainLanguageCode

public $position read-only

FieldDefinition.php 
public int $position

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

protected $position

FieldDefinition.php : 61

the position of the field definition in the content type.

 
protected int $position

public $validatorConfiguration read-only

FieldDefinition.php 
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.

Methods

public__construct()

ValueObject.php : 31

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

publicgetDefaultValue()

FieldDefinition.php : 166 
public getDefaultValue() : mixed

publicgetFieldGroup()

FieldDefinition.php : 138 
public getFieldGroup() : string

Return values

string

publicgetFieldSettings()

FieldDefinition.php : 110

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>

publicgetFieldTypeIdentifier()

FieldDefinition.php : 191 
public getFieldTypeIdentifier() : string

Return values

string

publicgetId()

FieldDefinition.php : 133 
public getId() : int

Return values

int

publicgetIdentifier()

FieldDefinition.php : 186 
public getIdentifier() : string

Return values

string

publicgetMainLanguageCode()

FieldDefinition.php : 176 
public getMainLanguageCode() : string

Return values

string

publicgetPosition()

FieldDefinition.php : 143 
public getPosition() : int

Return values

int

publicgetValidatorConfiguration()

FieldDefinition.php : 103

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>

publicisInfoCollector()

FieldDefinition.php : 158 
public isInfoCollector() : bool

Return values

bool

publicisRequired()

FieldDefinition.php : 153 
public isRequired() : bool

Return values

bool

publicisSearchable()

FieldDefinition.php : 171 
public isSearchable() : bool

Return values

bool

publicisThumbnail()

FieldDefinition.php : 181 
public isThumbnail() : bool

Return values

bool

publicisTranslatable()

FieldDefinition.php : 148 
public isTranslatable() : bool

Return values

bool

protectedgetProperties()

ValueObject.php : 54

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>

Tags
Serializerignore

()