Field

Field.php : 22 Copy path

Extends ValueObject

This class represents a field of a content object.

Properties¶

$fieldDefIdentifier read-only ¶

Field.php

public string $fieldDefIdentifier

the field definition identifier

$fieldTypeIdentifier read-only ¶

Field.php

public string $fieldTypeIdentifier

field type identifier

$id read-only ¶

Field.php

public mixed $id

an internal id of the field

$languageCode read-only ¶

Field.php

public string $languageCode

the language code of the field

$value read-only ¶

Field.php

public mixed $value

the value of the field

$fieldDefIdentifier ¶

Field.php : 39 Copy path

The field definition identifier.

protected string $fieldDefIdentifier

$fieldTypeIdentifier ¶

Field.php : 60 Copy path

Field type identifier.

protected string $fieldTypeIdentifier

$id ¶

Field.php : 32 Copy path

The field id.

protected mixed $id

Value of null indicates the field is virtual and is not persisted (yet).

$languageCode ¶

Field.php : 53 Copy path

the language code.

protected string|null $languageCode

$value ¶

Field.php : 46 Copy path

A field type value or a value type which can be converted by the corresponding field type.

protected mixed $value

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

getFieldDefinitionIdentifier() ¶

Field.php : 67 Copy path

public getFieldDefinitionIdentifier() : string

Return values

string

getFieldTypeIdentifier() ¶

Field.php : 85 Copy path

public getFieldTypeIdentifier() : string

Return values

string

getId() ¶

Field.php : 62 Copy path

public getId() : int|null

Return values

int|null

getLanguageCode() ¶

Field.php : 80 Copy path

public getLanguageCode() : string|null

Return values

string|null

getValue() ¶

Field.php : 75 Copy path

public getValue() : mixed

isVirtual() ¶

Field.php : 93 Copy path

public isVirtual() : 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>