MongoExporter

MMO\mongodb · 1 symbol · generated 5 Oct 2026

class

MongoExporter

class MMO\mongodb\MongoExporter extends MMO\core\classes\aExporter

Namespace: MMO\mongodb
Extends: aExporter

Index

	addLabelAndTitleFields($schema, $array)	Check if a $match aggregator contains the fields 'title' or 'label' and add a computed field to generate the title
	dateFormat($format, $safe)	Transform a php date format into a mongo format
	exportAnyEntity($value, $options)
	exportDateTime($value, $options)
	exportEntity($value, $options)
	exportFilter($value, $options)
	exportFilterGroup($value, $options)
	exportQuery($value, $options)
	exportUntouched($value, $options)
	extractText($match)	Take the $text search out of a $match: MongoDB only accepts it in the first stage of a pipeline.
	hash($value, $options)
	injectMatchIntoLookup($match, $lookup, $schema)	Inject $match into a $lookup pipeline
	makeObjectId($value, $options)	Used by exportFilter
	objectIdFromTimestamp($timestamp)
	templateToMongoField($schema, $key, $parentPath)	Generate a list for $concat operator to generate a template (used for label or title)
	__construct($config)

Methods16

addLabelAndTitleFields($schema, $array)

MongoExporter.php:243

Check if a $match aggregator contains the fields 'title' or 'label' and add a computed field to generate the title

protected function addLabelAndTitleFields(MMO\core\schemas\Schema $schema, array $array): array

$schema	Schema
$array	array
returns	array

dateFormat($format, $safe)

MongoExporter.php:38

Transform a php date format into a mongo format

function dateFormat(string $format, bool $safe = false): string

$format	string
$safe = false	bool
returns	string

exportAnyEntity($value, $options)

MongoExporter.php:196

function exportAnyEntity(MMO\core\interfaces\iEntity $value, array $options = []): array

$value	iEntity
$options = []	array
returns	array

exportDateTime($value, $options)

MongoExporter.php:205

function exportDateTime(DateTimeInterface $value, array $options = []): MongoDB\BSON\UTCDateTime

$value	DateTimeInterface
$options = []	array
returns	UTCDateTime
throws

exportEntity($value, $options)

MongoExporter.php:177

function exportEntity(MMO\core\entities\Entity $value, array $options = []): ?array

$value	Entity
$options = []	array
returns	null \| array

exportFilter($value, $options)

MongoExporter.php:347

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

$value	Filter
$options = []	array
returns	array

exportFilterGroup($value, $options)

MongoExporter.php:414

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

$value	FilterGroup
$options = []	array
returns	array

exportQuery($value, $options)

MongoExporter.php:419

function exportQuery(MMO\core\entities\Query $value, array $options = []): array

$value	Query
$options = []	array
returns	array

exportUntouched($value, $options)

MongoExporter.php:173

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

$value	mixed
$options = []	array
returns	mixed

extractText($match)

MongoExporter.php:313

Take the $text search out of a $match: MongoDB only accepts it in the first stage of a pipeline. It is found at the top of the match, or in one of its $and (nested, when a query mixes a group or a range with other filters): all of which must match anyway. Never in an $or or a $nor, whose meaning it would change.

protected function extractText(array &$match): mixed

$match	array	changed: without the $text (and without the $and member it leaves empty)
returns	mixed	the $text search, or null when there is none to take

hash($value, $options)

MongoExporter.php:165

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

$value	object
$options = []	array
returns	null \| array

injectMatchIntoLookup($match, $lookup, $schema)

MongoExporter.php:268

Inject $match into a $lookup pipeline

protected function injectMatchIntoLookup(array &$match, array &$lookup, ?MMO\core\schemas\Schema $schema = null): void

$match	array	the match aggregator
$lookup	array	a map of lookup organized by path
$schema = null	null \| Schema	the current schema for the match
returns	void

makeObjectId($value, $options)

MongoExporter.php:337

Used by exportFilter

function makeObjectId(mixed $value, array $options = []): MongoDB\BSON\ObjectId|array

$value	mixed
$options = []	array
returns	ObjectId \| array

objectIdFromTimestamp($timestamp)

MongoExporter.php:148

function objectIdFromTimestamp(int $timestamp): MongoDB\BSON\ObjectId

$timestamp	int
returns	ObjectId

templateToMongoField($schema, $key, $parentPath)

MongoExporter.php:220

Generate a list for $concat operator to generate a template (used for label or title)

protected function templateToMongoField(MMO\core\schemas\Schema $schema, string $key, string $parentPath = ''): array

$schema	Schema
$key	string	(SHOULD be 'label' or 'title')
$parentPath = ''	string
returns	array

__construct($config)

MongoExporter.php:18

protected function __construct(array &$config)

$config

array

Inherited members (70)

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.
`exportEnum($value, $options)`	aExporter	Built-in 'enum' converter.
`exportInstance($value, $options)`	aExporter	Built-in 'instance' converter: exports every property of $value (including protected/private ones, via reflection) recursively, tracking each property's path in `$options['path']` (e.g.
`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).