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()
¶
ShippingMethodUpdateStruct.php
:
43
Construct object optionally with a set of properties.
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$identifier | string|null | null | - |
$names | array<string, string> | [] | - |
$descriptions | array<string, string> | [] | - |
$options | array<string, mixed>|null | [] | - |
$regions | array<int, RegionInterface> | [] | - |
$enabled | bool|null | null | - |
$vatCategoryIdentifier | string|null | null | - |
getDescriptions()
¶
ShippingMethodUpdateStruct.php
:
97
|
|
Return values
array<string, string>
getEnabled()
¶
ShippingMethodUpdateStruct.php
:
131
|
|
Return values
bool|null
getIdentifier()
¶
ShippingMethodUpdateStruct.php
:
63
|
|
Return values
string|null
getNames()
¶
ShippingMethodUpdateStruct.php
:
76
|
|
Return values
array<string, string>
getOptions()
¶
ShippingMethodUpdateStruct.php
:
118
|
|
Return values
array<string, mixed>|null
getRegions()
¶
ShippingMethodUpdateStruct.php
:
144
|
|
Return values
array<int, RegionInterface>|null
getVatCategoryIdentifier()
¶
ShippingMethodUpdateStruct.php
:
157
|
|
Return values
string|null
setDescription()
¶
ShippingMethodUpdateStruct.php
:
110
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$languageCode | string | - | - |
$description | string | - | - |
setDescriptions()
¶
ShippingMethodUpdateStruct.php
:
105
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$descriptions | array<string, string> | - | - |
setEnabled()
¶
ShippingMethodUpdateStruct.php
:
136
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$enabled | bool|null | - | - |
setIdentifier()
¶
ShippingMethodUpdateStruct.php
:
68
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$identifier | string|null | - | - |
setName()
¶
ShippingMethodUpdateStruct.php
:
89
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$languageCode | string | - | - |
$name | string | - | - |
setNames()
¶
ShippingMethodUpdateStruct.php
:
84
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$names | array<string, string> | - | - |
setOptions()
¶
ShippingMethodUpdateStruct.php
:
126
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$options | array<string, mixed>|null | - | - |
setRegions()
¶
ShippingMethodUpdateStruct.php
:
152
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$regions | array<int, RegionInterface> | - | - |
setVatCategoryIdentifier()
¶
ShippingMethodUpdateStruct.php
:
162
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$vatCategoryIdentifier | string|null | - | - |
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>