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()
¶
AttributeGroupCreateStruct.php
:
25
Construct object optionally with a set of properties.
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$identifier | string | - | - |
$names | array<string, string> | [] | - |
$position | int | 0 | - |
getIdentifier()
¶
AttributeGroupCreateStruct.php
:
34
|
|
Return values
string
getNames()
¶
AttributeGroupCreateStruct.php
:
47
|
|
Return values
array<string, string>
getPosition()
¶
AttributeGroupCreateStruct.php
:
60
|
|
Return values
int
setIdentifier()
¶
AttributeGroupCreateStruct.php
:
39
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$identifier | string | - | - |
setNames()
¶
AttributeGroupCreateStruct.php
:
55
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$names | array<string, string> | - | - |
setPosition()
¶
AttributeGroupCreateStruct.php
:
65
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$position | int | - | - |
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>