CreateReturnRequestParametersGroup
extends ParametersGroup
in package
This is the create return request parameters group class.
Table of Contents
| $comment | : string | |
|---|---|---|
| $delivery | : CreateReturnRequestDeliveryParametersGroup | |
| $items | : array<string|int, mixed> | |
| $validator | : ParametersValidator | |
| addItem() | Adds a new item to the array of items for this parameters group. | : void |
| setComment() | Sets the comment parameter for this parameters group. | : void |
| setDelivery() | Sets the delivery parameter for this parameters group. | : void |
| setItems() | Sets an array of items 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() | : CreateReturnRequestParametersValidator |
Properties
$comment
protected
string
$comment
$delivery
protected
CreateReturnRequestDeliveryParametersGroup
$delivery
$items
protected
array<string|int, mixed>
$items
$validator
protected
ParametersValidator
$validator
Methods
addItem()
Adds a new item to the array of items for this parameters group.
public
addItem(CreateReturnRequestItemParametersGroup $item) : void
Parameters
Return values
void —setComment()
Sets the comment parameter for this parameters group.
public
setComment(string $comment) : void
Parameters
- $comment : string
Return values
void —setDelivery()
Sets the delivery parameter for this parameters group.
public
setDelivery(CreateReturnRequestDeliveryParametersGroup $delivery) : void
Parameters
- $delivery : CreateReturnRequestDeliveryParametersGroup
Return values
void —setItems()
Sets an array of items as a parameter for this parameters group.
public
setItems(array<string|int, CreateReturnRequestItemParametersGroup> $items) : void
Parameters
- $items : array<string|int, CreateReturnRequestItemParametersGroup>
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() : CreateReturnRequestParametersValidator