PDOPrinter

MMO\pdo · 1 symbole · générée le 27 Oct 2026

class

PDOPrinter

class MMO\pdo\PDOPrinter extends MMO\core\printers\TextPrinter

Espace de noms: MMO\pdo
Étend: TextPrinter

Index

	JSON_SEGMENT_REGEX	What a segment of a nested path (`meta/tags/0`) may hold: it is written into the query as a JSON path.
	OPERATORS	The comparison operators written as one SQL operator.
	AssertSupported($filter) static	Check that a filter can be rendered as SQL at all, and say so loudly if it cannot.
	bind($value, $options, $type)	Emit a `?` for $value and record it on the render's `Binds` collector, so
	dateToTimestamp($date)	Create a unix timestamp from a date or a datetime
	exportArray($value, $options)
	exportAssignment($assignment, $options)	One assignment's value, as recorded by `UpdateStatement::values`.
	exportAssignments($value, $options)	An `UPDATE … SET` list: ` col`=?
	exportBind($value, $options)	The `bind`/`int`/`bool`/`blob`/`lob` placeholder types: force a bind regardless of the value's PHP type.
	exportBoolean($value, $options)
	exportColumns($value, $options)	An `INSERT INTO table (…)` column list.
	exportCondition($column, $operator, $value, $negate, $options)	One condition, as SQL that matches what `FilterOperator::test` answers for the same value.
	exportConstraints($value, $options)	Constraints for table creation
	exportDateTime($value, $options)	A date is bound in the format a DATETIME column holds; `PDOExporter` writes a DATE or TIME column's own.
	exportDuplicate($value, $options)
	exportEntity($value, $options)	An entity is stored as its id, the foreign key (`PDOExporter::exportEntity`); anything else as text.
	exportEnum($value, $options)	An enum is stored as its case's name (`PDOExporter::exportEnum`).
	exportField($value, $options)
	exportFilter($value, $options)
	exportFilterGroup($value, $options)
	exportFlags($value, $options)	Generic flags for queries
	exportJoins($value, $options)	A SELECT's JOIN clauses (`SelectStatement::join`).
	exportLimit($value, $options)
	exportNull($value, $options)
	exportNumber($value, $options)
	exportObject($value, $options)	Fields [key => value]
	exportOn($value, $options)
	exportOrder($value, $options)
	exportPath($path, $options)	A filter's path as a SQL expression: a column (` name `,` t1`.`name `), or, for a nested path, the value at that path in a column holding JSON (`meta/tags/0 `is` $."tags"[0] `in` meta`).
	exportPDOStatement($value, $options)	PDOStatement
	exportRows($value, $options)	An `INSERT … VALUES (…),(…)` tuple list.
	exportStatement($value, $options)
	exportString($value, $options)
	exportWhere($value, $options)
	makeDate($timestamp)	Create a valid date form a php date
	quote($text, $options)	Quote text
	quoteColumn($path, $options)	Quote a column reference, one segment at a time.
	regex($value, $options)	A `$regex` condition's pattern, for the driver: as `FilterOperator::test` reads it -- `/…/flags`, or a text that becomes an accent and case insensitive pattern (`textRegex`).
	__construct($config)

Constantes2

JSON_SEGMENT_REGEX

What a segment of a nested path (meta/tags/0) may hold: it is written into the query as a JSON path.

const JSON_SEGMENT_REGEX = '/^[A-Za-z0-9_\\- ]+$/'

OPERATORS

The comparison operators written as one SQL operator. The value is [normal, negated], the second being what $nor turns it into. The other operators ($in, $nin, $exists, $regex, $text, $has) have a form of their own (exportCondition).

const OPERATORS = […6 items]

Méthodes37

AssertSupported($filter)

staticPDOPrinter.php:537

Check that a filter can be rendered as SQL at all, and say so loudly if it cannot.

static function AssertSupported(MMO\core\interfaces\iFilter $filter): void

