Copied!

Field

Field.php : 22
Extends ValueObject

This class represents a field of a content object.

Properties

public $fieldDefIdentifier read-only

Field.php 
public string $fieldDefIdentifier

the field definition identifier

protected $fieldDefIdentifier

Field.php : 39

The field definition identifier.

 
protected string $fieldDefIdentifier

public $fieldTypeIdentifier read-only

Field.php 
public string $fieldTypeIdentifier

field type identifier

protected $fieldTypeIdentifier

Field.php : 60

Field type identifier.

 
protected string $fieldTypeIdentifier

public $id read-only

Field.php 
public mixed $id

an internal id of the field

protected $id

Field.php : 32

The field id.

 
protected mixed $id

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

public $languageCode read-only

Field.php 
public string $languageCode

the language code of the field

protected $languageCode

Field.php : 53

the language code.

 
protected string|null $languageCode

public $value read-only

Field.php 
public mixed $value

the value of the field

protected $value

Field.php : 46

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

 
protected mixed $value

Methods

public__construct()

ValueObject.php : 31

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

publicgetFieldDefinitionIdentifier()

Field.php : 67 
public getFieldDefinitionIdentifier() : string

Return values

string

publicgetFieldTypeIdentifier()

Field.php : 85 
public getFieldTypeIdentifier() : string

Return values

string

publicgetId()

Field.php : 62 
public getId() : int|null

Return values

int|null

publicgetLanguageCode()

Field.php : 80 
public getLanguageCode() : string|null

Return values

string|null

publicgetValue()

Field.php : 75 
public getValue() : mixed

publicisVirtual()

Field.php : 93 
public isVirtual() : bool

Return values

bool

protectedgetProperties()

ValueObject.php : 53

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>

Tags
Serializerignore

()