Copied!

ShipmentUpdateStruct

ShipmentUpdateStruct.php : 15
Extends ValueObject

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

public__construct()

ShipmentUpdateStruct.php : 29

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 -

publicgetContext()

ShipmentUpdateStruct.php : 76 
public getContext() : MapInterface<string, mixed>|null

Return values

MapInterface<string, mixed>|null

publicgetIdentifier()

ShipmentUpdateStruct.php : 53 
public getIdentifier() : string|null

Return values

string|null

publicgetOwner()

ShipmentUpdateStruct.php : 63 
public getOwner() : UserReference|null

Return values

UserReference|null

publicgetTransition()

ShipmentUpdateStruct.php : 43 
public getTransition() : string|null

Return values

string|null

publicsetContext()

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

Parameters

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

publicsetIdentifier()

ShipmentUpdateStruct.php : 58 
public setIdentifier(string|null $identifier) : void

Parameters

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

publicsetOwner()

ShipmentUpdateStruct.php : 68 
public setOwner([UserReference|null $owner = null ]) : void

Parameters

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

publicsetTransition()

ShipmentUpdateStruct.php : 48 
public setTransition(string|null $transition) : void

Parameters

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

protectedgetProperties()

ValueObject.php : 54

Returns list of available properties' names.

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

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>

Tags
Serializerignore

()