Index

XmlPrinter

MMO\core\printers · 1 symbol · generated 30 Sep 2026

class

XmlPrinter

XmlPrinter.php:10

A TextPrinter for XML output: the same templates as XML markup instead of plain text -- used for a document's inline "server console" log block (XmlDocument, rendered as XML comments -- see exportLog) and for XML dump output.

class MMO\core\printers\XmlPrinter extends MMO\core\printers\TextPrinter
Namespace
MMO\core\printers
Extends
TextPrinter
echo XmlPrinter::Print($someObject, ['dump' => true]);

Index

templates
exportLog($value, $options)Render a Log as an XML/HTML comment, e.g.

Properties1

templates

protected array $templates = […35 items]
Type
array

Methods1

exportLog($value, $options)

XmlPrinter.php:71

Render a Log as an XML/HTML comment, e.g. for the inline "server console" a document embeds (XmlDocument::createBody).

function exportLog(mixed $value, array $options = []): stringNOTE: this used to call `$value->render($options)`, but Log doesn't have a render() method (it isn't an
See
iRenderable) -- it always crashed with "Call to undefined method Log::render()" as soon as any log was actually recorded on an XML/HTML document. Fixed to reuse the parent TextPrinter's own (already correct, per-level-template-based) log formatting instead, just wrapped as a comment. NOTE: a comment must not contain -- (XML), and --> or --!> closes it (HTML), so every run of dashes is collapsed to one: a message quoting untrusted input cannot end the comment and inject markup. This used to replace pairs (str_replace('--', '-', ...)), which a longer run defeats: ---> came out as -->.
$valuemixed
$options = []array
returnsstring
Inherited members (101)
ConstantsDeclared byDescription
ALERTiLogLevelAlert: Action must be taken immediately.
ALLiLogLevelMask for all
ALL_PLUSiLogLeveldebug everything
BACKTRACEiLogLevel
CRITICALiLogLevelCritical: Critical conditions.
DEBUGiLogLevelDebug: Detailed debug information.
DEEPiLogLeveldebug everything with arguments
EMERGENCYiLogLevelEmergency: System is unusable.
ERRORiLogLevelError: Runtime errors that do not require immediate action but should typically be logged and monitored.
ERROR_PLUSiLogLevelMask for all error
FATALiLogLevelMask for all fatal error
INFOiLogLevelInfo: Interesting events.
INFO_PLUSiLogLevelMask for all errors/warning/notices/info
MEMORYiLogLevelinclude backtrace object
NOTICEiLogLevelNotice: Normal but significant events.
NOTICE_PLUSiLogLevelMask for all errors/warning/notices/info
TRACEiLogLevelinclude backtrace as origins
WARNINGiLogLevelWarning: Exceptional occurrences that are not errors.
WARNING_PLUSiLogLevelMask for all errors and warnings
PropertiesDeclared byDescription
functionsaConverter
globalOptionsTextPrinter
verbosityaModule
MethodsDeclared byDescription
addOptions($type, $options)aConverterMerge $options into $type's existing options (via merge), rather than replacing them wholesale like setOptions.
alert($message, $context)aModuleAction must be taken immediately.
backtraces($message, $context)aModuleForce-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)aConverterCall the function associated to a type
clear()TextPrinterReset both the exporter state (aExporter::clear) and $templates.
Configure($config)aModuleMerge $config into this module's configuration in the shared Configuration.
critical($message, $context)aModuleCritical conditions. No-op if CRITICAL is currently filtered out by the verbosity mask.
debug($message, $context)aModuleDetailed debug information.
debugName()aModuleHuman-readable identifier used as the default {origin} in this instance's log messages.
DefaultConfig()aModuleThe config a module starts from before anything loaded via Configuration is merged in.
dump($values)TextPrinterEcho one or more values in dump mode (see idump), with a header naming the calling file/line and a footer.
emergency($message, $context)aModuleSystem is unusable. No-op if EMERGENCY is currently filtered out by the verbosity mask.
error($message, $context)aModuleRuntime errors that do not require immediate action but should typically be logged and monitored.
Export($value, $options, $type)aExporterExport any value, dispatching to the right converter based on its type (or the explicit $type).
exportArray($value, $options)aExporterBuilt-in 'array' converter (a list): recursively exports every value, in place.
exportBoolean($value, $options)TextPrinterTypecast to a boolean and return template 'true' or 'false'
exportClosure($value, $options)TextPrinterClosure
exportDateTime($value, $options)TextPrinterRender a DatimeInterface
exportDump($value, $options)TextPrinterThe 'dump' type exporter -- same as idump but registered for explicit dispatch via __invoke($v, [], 'dump').
exportEntity($value, $options)TextPrinterAn entity (any iArrayProperties) is printed as its toArray() -- what an API returns of it -- the same as
exportEnum($value, $options)TextPrinter
exportFilename($value, $options)TextPrinterRender a relative filename
exportInstance($value, $options)TextPrinterobject options: - {int} scope: binary combinaison of the class constants PROPERTY_*.
exportNull($value, $options)TextPrinterReturn template 'null'
exportNumber($value, $options)TextPrinterFormat number
exportObject($value, $options)TextPrinterarray options: {HashList} hashes: the hash list {int|false} max-level: the max level to go to.
ExportProperties($value, $options)aExporterExport an object exportInstance method
exportRenderable($value, $options)TextPrinter
exportResource($value, $options)TextPrinterResource
exportSplObjectStorage($value, $options)TextPrinter
exportsProperty($prop, $value)TextPrinterSame 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…
exportString($value, $options)TextPrinterTypecast to a string
exportThrowable($value, $options)TextPrinter
exportTraces($value, $options)TextPrinterMMO\core\messages\Log::traces
exportValidatorError($value, $options)TextPrinter
getClassFunction($class)aConverterFind 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)aConverterNormalize $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)TextPrinterThe 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)aModuleInteresting 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)aModuleLogs with an arbitrary level.
notice($message, $context)aModuleNormal 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)TextPrinterWhat 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)TextPrinterRender a template
renderText($text)TextPrinterThe 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)aExporterForget 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)aConverterSet a coercer
setFunctions($fns)aConverterRegister many functions at once, e.g.
setOptions($type, $options)aConverterReplace $type's options wholesale.
setTemplate($name, $tpl)TextPrinterSet template
setTemplates($tpls)TextPrinter
setVerbosity($verb)aModuleSet the current verbosity mask, replacing whatever it was before.
Shared()aModuleGet the shared instance, creating (and configuring) it on first call.
testVerbosity($level)aModuleTest whether a given level (or set of levels) is currently enabled by this instance's verbosity mask.
traitUnshare($serialize)aModuleRemove 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)aModuleLike 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)aModuleExceptional occurrences that are not errors.
__construct($config)TextPrinter
__invoke($value, $options, $type)TextPrinterRender $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…