AddLinkedParametersGroup
extends ProductParametersGroup
in package
Uses
IdentifiableItemsParametersGroupTrait
This is the basket model (add linked resource) parameters group class.
Table of Contents
$id | : int | |
---|---|---|
$mode | : string | |
$options | : array<string|int, mixed> | |
$quantity | : int | |
$sectionId | : int | |
$validator | : ParametersValidator | |
addOption() | Adds a new option to the array of options for this parameters group. | : void |
setId() | Sets the internal identifier parameter for this parameters group. | : void |
setMode() | Sets the mode parameter for this parameters group. | : void |
setOptions() | Sets an array of options as a parameter for this parameters group. | : void |
setQuantity() | Sets the quantity parameter for this parameters group. | : void |
setSectionId() | Sets the internal identifier of the linked items section. | : void |
toArray() | Returns the object data on array format. | : array<string|int, mixed> |
filter() | : array<string|int, mixed> | |
getInstantiatedValidator() | : ParametersValidator | |
getValidator() | {@inheritdoc} | : AddLinkedParametersValidator |
Properties
$id
protected
int
$id
$mode
protected
string
$mode
$options
protected
array<string|int, mixed>
$options
$quantity
protected
int
$quantity
$sectionId
protected
int
$sectionId
$validator
protected
ParametersValidator
$validator
Methods
addOption()
Adds a new option to the array of options for this parameters group.
public
addOption(ProductOptionParametersGroup $option) : void
Parameters
- $option : ProductOptionParametersGroup
Return values
void —setId()
Sets the internal identifier parameter for this parameters group.
public
setId(int $id) : void
Parameters
- $id : int
Return values
void —setMode()
Sets the mode parameter for this parameters group.
public
setMode(string $mode) : void
Parameters
- $mode : string
Return values
void —setOptions()
Sets an array of options as a parameter for this parameters group.
public
setOptions(array<string|int, ProductOptionParametersGroup> $options) : void
Parameters
- $options : array<string|int, ProductOptionParametersGroup>
Return values
void —setQuantity()
Sets the quantity parameter for this parameters group.
public
setQuantity(int $quantity) : void
Parameters
- $quantity : int
Return values
void —setSectionId()
Sets the internal identifier of the linked items section.
public
setSectionId(int $sectionId) : void
Parameters
- $sectionId : int
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()
{@inheritdoc}
protected
getValidator() : AddLinkedParametersValidator