Sorter
in package
Sorter
Table of Contents
- $alias : string
- $dimensions : array<string|int, mixed>
- $direction : int
- $validSortSignals : array<string|int, mixed>
- __construct() : mixed
- Sorter constructor.
- alias() : string
- dimensions() : array<string|int, mixed>
- direction() : int
- initializeArrayFromQuery() : array<string|int, mixed>
- Initialize an array of Sorter based on a query string.
Properties
$alias
protected
string
$alias
$dimensions
protected
array<string|int, mixed>
$dimensions
$direction
protected
int
$direction
$validSortSignals
protected
array<string|int, mixed>
$validSortSignals
= ['+', '-', ' ']
Methods
__construct()
Sorter constructor.
public
__construct(StringType $sortInstruction) : mixed
Parameters
- $sortInstruction : StringType
-
URL query parameter with sort information
Return values
mixed —alias()
public
alias() : string
Return values
string —dimensions()
public
dimensions() : array<string|int, mixed>
Return values
array<string|int, mixed> —direction()
public
direction() : int
Return values
int —initializeArrayFromQuery()
Initialize an array of Sorter based on a query string.
public
static initializeArrayFromQuery(StringType $sortInstructions) : array<string|int, mixed>
Parameters
- $sortInstructions : StringType
-
URL query parameter with sort information