OrderCreateStruct

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

OrderCreateStruct.php : 43 Copy path

Construct object optionally with a set of properties.

public __construct(OrderUserInterface $user, OrderCurrencyInterface $currency, OrderValueInterface $value, string $source, array<string|int, OrderItemInterface> $items[, OrderCompanyInterface|null $company = null ][, MapInterface<string, mixed>|null $context = null ])

Parameters

Name	Type	Default value	Description
$user	OrderUserInterface	-	-
$currency	OrderCurrencyInterface	-	-
$value	OrderValueInterface	-	-
$source	string	-	-
$items	array<string\|int, OrderItemInterface>	-	-
$company	OrderCompanyInterface\|null	null	-
$context	MapInterface<string, mixed>\|null	null	-

getCompany() ¶

OrderCreateStruct.php : 68 Copy path

public getCompany() : OrderCompanyInterface|null

Return values

OrderCompanyInterface|null

getContext() ¶

OrderCreateStruct.php : 117 Copy path

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

Return values

MapInterface<string, mixed>|null

getCurrency() ¶

OrderCreateStruct.php : 73 Copy path

public getCurrency() : OrderCurrencyInterface

Return values

OrderCurrencyInterface

getItems() ¶

OrderCreateStruct.php : 101 Copy path

public getItems() : array<string|int, OrderItemInterface>

Return values

array<string|int, OrderItemInterface>

getSource() ¶

OrderCreateStruct.php : 83 Copy path

public getSource() : string

Return values

string

getStatus() ¶

OrderCreateStruct.php : 88 Copy path

public getStatus() : string

Return values

string

getUser() ¶

OrderCreateStruct.php : 63 Copy path

public getUser() : OrderUserInterface

Return values

OrderUserInterface

getValue() ¶

OrderCreateStruct.php : 78 Copy path

public getValue() : OrderValueInterface

Return values

OrderValueInterface

setContext() ¶

OrderCreateStruct.php : 109 Copy path

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

Parameters

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

setStatus() ¶

OrderCreateStruct.php : 93 Copy path

public setStatus(string $status) : void

Parameters

Name	Type	Default value	Description
$status	string	-	-

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>