ShipmentUpdateStruct

ShipmentUpdateStruct.php : 15 Copy path

Extends ValueObject

The base class for all value objects and structs.

Supports readonly properties by marking them as protected. In this case they will only be writable using constructor, and need to be documented using property-read <$var> annotation in class doc in addition to inline property doc. Writable properties must be public and must be documented inline.

Methods¶

__construct() ¶

ShipmentUpdateStruct.php : 29 Copy path

Construct object optionally with a set of properties.

public __construct([string|null $transition = null ][, string|null $identifier = null ][, UserReference|null $owner = null ][, MapInterface<string, mixed>|null $context = null ])

Parameters

Name	Type	Default value	Description
$transition	string\|null	null	-
$identifier	string\|null	null	-
$owner	UserReference\|null	null	-
$context	MapInterface<string, mixed>\|null	null	-

getContext() ¶

ShipmentUpdateStruct.php : 76 Copy path

public getContext() : MapInterface<string, mixed>|null

Return values

MapInterface<string, mixed>|null

getIdentifier() ¶

ShipmentUpdateStruct.php : 53 Copy path

public getIdentifier() : string|null

Return values

string|null

getOwner() ¶

ShipmentUpdateStruct.php : 63 Copy path

public getOwner() : UserReference|null

Return values

UserReference|null

getTransition() ¶

ShipmentUpdateStruct.php : 43 Copy path

public getTransition() : string|null

Return values

string|null

setContext() ¶

ShipmentUpdateStruct.php : 84 Copy path

public setContext(MapInterface<string, mixed>|null $context) : void

Parameters

Name	Type	Default value	Description
$context	MapInterface<string, mixed>\|null	-	-

setIdentifier() ¶

ShipmentUpdateStruct.php : 58 Copy path

public setIdentifier(string|null $identifier) : void

Parameters

Name	Type	Default value	Description
$identifier	string\|null	-	-

setOwner() ¶

ShipmentUpdateStruct.php : 68 Copy path

public setOwner([UserReference|null $owner = null ]) : void

Parameters

Name	Type	Default value	Description
$owner	UserReference\|null	null	-

setTransition() ¶

ShipmentUpdateStruct.php : 48 Copy path

public setTransition(string|null $transition) : void

Parameters

Name	Type	Default value	Description
$transition	string\|null	-	-

getProperties() ¶

ValueObject.php : 50 Copy path

Function where list of properties are returned.

    
                        protected getProperties([array<string|int, mixed> $dynamicProperties = [] ]) : array<string|int, mixed>

Used by attributes(), override to add dynamic properties

Parameters

Name	Type	Default value	Description
$dynamicProperties	array<string\|int, mixed>	[]	Additional dynamic properties exposed on the object

Return values

array<string|int, mixed>