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()
¶
DiscountTranslationStruct.php
:
34
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 |
---|---|---|---|
$languageCode | string | - | - |
$name | string | - | - |
$description | string|null | - | - |
$label | string|null | - | - |
$labelDescription | string|null | - | - |
getDescription()
¶
DiscountTranslationStruct.php
:
79
|
|
Return values
string|null
getLabel()
¶
DiscountTranslationStruct.php
:
94
|
|
Return values
string|null
getLabelDescription()
¶
DiscountTranslationStruct.php
:
109
|
|
Return values
string|null
getLanguageCode()
¶
DiscountTranslationStruct.php
:
49
|
|
Return values
string
getName()
¶
DiscountTranslationStruct.php
:
64
|
|
Return values
string
setDescription()
¶
DiscountTranslationStruct.php
:
87
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$description | string|null | - | - |
Return values
$this
setLabel()
¶
DiscountTranslationStruct.php
:
102
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$label | string|null | - | - |
Return values
$this
setLabelDescription()
¶
DiscountTranslationStruct.php
:
117
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$labelDescription | string|null | - | - |
Return values
$this
setLanguageCode()
¶
DiscountTranslationStruct.php
:
57
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$languageCode | string | - | - |
Return values
$this
setName()
¶
DiscountTranslationStruct.php
:
72
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$name | string | - | - |
Return values
$this
getProperties()
¶
ValueObject.php
:
54
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>