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()
¶
ProductAvailabilityCreateStruct.php
:
24
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 |
---|---|---|---|
$product | ProductInterface | - | - |
$availability | bool | false | - |
$isInfinite | bool | false | - |
$stock | int|null | null | - |
createInfinite()
¶
ProductAvailabilityCreateStruct.php
:
68
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$product | ProductInterface | - | - |
$available | bool | - | - |
Return values
self
createWithStock()
¶
ProductAvailabilityCreateStruct.php
:
63
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$product | ProductInterface | - | - |
$available | bool | - | - |
$stock | int | - | - |
Return values
self
getAvailability()
¶
ProductAvailabilityCreateStruct.php
:
43
|
|
Return values
bool
getProduct()
¶
ProductAvailabilityCreateStruct.php
:
38
|
|
Return values
getStock()
¶
ProductAvailabilityCreateStruct.php
:
53
|
|
Return values
int|null
isInfinite()
¶
ProductAvailabilityCreateStruct.php
:
58
|
|
Return values
bool
setAvailability()
¶
ProductAvailabilityCreateStruct.php
:
48
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$availability | bool | - | - |
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>