ShipmentCreateStruct

ShipmentCreateStruct.php : 19 Copy path

Extends ValueObject

Implements WorkflowSubjectInterface

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() ¶

ShipmentCreateStruct.php : 34 Copy path

Construct object optionally with a set of properties.

public __construct(ShippingMethodInterface $method, OrderInterface $order, Money $amount[, UserReference|null $owner = null ])

Readonly properties values must be set using $properties as they are not writable anymore after object has been created.

Parameters

Name	Type	Default value	Description
$method	ShippingMethodInterface	-	-
$order	OrderInterface	-	-
$amount	Money	-	-
$owner	UserReference\|null	null	-

getAmount() ¶

ShipmentCreateStruct.php : 78 Copy path

public getAmount() : Money

Return values

Money

getContext() ¶

ShipmentCreateStruct.php : 101 Copy path

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

Return values

MapInterface<string, mixed>|null

getIdentifier() ¶

ShipmentCreateStruct.php : 48 Copy path

public getIdentifier() : string|null

Return values

string|null

getMethod() ¶

ShipmentCreateStruct.php : 58 Copy path

public getMethod() : ShippingMethodInterface

Return values

ShippingMethodInterface

getOrder() ¶

ShipmentCreateStruct.php : 68 Copy path

public getOrder() : OrderInterface

Return values

OrderInterface

getOwner() ¶

ShipmentCreateStruct.php : 88 Copy path

public getOwner() : UserReference|null

Return values

UserReference|null

setAmount() ¶

ShipmentCreateStruct.php : 83 Copy path

public setAmount(Money $amount) : void

Parameters

Name	Type	Default value	Description
$amount	Money	-	-

setContext() ¶

ShipmentCreateStruct.php : 109 Copy path

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

Parameters

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

setIdentifier() ¶

ShipmentCreateStruct.php : 53 Copy path

public setIdentifier(string|null $identifier) : void

Parameters

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

setMethod() ¶

ShipmentCreateStruct.php : 63 Copy path

public setMethod(ShippingMethodInterface $method) : void

Parameters

Name	Type	Default value	Description
$method	ShippingMethodInterface	-	-

setOrder() ¶

ShipmentCreateStruct.php : 73 Copy path

public setOrder(OrderInterface $order) : void

Parameters

Name	Type	Default value	Description
$order	OrderInterface	-	-

setOwner() ¶

ShipmentCreateStruct.php : 93 Copy path

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

Parameters

Name	Type	Default value	Description
$owner	UserReference\|null	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>