FieldDefinition
This class represents a field definition.
Properties¶
$defaultValue¶
|
|
@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getDefaultValue() instead.
$fieldGroup¶
|
|
@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getFieldGroup() instead.
$fieldSettings¶
|
|
@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getFieldSettings() instead.
$fieldTypeIdentifier¶
|
|
@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getFieldTypeIdentifier() instead.
$id¶
|
|
@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getId() instead.
$identifier¶
|
|
@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getIdentifier() instead.
$isInfoCollector¶
|
|
@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::$isInfoCollector() instead.
$isRequired¶
|
|
@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::$isRequired() instead.
$isSearchable¶
|
|
@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getIdentifier() instead.
$isThumbnail¶
|
|
@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::isThumbnail() instead.
$isTranslatable¶
|
|
@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::$isTranslatable() instead.
$mainLanguageCode¶
|
|
@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getMainLanguageCode() instead.
$position¶
|
|
@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getPosition() instead.
$validatorConfiguration¶
|
|
@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use FieldDefinition::getValidatorConfiguration() instead.
$defaultValue¶
Default value of the field.
|
|
$fieldGroup¶
Field group name.
|
|
$fieldTypeIdentifier¶
String identifier of the field type.
|
|
$id¶
the unique id of this field definition.
|
|
$identifier¶
Readable string identifier of a field definition.
|
|
$isInfoCollector¶
the flag if this field is used for information collection.
|
|
$isRequired¶
Is the field required.
|
|
$isSearchable¶
Indicates if th the content is searchable by this attribute.
|
|
$isThumbnail¶
Indicates if the field can be a thumbnail.
|
|
$isTranslatable¶
If the field is translatable.
|
|
$mainLanguageCode¶
Based on mainLanguageCode of contentType.
|
|
$position¶
the position of the field definition in the content type.
|
|
Methods¶
__construct() ¶
Construct object optionally with a set of 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() ¶
|
|
getFieldGroup() ¶
|
|
Return values
string
getFieldSettings() ¶
This method returns settings for the field definition supported by the field type.
|
|
Return values
array<string|int, mixed>
getFieldTypeIdentifier() ¶
|
|
Return values
string
getId() ¶
|
|
Return values
int
getIdentifier() ¶
|
|
Return values
string
getMainLanguageCode() ¶
|
|
Return values
string
getPosition() ¶
|
|
Return values
int
getValidatorConfiguration() ¶
This method returns the validator configuration of this field definition supported by the field type.
|
|
Return values
array<string|int, mixed>
isInfoCollector() ¶
|
|
Return values
bool
isRequired() ¶
|
|
Return values
bool
isSearchable() ¶
|
|
Return values
bool
isThumbnail() ¶
|
|
Return values
bool
isTranslatable() ¶
|
|
Return values
bool
getProperties() ¶
Function where list of properties are returned.
|
|
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>