JsonPrinter

MMO\core\printers · 1 symbol · generated 5 Oct 2026

class

JsonPrinter

Converts any value into a plain, json_encode()-ready structure (see Encode/EncodeFile). Entities (Entity/iEntity) are exported via their own array/link representation, honoring the 'store'/'list'/'embedded'/'fields' options threaded through recursively; a cyclic reference is broken into a JSON-pointer-style {"$ref": "#/path"} (see hash), or, for an Entity, a link to it instead (Entity::toLink).

class MMO\core\printers\JsonPrinter extends MMO\core\classes\aExporter

Namespace: MMO\core\printers
Extends: aExporter

JsonPrinter::Encode(['user' => $entity, 'when' => new \DateTime()]);

Index

	Encode($value, $options, $flags, $depth) static	Export $value and JSON-encode the result.
	EncodeFile($filename, $value, $options, $flags, $depth) static
	exportAnyEntity($value, $options)	Like `exportEntity`, for any `iEntity` that isn't a full `Entity` (no link/embedding shortcut, no 'fields' filter).
	exportDateTime($value, $options)
	exportEntity($value, $options)	Export an `Entity`: a link (`Entity::toLink`) instead of its full content when listing it, or when it's nested (embedded) inside another entity that's itself being 'store'd; otherwise its ful…
	exportEnum($value, $options)
	exportException($value, $options)	NOTE: this used to be registered under `\Exception::class` only -- but `\Error` (TypeError, ValueError, ArgumentCountError, etc.) doesn't extend `\Exception`, it's a separate `\Throwable` implement…
	exportJsonSerializable($value, $options)
	hash($value, $options)	Break a cyclic/repeated object reference.
	IsEntityList($value) static
	link($value, $options)
	__construct($config)

Methods12

Encode($value, $options, $flags, $depth)

staticJsonPrinter.php:173

Export $value and JSON-encode the result.

static function Encode( mixed $value, MMO\core\interfaces\iOptions|array $options = [], int $flags = 0, int $depth = 512 ): string

$value	mixed
$options = []	iOptions \| array
$flags = 0	int	`json_encode()` flags.
$depth = 512	int
returns	string
throws

JsonPrinter::Encode(['a' => 1]); // '{"a":1}'

JsonPrinter::Encode($people, new PrintOptions(fields: ['name', 'email']));

EncodeFile($filename, $value, $options, $flags, $depth)

staticJsonPrinter.php:188

static function EncodeFile( string $filename, mixed $value, MMO\core\interfaces\iOptions|array $options = [], int $flags = 0, int $depth = 512 ): void

See: Encode $value, writing the result to $filename. 'basepath' (for relative-filename rendering) defaults to $filename's own directory.

$filename	string
$value	mixed
$options = []	iOptions \| array
$flags = 0	int
$depth = 512	int
returns	void

exportAnyEntity($value, $options)

JsonPrinter.php:149

Like exportEntity, for any iEntity that isn't a full Entity (no link/embedding shortcut, no 'fields' filter).

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

$value	iEntity
$options = []	array
returns	array

exportDateTime($value, $options)

JsonPrinter.php:82

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

$value	DateTimeInterface
$options = []	array
returns	string	an ISO-8601-style date string (see `json`).

exportEntity($value, $options)

JsonPrinter.php:122

Export an Entity: a link (Entity::toLink) instead of its full content when listing it, or when it's nested (embedded) inside another entity that's itself being 'store'd; otherwise its full array form (Entity::toArray, or Entity::store for the 'store' option), each field recursively exported.

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

$value	Entity
$options = []	array	'list'/'store'/'embedded' as above; 'fields' restricts which fields are exported.
returns	array \| string

exportEnum($value, $options)

JsonPrinter.php:110

function exportEnum(UnitEnum $value, array $options)

$value	UnitEnum
$options	array
returns		its backing value, or its case name for a pure (non-backed) enum.

exportException($value, $options)

JsonPrinter.php:98

NOTE: this used to be registered under \Exception::class only -- but \Error (TypeError, ValueError, ArgumentCountError, etc.) doesn't extend \Exception, it's a separate \Throwable implementation, so an \Error never matched and silently fell through to the generic reflection-based 'instance' exporter instead: that exposes ALL of \Error's properties, including the absolute source file path and line -- an information-disclosure risk for anything that JSON-encodes a caught error into an API response.

function exportException(Throwable $value, array $options = []): array

Fixed by registering under `\Throwable::class` (covering both `\Exception` and `\Error`) instead, so every throwable consistently gets just this safe, minimal shape.

$value	Throwable
$options = []	array
returns	array	{'type': the exception/error's class name, 'message': its message}

exportJsonSerializable($value, $options)

JsonPrinter.php:72

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

$value	object	a \JsonSerializable.
$options = []	array
returns	mixed	its jsonSerialize() result, recursively exported if that's an array.

hash($value, $options)

JsonPrinter.php:39

Break a cyclic/repeated object reference.

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

$value	object
$options = []	array
returns	array \| string	an Entity link when listing/storing an already-seen Entity, otherwise a `{"$ref": "#/path"}` pointer.

IsEntityList($value)

staticJsonPrinter.php:49

static function IsEntityList(mixed $value): bool

$value	mixed
returns	bool	true if $value is a non-empty list of stored entities (`Entity`), which `exportEntity` names rather than exports when it is met inside another entity

JsonPrinter::IsEntityList([$company, $other]); // true

link($value, $options)

JsonPrinter.php:63

protected function link(MMO\core\entities\Entity $value, array $options): string

$value	Entity	an entity only named, not exported
$options	array
returns	string	its link (`Entity::toLink`) -- stored (`store`), a JsonRepository's entity as the files name it, by its file's name (`JsonRepository::Reference`): its uid would tie them to their folder

__construct($config)

JsonPrinter.php:21

protected function __construct(array &$config)

$config

array

Inherited members (69)

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.
`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).