LinkedParametersGroup
extends ParametersGroup
in package
This is the linked parameters group class.
Table of Contents
$limit | : int | |
---|---|---|
$pId | : string | |
$position | : int | |
$positionList | : string | |
$validator | : ParametersValidator | |
setLimit() | Sets the maximum number of items to return, from 1 to 50. | : void |
setPId() | Sets the public identifier of the item to be obtained. | : void |
setPosition() | Sets the position of the item to be obtained. | : void |
setPositionList() | Sets the list of positions of the items to be obtained. | : void |
toArray() | Returns the object data on array format. | : array<string|int, mixed> |
filter() | : array<string|int, mixed> | |
getInstantiatedValidator() | : ParametersValidator | |
getValidator() | : LinkedParametersValidator |
Properties
$limit
protected
int
$limit
$pId
protected
string
$pId
$position
protected
int
$position
$positionList
protected
string
$positionList
$validator
protected
ParametersValidator
$validator
Methods
setLimit()
Sets the maximum number of items to return, from 1 to 50.
public
setLimit(int $limit) : void
Parameters
- $limit : int
Return values
void —setPId()
Sets the public identifier of the item to be obtained.
public
setPId(string $pId) : void
Parameters
- $pId : string
Return values
void —setPosition()
Sets the position of the item to be obtained.
public
setPosition(int $position) : void
Parameters
- $position : int
Return values
void —setPositionList()
Sets the list of positions of the items to be obtained.
public
setPositionList(string $positionList) : void
Parameters
- $positionList : string
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() : LinkedParametersValidator