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()
¶
ProductCreateStruct.php
:
28
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 |
|---|---|---|---|
| $productType | ProductTypeInterface | - | - |
| $contentCreateStruct | ContentCreateStruct | - | - |
| $code | string|null | null | - |
getAttributes()
¶
ProductCreateStruct.php
:
52
|
|
|
Return values
array<string, mixed>
getCode()
¶
ProductCreateStruct.php
:
39
|
|
|
Return values
string|null
getContentCreateStruct()
¶
ProductCreateStruct.php
:
85
|
|
|
Return values
getProductType()
¶
ProductCreateStruct.php
:
90
|
|
|
Return values
setAttribute()
¶
ProductCreateStruct.php
:
60
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $name | string | - | - |
| $value | mixed | - | - |
setAttributes()
¶
ProductCreateStruct.php
:
68
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $attributes | array<string, mixed> | - | - |
setCode()
¶
ProductCreateStruct.php
:
44
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $code | string|null | - | - |
setField()
¶
ProductCreateStruct.php
:
76
|
|
|
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>