FilterStatement

MMO\pdo\statements · 1 symbol · generated 5 Oct 2026

class

FilterStatement

class MMO\pdo\statements\FilterStatement extends MMO\pdo\statements\Statement

Namespace: MMO\pdo\statements
Extends: Statement

Index

	LIMIT_KEY
	MAX_LIMIT
	ORDER_KEY
	WHERE_KEY	Reserved content keys for the trailing clauses this class appends to every template.
	getFilter()
	limit($count, $offset)
	order($fields)
	setFilter($filter)
	__construct($handler, $template, $content, $opts)

Constants4

LIMIT_KEY

const LIMIT_KEY = 'LIMIT'

MAX_LIMIT

const MAX_LIMIT = '18446744073709551615'

ORDER_KEY

const ORDER_KEY = 'ORDER'

WHERE_KEY

Reserved content keys for the trailing clauses this class appends to every template.

const WHERE_KEY = 'WHERE'

WARNING: these MUST start with a letter. A placeholder whose name starts with anything else (`_` included) is not recognised as a placeholder at all by [`loopTemplate`](https://mcp.mmoframework.fr/documentation/mmo.core/php/strings.md#looptemplate) -- it is left in the query as literal text, and the driver then chokes on `unrecognized token: "{"`.

Methods5

getFilter()

FilterStatement.php:82

function getFilter(): MMO\core\interfaces\iFilter|string|null

returns

iFilter | string | null

limit($count, $offset)

FilterStatement.php:67

function limit(?int $count, ?int $offset = null): self

$count	null \| int
$offset = null	null \| int
returns	self

order($fields)

FilterStatement.php:47

function order(array|string $fields): self

$fields	array \| string
returns	self

setFilter($filter)

FilterStatement.php:96

function setFilter(MMO\core\interfaces\iFilter|array|string|null $filter): self

NOTE: the filter is validated here, not at render time. The printer's exceptions are caught by

See: TextPrinter::__invoke and returned as inline text, so a filter it cannot render would otherwise be pasted into the query instead of failing.

$filter	iFilter \| array \| string \| null	a core filter (`Filter::From`); null clears it
returns	self
throws		on an operator with no SQL equivalent
throws		on a nested path

__construct($handler, $template, $content, $opts)

FilterStatement.php:39

function __construct( MMO\pdo\interfaces\iHandler $handler, string $template, array $content = [], array $opts = [] )

$handler	iHandler
$template	string
$content = []	array
$opts = []	array

Inherited members (53)

	Constants	Declared by	Description
	`ALL_FLAG`	Statement
	`CREATE_IF_NOT_EXISTS_FLAG`	Statement
	`CREATE_TEMPORARY_FLAG`	Statement
	`DELAYED_FLAG`	Statement
	`DISTINCT_FLAG`	Statement
	`DISTINCT_ROW_FLAG`	Statement
	`HIGH_PRIORITY_FLAG`	Statement
	`IF_EXISTS_FLAG`	Statement
	`IGNORE_FLAG`	Statement
	`LOW_PRIORITY_FLAG`	Statement
	`QUICK_FLAG`	Statement
	`STRAIGHT_JOIN_FLAG`	Statement

	Properties	Declared by	Description
	`content`	Statement
	`handler`	Statement
	`opts`	Statement
	`stmt`	Statement
	`template`	Statement

Methods	Declared by	Description
`addOptions($opts, $appendList)`	Statement	Merge $opts into the existing options (through `merge`), rather than replacing them wholesale like `setOptions`.
`bindValue($pdo, $index, $value, $type, $binds)`	Statement	Bind one already-emitted value onto the PDO statement.
`clear()`	Statement	Empty the underlying content, keeping the object itself.
`clearOptions()`	Statement	Empty the options bag.
`count()`	Statement	\Countable::count
`execute()`	Statement	Execute the query and set the current statement
`fetch($opt)`	Statement	Fetch the first row of the query's result
`fetchAll($clear)`	Statement	Fetch all the result of a query
`fetchAllObjects($class, $constructFirst, $args, $clear)`	Statement	Fetch all the result of a query as Objects.
`fetchObject($class, $constructFirst, $args)`	Statement	Fetch the result of a query as an Object.
`fetchValue($key)`	Statement	Fetch the column's value of the first row of the query's result and advance fetch pointer
`fetchValues($key)`	Statement	Fetch the column's value of all the row of the query's result
`flag($key, $flag, $set)`	Statement
`getIterator()`	Statement	\IteratorAggregate::getIterator
`getOption($key, $default)`	Statement
`getOptions()`	Statement
`getPDOStatement()`	Statement
`getPlaceholders()`	Statement	Extract placeholder from template
`isEmpty()`	Statement
`jsonSerialize()`	Statement	\JsonSerializable::jsonSerialize -- the raw content is returned as-is (not recursively converted), so json_encode() relies on any nested iArray values being JsonSerializable themselves.
`keys()`	Statement
`loadArray($data)`	Statement	Load every entry of a plain array into the content, through `offsetSet` (so any offsetSet() override defined by the class using this trait, e.g.
`offsetExists($key)`	Statement	\ArrayAccess::offsetExists
`offsetGet($key)`	Statement	\ArrayAccess::offsetGet
`offsetSet($key, $value)`	Statement	\ArrayAccess::offsetSet -- a null $key appends (`$bag[] = $value`), like a plain PHP array.
`offsetUnset($key)`	Statement	\ArrayAccess::offsetUnset -- on a list (sequential integer keys, as produced by `$bag[] = ...`), the element is spliced out (closing the gap and reindexing), matching \unset() semantics on a plain …
`prepare($binds, $sql)`	Statement	Prepare a PDO statement by binding values.
`push($key, $fields)`	Statement
`render($opts)`	Statement
`reset()`	Statement
`rowCount()`	Statement
`setOption($key, $value)`	Statement	Set (or, with a null $value, remove) a single option.
`setOptions($opts)`	Statement	Replace the whole options bag.
`SplitType($key)`	Statement	Split a `column:type` key used by the INSERT/UPDATE value lists.
`toArray()`	Statement	Convert the content to a plain array, recursively converting any nested `iArray` value (e.g.
`__toString()`	Statement