This exists because [`TextPrinter::__invoke`](https://mmoframework.fr/documentation/mmo.core/php/printers/TextPrinter.md#textprinter--invoke) catches every exception an exporter throws and returns it as inline text -- so a condition it cannot write would otherwise be pasted into the middle of the query, stack trace and all, instead of failing. Callers validate up front instead.

$filter	iFilter
retourne	void
lève		on a nested path's segment that cannot be a JSON path's, or a `$in`/`$nin` that is not a list NOTE: until 2026-10 `$regex`, `$has`, `$text` and nested paths were refused here.

bind($value, $options, $type)

PDOPrinter.php:177

Emit a ? for $value and record it on the render's Binds collector, so

protected function bind(mixed $value, array $options, ?string $type = null): ?string

Every `?` in a rendered query MUST go through here. Anything that renders a value some other way (an identifier, a raw fragment) must NOT, or the bind list and the query drift apart.

Voir: Statement::prepare() binds exactly the values that were actually emitted, in the order they were emitted.

$value	mixed
$options	array	- bind: {bool} false renders the value inline instead (debugging -- `Statement::__toString`) - binds: {Binds} the collector for this render; absent when nobody intends to prepare the result - bind-type: {string} an explicit bind type ('int', 'bool', 'blob', …) overriding $type
$type = null	null \| string	the type inferred from the value
retourne	null \| string	`'?'`, or null when binding is off (the caller then renders the value inline)

dateToTimestamp($date)

PDOPrinter.php:150

Create a unix timestamp from a date or a datetime

function dateToTimestamp(string $date): int

$date	string	in this printer's `datetime` format, or only its date part (midnight is then assumed)
retourne	int
lève		if $date is in neither format

$printer->dateToTimestamp('2026-09-27'); // same as '2026-09-27 00:00:00'

exportArray($value, $options)

PDOPrinter.php:224

function exportArray($value, array $options = []): string

$value
$options = []	array
retourne	string

exportAssignment($assignment, $options)

PDOPrinter.php:372

One assignment's value, as recorded by UpdateStatement::values.

protected function exportAssignment(array $assignment, array $options = []): string

$assignment	array
$options = []	array
retourne	string	`?` normally; the value verbatim for the `raw` type (a SQL expression such as `visits+1`)

exportAssignments($value, $options)

PDOPrinter.php:379

An UPDATE … SET list: ` col=? `, one per assignment.

function exportAssignments(mixed $value, array $options = []): string

$value	mixed
$options = []	array
retourne	string

exportBind($value, $options)

PDOPrinter.php:187

The bind/int/bool/blob/lob placeholder types: force a bind regardless of the value's PHP type.

function exportBind(mixed $value, array $options = []): string

Voir: bind

$value	mixed
$options = []	array
retourne	string

exportBoolean($value, $options)

PDOPrinter.php:197

function exportBoolean(mixed $value, array $options = []): string

$value	mixed
$options = []	array
retourne	string

exportColumns($value, $options)

PDOPrinter.php:393

An INSERT INTO table (…) column list.

function exportColumns(mixed $value, array $options = []): string

$value	mixed
$options = []	array
retourne	string

exportCondition($column, $operator, $value, $negate, $options)

PDOPrinter.php:611

One condition, as SQL that matches what FilterOperator::test answers for the same value.

protected function exportCondition( string $column, MMO\core\helpers\FilterOperator $operator, mixed $value, bool $negate, array $options ): string

SQL compares nothing with NULL: `x <> 'a'` and `x NOT IN ('a')` are not true for a null `x`, while a null is not 'a', and `$nor` turns `x = 'a'` into `x <> 'a'`. So a null column is matched, or not, explicitly: by `$ne`, by `$nin` (unless the list holds null), by `$in` when it does, and by the negation of every other operator. `$lt`/`$lte` do not match a null, although PHP takes null for less than any number.

$column	string	the SQL expression of the path (`exportPath`)
$operator	FilterOperator
$value	mixed
$negate	bool	true inside a `$nor`
$options	array
retourne	string

exportConstraints($value, $options)

PDOPrinter.php:420

Constraints for table creation

function exportConstraints(mixed $value, array $options = []): string

$value	mixed
$options = []	array
retourne	string

exportDateTime($value, $options)

PDOPrinter.php:208

A date is bound in the format a DATETIME column holds; PDOExporter writes a DATE or TIME column's own.

function exportDateTime(mixed $value, array $options = []): string

$value	mixed
$options = []	array
retourne	string

exportDuplicate($value, $options)

PDOPrinter.php:481

function exportDuplicate(mixed $value, array $options = []): string

$value	mixed
$options = []	array
retourne	string

exportEntity($value, $options)

PDOPrinter.php:219

An entity is stored as its id, the foreign key (PDOExporter::exportEntity); anything else as text.

function exportEntity(mixed $value, array $options = []): string

$value	mixed
$options = []	array
retourne	string

exportEnum($value, $options)

PDOPrinter.php:214

An enum is stored as its case's name (PDOExporter::exportEnum).

function exportEnum(mixed $value, array $options = []): string

$value	mixed
$options = []	array
retourne	string

exportField($value, $options)

PDOPrinter.php:262

function exportField(MMO\pdo\helpers\Field $value, array $options = []): string

$value	Field
$options = []	array
retourne	string

exportFilter($value, $options)

PDOPrinter.php:578

function exportFilter(MMO\core\helpers\Filter $value, array $options = []): string

$value	Filter
$options = []	array
retourne	string

exportFilterGroup($value, $options)

PDOPrinter.php:704

function exportFilterGroup(MMO\core\helpers\FilterGroup $value, array $options = []): string

$value	FilterGroup
$options = []	array
retourne	string

exportFlags($value, $options)

PDOPrinter.php:324

Generic flags for queries

function exportFlags(mixed $value, array $options = []): string

$value	mixed
$options = []	array
retourne	string

exportJoins($value, $options)

PDOPrinter.php:342

A SELECT's JOIN clauses (SelectStatement::join).

function exportJoins(mixed $value, array $options = []): string

Several tables joined at once render as one parenthesised group sharing a single ON -- `LEFT JOIN (t2,t3,t4) ON (…)` -- which is the form SQL provides for that.

$value	mixed
$options = []	array
retourne	string

exportLimit($value, $options)

PDOPrinter.php:457

function exportLimit(mixed $value, array $options = []): string

$value	mixed
$options = []	array
retourne	string

exportNull($value, $options)

PDOPrinter.php:203

function exportNull(mixed $value, array $options = []): string

$value	mixed
$options = []	array
retourne	string

exportNumber($value, $options)

PDOPrinter.php:200

function exportNumber(mixed $value, array $options = []): string

$value	mixed
$options = []	array
retourne	string

exportObject($value, $options)

PDOPrinter.php:235

Fields [key => value]

function exportObject($value, array $options = []): string

$value
$options = []	array
retourne	string

exportOn($value, $options)

PDOPrinter.php:474

function exportOn(mixed $value, array $options = []): string

$value	mixed
$options = []	array
retourne	string

exportOrder($value, $options)

PDOPrinter.php:446

function exportOrder(mixed $value, array $options = []): string

$value	mixed
$options = []	array
retourne	string

exportPath($path, $options)

PDOPrinter.php:565

A filter's path as a SQL expression: a column (` name , t1.name ), or, for a nested path, the value at that path in a column holding JSON (meta/tags/0 is $."tags"[0] in meta`).

function exportPath(string $path, array $options = []): string

$path	string
$options = []	array	- driver: {string} 'mysql' (default) or 'sqlite'
retourne	string

$printer->exportPath('meta/lang', ['driver' => 'sqlite']); // json_extract(`meta`, '$."lang"')

exportPDOStatement($value, $options)

PDOPrinter.php:315

PDOStatement

function exportPDOStatement(PDOStatement $value, array $options = []): string

$value	PDOStatement
$options = []	array
retourne	string

exportRows($value, $options)

PDOPrinter.php:402

An INSERT … VALUES (…),(…) tuple list.

function exportRows(mixed $value, array $options = []): string

$value	mixed
$options = []	array
retourne	string

exportStatement($value, $options)

PDOPrinter.php:254

function exportStatement(MMO\pdo\statements\Statement $value, array $options = []): string

$value	Statement
$options = []	array
retourne	string

exportString($value, $options)

PDOPrinter.php:193

function exportString(mixed $value, array $options = []): string

$value	mixed
$options = []	array
retourne	string

exportWhere($value, $options)

PDOPrinter.php:463

function exportWhere(mixed $value, array $options = []): string

$value	mixed
$options = []	array
retourne	string

makeDate($timestamp)

PDOPrinter.php:139

Create a valid date form a php date

function makeDate(?int $timestamp = null): string

$timestamp = null	null \| int
retourne	string

quote($text, $options)

PDOPrinter.php:111

Quote text

function quote(string $text, array $options = []): string

$text	string
$options = []	array
retourne	string

quoteColumn($path, $options)

PDOPrinter.php:127

Quote a column reference, one segment at a time.

function quoteColumn(string $path, array $options = []): string

A qualified name has to become `` `t`.`x` ``, not `` `t.x` `` -- the latter is a column whose NAME contains a dot, which is not what `t.x` means. This only started to matter once joins made qualified columns normal.

$path	string	e.g. `id`, `t1.id`, `t1.*`
$options = []	array
retourne	string

regex($value, $options)

PDOPrinter.php:695

A $regex condition's pattern, for the driver: as FilterOperator::test reads it -- /…/flags, or a text that becomes an accent and case insensitive pattern (textRegex).

function regex(string $value, array $options = []): string

SQLite runs it with preg_match() itself ([`SqliteHandler::connect`](https://mmoframework.fr/documentation/mmo.pdo/php/SqliteHandler.md#sqlitehandler-connect)). MySQL takes the pattern without its delimiters, its `i`, `m`, `s` and `x` flags written inline (`(?i)`), which both MySQL 8 and MariaDB read.

$value	string
$options = []	array
retourne	string

$printer->regex('/^ma/i', ['driver' => 'mysql']); // '(?i)^ma'

__construct($config)

PDOPrinter.php:17

protected function __construct(array &$config)

$config

array

Membres hérités (93)

Constantes	Déclaré par	Description
`ALERT`	iLogLevel	Alert: Action must be taken immediately.
`ALL`	iLogLevel	Mask for all
`ALL_PLUS`	iLogLevel	debug everything
`BACKTRACE`	iLogLevel
`CRITICAL`	iLogLevel	Critical: Critical conditions.
`DEBUG`	iLogLevel	Debug: Detailed debug information.
`DEEP`	iLogLevel	debug everything with arguments
`EMERGENCY`	iLogLevel	Emergency: System is unusable.
`ERROR`	iLogLevel	Error: Runtime errors that do not require immediate action but should typically be logged and monitored.
`ERROR_PLUS`	iLogLevel	Mask for all error
`FATAL`	iLogLevel	Mask for all fatal error
`INFO`	iLogLevel	Info: Interesting events.
`INFO_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`MEMORY`	iLogLevel	include backtrace object
`NOTICE`	iLogLevel	Notice: Normal but significant events.
`NOTICE_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`TRACE`	iLogLevel	include backtrace as origins
`WARNING`	iLogLevel	Warning: Exceptional occurrences that are not errors.
`WARNING_PLUS`	iLogLevel	Mask for all errors and warnings

	Propriétés	Déclaré par	Description
	`functions`	aConverter
	`globalOptions`	TextPrinter
	`templates`	TextPrinter
	`verbosity`	aModule

Méthodes	Déclaré par	Description
`addOptions($type, $options)`	aConverter	Merge $options into $type's existing options (via `merge`), rather than replacing them wholesale like `setOptions`.
`alert($message, $context)`	aModule	Action must be taken immediately.
`backtraces($message, $context)`	aModule	Force-log a message at INFO level together with a full stack trace/memory snapshot (`iLogLevel::BACKTRACE`), bypassing the verbosity mask entirely (any non-zero verbosity is enough to trigger it).
`call($type, $value, $options)`	aConverter	Call the function associated to a type
`clear()`	TextPrinter	Reset both the exporter state (`aExporter::clear`) and `$templates`.
`Configure($config)`	aModule	Merge $config into this module's configuration in the shared `Configuration`.
`critical($message, $context)`	aModule	Critical conditions. No-op if CRITICAL is currently filtered out by the verbosity mask.
`debug($message, $context)`	aModule	Detailed debug information.
`debugName()`	aModule	Human-readable identifier used as the default `{origin}` in this instance's log messages.
`DefaultConfig()`	aModule	The config a module starts from before anything loaded via `Configuration` is merged in.
`dump($values)`	TextPrinter	Echo one or more values in dump mode (see `idump`), with a header naming the calling file/line and a footer.
`emergency($message, $context)`	aModule	System is unusable. No-op if EMERGENCY is currently filtered out by the verbosity mask.
`error($message, $context)`	aModule	Runtime errors that do not require immediate action but should typically be logged and monitored.
`Export($value, $options, $type)`	aExporter	Export any value, dispatching to the right converter based on its type (or the explicit $type).
`exportClosure($value, $options)`	TextPrinter	Closure
`exportDump($value, $options)`	TextPrinter	The 'dump' type exporter -- same as `idump` but registered for explicit dispatch via `__invoke($v, [], 'dump')`.
`exportFilename($value, $options)`	TextPrinter	Render a relative filename
`exportInstance($value, $options)`	TextPrinter	object options: - {int} scope: binary combinaison of the class constants PROPERTY_*.
`exportLog($value, $options)`	TextPrinter	MMO\core\events\Log
`ExportProperties($value, $options)`	aExporter	Export an object `exportInstance` method
`exportRenderable($value, $options)`	TextPrinter
`exportResource($value, $options)`	TextPrinter	Resource
`exportSplObjectStorage($value, $options)`	TextPrinter
`exportsProperty($prop, $value)`	TextPrinter	Same as `aExporter::exportsProperty`, and a property marked #[NoDump] (a back-reference, such as a collection's repository) is not printed either: an object is printed without what its dump leav…
`exportThrowable($value, $options)`	TextPrinter
`exportTraces($value, $options)`	TextPrinter	MMO\core\messages\Log::traces
`exportValidatorError($value, $options)`	TextPrinter
`getClassFunction($class)`	aConverter	Find which registered type (a class or interface name) applies to $class: itself if directly registered, else the closest registered ancestor class or implemented interface.
`getFunction($type)`	aConverter
`getFunctions()`	aConverter
`getIndent($options)`	TextPrinter
`getOptions($type)`	aConverter
`getTemplate($name)`	TextPrinter
`getTemplates()`	TextPrinter
`getType($value, $allowClass)`	aConverter	Normalize $value's type into one of this converter's type names.
`getVerbosity()`	aModule
`hash($value, $options)`	TextPrinter
`hasTemplate($name)`	TextPrinter
`hasType($type)`	aConverter
`hiddenProperties($value)`	TextPrinter	The properties of $value whose value a dump does not show (`exportInstance`): for an `iArrayProperties` (an entity), those behind a hidden ArrayProperty (`ArrayProper…`
`idump($value, $options)`	TextPrinter
`info($message, $context)`	aModule	Interesting events. No-op if INFO is currently filtered out by the verbosity mask.
`Instantiate($config)`	aModule	(Re)create the shared instance immediately, configured with $config merged into the class's existing config.
`IsShared()`	aModule
`log($level, $message, $context)`	aModule	Logs with an arbitrary level.
`notice($message, $context)`	aModule	Normal but significant events.
`offsetExists($key)`	aModule	\ArrayAccess::offsetExists -- tells whether $key is a declared property at all, regardless of whether it is currently readable/writable through array access.
`offsetGet($key)`	aModule	\ArrayAccess::offsetGet -- reads a property directly, unless it has a `#[Serialize(serialize: 'methodName')]` attribute, in which case that zero-argument method is called instead (e.g.
`offsetSet($key, $value)`	aModule	\ArrayAccess::offsetSet -- sets a property directly, unless it has a `#[Serialize(unserialize: 'methodName')]` attribute, in which case that method is called with $value instead (e.g.
`offsetUnset($key)`	aModule	\ArrayAccess::offsetUnset -- equivalent to `$module[$key] = null`.
`Print($value, $options, $type)`	TextPrinter
`renderMaxLevel($value, $options)`	TextPrinter
`renderPrintError($e)`	TextPrinter	What a value whose exporter threw is printed as (`__invoke`): the exception's class and message, as text (`renderText`) -- never its stack trace.
`renderTemplate($name, $data)`	TextPrinter	Render a template
`renderText($text)`	TextPrinter	The text a template holds that comes from the value printed: the keys and property names of a dump (a decoded request body's...), a resource's uri, a validation error's message, a log's message and…
`resetHash($value, $options)`	aExporter	Forget that $value was already seen, within the given $options['hashes'] tracking map: the next time $value is encountered in this same export, it is exported in full again instead of collapsing to…
`serialize($path, $serializer)`	aModule	\MMO\core\interfaces\iSerializable::serialize -- exports every property (via
`setFunction($type, $fn, $options)`	aConverter	Set a coercer
`setFunctions($fns)`	aConverter	Register many functions at once, e.g.
`setOptions($type, $options)`	aConverter	Replace $type's options wholesale.
`setTemplate($name, $tpl)`	TextPrinter	Set template
`setTemplates($tpls)`	TextPrinter
`setVerbosity($verb)`	aModule	Set the current verbosity mask, replacing whatever it was before.
`Shared()`	aModule	Get the shared instance, creating (and configuring) it on first call.
`testVerbosity($level)`	aModule	Test whether a given level (or set of levels) is currently enabled by this instance's verbosity mask.
`traitUnshare($serialize)`	aModule	Remove the shared instance, so the next `Shared()` call creates a fresh one.
`unserialize($data, $path, $instances)`	aModule	\MMO\core\interfaces\iSerializable::unserialize -- merges $data onto `DefaultConfig`, runs it through the (possibly overridden) constructor, then applies each resulting value to its property (via
`Unshare($serialize)`	aModule	Like `tSingleton::Unshare`, but also disconnects this module's instance from every event it was listening to (via `Event::DisconnectListeners`) before dropping it.
`warning($message, $context)`	aModule	Exceptional occurrences that are not errors.
`__invoke($value, $options, $type)`	TextPrinter	Render $value. Never throws: a failing exporter's exception is caught and printed inline instead (its class and message: `renderPrintError`), and a type with no registered exporter falls back to…