PDOExporter

MMO\pdo · 1 symbol · generated 5 Oct 2026

class

PDOExporter

Converts an entity's property values into values a SQL column can actually hold.

class MMO\pdo\PDOExporter extends MMO\core\classes\aExporter

Namespace: MMO\pdo
Extends: aExporter
See: PDORepository uses it for every value it writes

A column takes a scalar (or null), so everything richer has to be flattened: a date becomes a string in the column's own format, an enum becomes its case name, a referenced entity becomes its id (the foreign key), and anything still structured becomes JSON.

PDOExporter::Export($entity->get('born'), ['date-format' => 'Y-m-d']); // '1984-03-18'

Index

	DATETIME_FORMAT	The format used for a `DATETIME`/`TIMESTAMP` column.
	DATE_FORMAT	The format used for a `DATE` column.
	TIME_FORMAT	The format used for a `TIME` column.
	exportDateTime($value, $options)
	exportEntity($value, $options)	A referenced entity is stored as its id: that is what a foreign key column holds.
	exportEnum($value, $options)
	exportInstance($value, $options)	Any other object: its string form if it has one, otherwise a refusal rather than a silent `Array`/id.
	exportStructure($value, $options)	A column cannot hold a structure, so a list/map is stored as JSON.
	hash($value, $options)
	OptionsFor($type) static
	__construct($config)

Constants3

DATETIME_FORMAT

The format used for a DATETIME/TIMESTAMP column.

const DATETIME_FORMAT = 'Y-m-d H:i:s'

DATE_FORMAT

The format used for a DATE column.

const DATE_FORMAT = 'Y-m-d'

TIME_FORMAT

The format used for a TIME column.

const TIME_FORMAT = 'H:i:s'

Methods8

exportDateTime($value, $options)

PDOExporter.php:55

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

$value	mixed
$options = []	array	- date-format: {string} defaults to `DATETIME_FORMAT`
returns	string

exportEntity($value, $options)

PDOExporter.php:71

A referenced entity is stored as its id: that is what a foreign key column holds.

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

$value	mixed
$options = []	array
returns	mixed
throws		if the referenced entity has no id yet (it has to be committed first)

exportEnum($value, $options)

PDOExporter.php:60

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

$value	UnitEnum
$options = []	array
returns	string	the enum case's name -- matching what `Field` generates for an ENUM column.

exportInstance($value, $options)

PDOExporter.php:93

Any other object: its string form if it has one, otherwise a refusal rather than a silent Array/id.

function exportInstance(object $value, array $options = []): mixed

$value	object
$options = []	array
returns	mixed

exportStructure($value, $options)

PDOExporter.php:85

A column cannot hold a structure, so a list/map is stored as JSON.

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

$value	mixed
$options = []	array
returns	string

hash($value, $options)

PDOExporter.php:46

function hash(object $value, array $options = []): mixed

Cycle tracking exists to stop a recursive structure looping forever, by replacing a repeat occurrence with a hash. Here every object is flattened to a scalar in one step and never recursed into, so tracking would only misfire: the SAME date written to two columns would turn into a hash the second time.

See: aExporter::hash -- null opts every object out of cycle tracking.

$value	object
$options = []	array
returns	mixed

OptionsFor($type)

staticPDOExporter.php:102

static function OptionsFor(?string $type): array

$type	null \| string	a `Field::getType()` value
returns	array	the export options to use for a column of that type

__construct($config)

PDOExporter.php:26

protected function __construct(array &$config)

$config

array

Inherited members (68)

Constants	Declared by	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

	Properties	Declared by	Description
	`functions`	aConverter
	`globalOptions`	aConverter
	`verbosity`	aModule

Methods	Declared by	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()`	aConverter	Remove every registered type/function.
`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.
`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).
`exportArray($value, $options)`	aExporter	Built-in 'array' converter (a list): recursively exports every value, in place.
`exportObject($value, $options)`	aExporter	Built-in 'object' converter (an associative array): recursively exports every value, in place.
`ExportProperties($value, $options)`	aExporter	Export an object `exportInstance` method
`exportsProperty($prop, $value)`	aExporter	Whether `exportInstance` exports $prop of $value: not a static property -- it is the class's, not $value's -- nor an uninitialized one, which has no value (the properties `(array)$value` holds).
`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
`getOptions($type)`	aConverter
`getType($value, $allowClass)`	aConverter	Normalize $value's type into one of this converter's type names.
`getVerbosity()`	aModule
`hasType($type)`	aConverter
`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`.
`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.
`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)`	aExporter	The actual export entry point (also what `iExporter`'s `$exporter($value)` calling convention invokes).