QueryCriteria
in package
Data transfer object with the query parameters.
Used for serialization between the front module and the Api.
Table of Contents
Properties
- $columns : array<string|int, mixed>|null
- $computeTotalCount : bool
- $filters : array<string|int, mixed>
- $includes : string|array<string|int, mixed>
- $limit : int|null
- $offset : int|null
- $orderBy : array<string|int, mixed>
- $totalCount : int
- $useCache : bool|null
- Wire-payload query cache policy for this query.
Methods
- __construct() : mixed
Properties
$columns
public
array<string|int, mixed>|null
$columns
= null
$computeTotalCount
public
bool
$computeTotalCount
= false
$filters
public
array<string|int, mixed>
$filters
= []
$includes
public
string|array<string|int, mixed>
$includes
= []
$limit
public
int|null
$limit
= null
$offset
public
int|null
$offset
= null
$orderBy
public
array<string|int, mixed>
$orderBy
= []
$totalCount
public
int
$totalCount
= 0
$useCache
Wire-payload query cache policy for this query.
public
bool|null
$useCache
= null
null means the default of the layer that builds the payload (Front true,
Admin false); ->useCache(bool) on the query object overrides it.
Methods
__construct()
public
__construct([array<string|int, mixed> $filters = [] ][, array<string|int, mixed> $orderBy = [] ][, int|null $limit = null ][, int|null $offset = null ][, array<string|int, mixed>|null $columns = null ][, string|array<string|int, mixed> $includes = [] ][, bool $computeTotalCount = false ][, bool|null $useCache = null ]) : mixed
Parameters
- $filters : array<string|int, mixed> = []
- $orderBy : array<string|int, mixed> = []
- $limit : int|null = null
- $offset : int|null = null
- $columns : array<string|int, mixed>|null = null
-
nullselects all entity columns; a list selects only those columns (partial SELECT) - $includes : string|array<string|int, mixed> = []
- $computeTotalCount : bool = false
- $useCache : bool|null = null