The base class for all value objects and structs.
Supports readonly properties by marking them as protected.
In this case they will only be writable using constructor, and need to be documented
using property-read <$var> annotation in class doc in addition to inline property doc.
Writable properties must be public and must be documented inline.
Methods
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 |
$user
|
User
|
-
|
-
|
$company
|
Company
|
-
|
-
|
$role
|
Role
|
-
|
-
|
Return values
Company
Return values
ContentType
|
public getDefaultLanguageCode() : string
|
Return values
string
|
public getField(string $fieldDefIdentifier[, string|null $languageCode = null ]) : Field|null
|
Parameters
Name |
Type |
Default value |
Description |
$fieldDefIdentifier
|
string
|
-
|
-
|
$languageCode
|
string|null
|
null
|
-
|
Return values
Field|null
|
public getFields() : array<string|int, Field>
|
Return values
array<string|int, Field>
|
public getFieldsByLanguage([string|null $languageCode = null ]) : array<string|int, Field>
|
Parameters
Name |
Type |
Default value |
Description |
$languageCode
|
string|null
|
null
|
-
|
Return values
array<string|int, Field>
|
public getFieldValue(string $fieldDefIdentifier[, string|null $languageCode = null ]) : Value|null
|
Parameters
Name |
Type |
Default value |
Description |
$fieldDefIdentifier
|
string
|
-
|
-
|
$languageCode
|
string|null
|
null
|
-
|
Return values
Value|null
Return values
int
|
public getName() : string|null
|
Return values
string|null
Return values
Role
Return values
Thumbnail|null
Return values
User
Return values
VersionInfo
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>