Documentation

Parameters
in package

Table of Contents

Properties

$groupBy  : string|null
$limit  : int|null|string
The limit parameter for the query.
$orderBy  : string|null
$selectDistinct  : bool

Methods

get()  : mixed
Get the value of a parameter by name.
getAll()  : array<string, mixed>
Get the parameters for the query.
reset()  : void
Resets the parameters array.
set()  : $this
Add a parameter to the query.

Properties

$limit

The limit parameter for the query.

private int|null|string $limit = null

The limit value for the query.

$selectDistinct

private bool $selectDistinct = false

Methods

get()

Get the value of a parameter by name.

public get(string $name) : mixed
Parameters
$name : string

The name of the parameter.

Return values
mixed

The value of the parameter.

getAll()

Get the parameters for the query.

public getAll() : array<string, mixed>
Return values
array<string, mixed>

The parameters for the query.

reset()

Resets the parameters array.

public reset() : void

This method clears all the parameters stored in the array.

set()

Add a parameter to the query.

public set(string $name, bool|int|string $value) : $this
Parameters
$name : string

The name of the parameter.

$value : bool|int|string

The value of the parameter.

Tags
throws
ParametersException

If the property does not exist.

Return values
$this

The current instance of the Parameters object.


        
On this page

Search results