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()
¶
CustomerGroupUpdateStruct.php
:
53
Construct object optionally with a set of properties.
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$id | int | - | - |
$identifier | string|null | null | - |
$names | array<int, string> | [] | - |
$descriptions | array<int, string> | [] | - |
$globalPriceRate | numeric-string|null | null | - |
addDescription()
¶
CustomerGroupUpdateStruct.php
:
101
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$languageId | int | - | - |
$description | string | - | - |
addName()
¶
CustomerGroupUpdateStruct.php
:
88
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$languageId | int | - | - |
$name | string | - | - |
getDescription()
¶
CustomerGroupUpdateStruct.php
:
106
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$languageId | int | - | - |
Return values
string
getDescriptions()
¶
CustomerGroupUpdateStruct.php
:
114
|
|
Return values
array<int, string>
getGlobalPriceRate()
¶
CustomerGroupUpdateStruct.php
:
122
|
|
Return values
numeric-string|null
getId()
¶
CustomerGroupUpdateStruct.php
:
73
|
|
Return values
int
getIdentifier()
¶
CustomerGroupUpdateStruct.php
:
78
|
|
Return values
string|null
getName()
¶
CustomerGroupUpdateStruct.php
:
83
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$languageId | int | - | - |
Return values
string
getNames()
¶
CustomerGroupUpdateStruct.php
:
96
|
|
Return values
array<int, string>
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>