EditShipmentsParametersGroup
extends ParametersGroup
in package
This is the basket model (set shipments resource) parameters group class.
Table of Contents
| $deliveryHash | : string | |
|---|---|---|
| $shipments | : array<string|int, mixed> | |
| $validator | : ParametersValidator | |
| addShipment() | Adds a new shipment to the array of shipments for this parameters group. | : void |
| setDeliveryHash() | Sets the delivery hash parameter for this parameters group. | : void |
| setShipments() | Sets an array of shipments as a parameter for this parameters group. | : void |
| toArray() | Returns the object data on array format. | : array<string|int, mixed> |
| filter() | : array<string|int, mixed> | |
| getInstantiatedValidator() | : ParametersValidator | |
| getValidator() | : ShipmentsParametersValidator |
Properties
$deliveryHash
protected
string
$deliveryHash
$shipments
protected
array<string|int, mixed>
$shipments
$validator
protected
ParametersValidator
$validator
Methods
addShipment()
Adds a new shipment to the array of shipments for this parameters group.
public
addShipment(EditShipmentParametersGroup $shipment) : void
Parameters
- $shipment : EditShipmentParametersGroup
Return values
void —setDeliveryHash()
Sets the delivery hash parameter for this parameters group.
public
setDeliveryHash(string $deliveryHash) : void
Parameters
- $deliveryHash : string
Return values
void —setShipments()
Sets an array of shipments as a parameter for this parameters group.
public
setShipments(array<string|int, EditShipmentParametersGroup> $shipments) : void
Parameters
- $shipments : array<string|int, EditShipmentParametersGroup>
Return values
void —toArray()
Returns the object data on array format.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —filter()
protected
filter(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —getInstantiatedValidator()
protected
getInstantiatedValidator() : ParametersValidator
Return values
ParametersValidator —getValidator()
protected
getValidator() : ShipmentsParametersValidator