The base class for all value objects and structs.
Supports read-only properties by marking them as protected.
In this case they will only be writable using constructor, and need to be documented
using @property-read <type> <$var> annotation in class doc in addition to inline property doc.
Writable properties must be public and must be documented inline.
Methods¶
                 __construct()
            ¶
__construct()
            ¶
    
        Construct object optionally with a set of 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 | 
|---|---|---|---|
| $user | User | - | - | 
| $company | Company | - | - | 
| $role | Role | - | - | 
                 getCompany()
            ¶
getCompany()
            ¶
    
        |  |  | 
Return values
                 getContentType()
            ¶
getContentType()
            ¶
    
        |  |  | 
Return values
                 getDefaultLanguageCode()
            ¶
getDefaultLanguageCode()
            ¶
    
        |  |  | 
Return values
string
                 getField()
            ¶
getField()
            ¶
    
        |  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $fieldDefIdentifier | string | - | - | 
| $languageCode | string|null | null | - | 
Return values
Field|null
                 getFields()
            ¶
getFields()
            ¶
    
        |  |  | 
Return values
array<string|int, Field>
                 getFieldsByLanguage()
            ¶
getFieldsByLanguage()
            ¶
    
        |  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $languageCode | string|null | null | - | 
Return values
array<string|int, Field>
                 getFieldValue()
            ¶
getFieldValue()
            ¶
    
        |  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $fieldDefIdentifier | string | - | - | 
| $languageCode | string|null | null | - | 
Return values
Value|null
                 getId()
            ¶
getId()
            ¶
    
        |  |  | 
Return values
int
                 getName()
            ¶
getName()
            ¶
    
        |  |  | 
Return values
string|null
                 getRole()
            ¶
getRole()
            ¶
    
        |  |  | 
Return values
                 getThumbnail()
            ¶
getThumbnail()
            ¶
    
        |  |  | 
Return values
Thumbnail|null
                 getUser()
            ¶
getUser()
            ¶
    
        |  |  | 
Return values
                 getVersionInfo()
            ¶
getVersionInfo()
            ¶
    
        |  |  | 
Return values
                 getProperties()
            ¶
getProperties()
            ¶
    
        Returns list of available properties' names.
|  |  | 
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>