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()
¶
ProductUpdateStruct.php
:
41
Construct object optionally with a set of properties.
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$product | ProductInterface|ContentAwareProductInterface | - | - |
$contentUpdateStruct | ContentUpdateStruct | - | - |
getAttributes()
¶
ProductUpdateStruct.php
:
70
|
|
Return values
array<string, mixed>
getCode()
¶
ProductUpdateStruct.php
:
57
|
|
Return values
string|null
getContentMetadataUpdateStruct()
¶
ProductUpdateStruct.php
:
101
|
|
Return values
ContentMetadataUpdateStruct|null
getContentUpdateStruct()
¶
ProductUpdateStruct.php
:
91
|
|
Return values
getProduct()
¶
ProductUpdateStruct.php
:
52
|
|
Return values
ProductInterface|ContentAwareProductInterface
setAttribute()
¶
ProductUpdateStruct.php
:
78
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$name | string | - | - |
$value | mixed | - | - |
setAttributes()
¶
ProductUpdateStruct.php
:
86
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$attributes | array<string, mixed> | - | - |
setCode()
¶
ProductUpdateStruct.php
:
62
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$code | string|null | - | - |
setContentMetadataUpdateStruct()
¶
ProductUpdateStruct.php
:
106
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$contentMetadataUpdateStruct | ContentMetadataUpdateStruct|null | - | - |
setContentUpdateStruct()
¶
ProductUpdateStruct.php
:
96
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$contentUpdateStruct | ContentUpdateStruct | - | - |
setField()
¶
ProductUpdateStruct.php
:
114
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$fieldDefIdentifier | string | - | - |
$value | mixed | - | - |
$language | string|null | 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>