HtmlPrinter

MMO\doc · 1 symbol · generated 30 Sep 2026

class

HtmlPrinter

Renders a documentation page (DocPage) as html, for DocPageController.

class MMO\doc\HtmlPrinter extends MMO\core\printers\TextPrinter

Namespace: MMO\doc
Extends: TextPrinter

It is the exact counterpart of [`MarkdownPrinter`](https://mmoframework.fr/documentation/mmo.doc/php/MarkdownPrinter.md#markdownprinter) -- same model in, same sections, same anchors -- but where the markdown is written to stay portable, this one is written to be *used*: it leans on mmo.client's own elements (`<mmo-code>` for every signature, `<mmo-markdown>` for every description, `<mmo-doc-example>` for a runnable `@example`) and on the Simple CSS design system's tokens through `src/styles/documentation.scs`. No style is written inline: every class it emits is declared there. Nothing is fetched and nothing is computed at request time -- the model already holds resolved types, resolved links and the call graph, so rendering a page is a single pass over it.

$html = \MMO\doc\HtmlPrinter::Print($page, ['exampleUrl' => \MMO\url('doc/example/run')]);

Index

	defaultLanguage
	kindIcons
	markdownLevel
	code($source, $language)
	crumbs($crumbs)
	escape($text)
	examples($examples, $language, $options)	Every `@example`. A php one whose symbol is known becomes a runnable block: `<mmo-doc-example>` posts only `{symbol, index}`, and the server re-reads the code from that symbol's own doc comment…
	exportIndex($sections, $options)	The index page's body: every namespace, class, interface, trait, enum, exception, function, element… of every library, one section per kind (`DocIndex::Sections`).
	exportMember($member, $options)
	exportPage($page, $options)
	exportSymbol($symbol, $options)
	firstSentence($text)
	href($reference)	Resolve a reference to a url now, in the context of this request.
	index($sections)
	indexEntry($entry)	One line of the index page: what it is, its name -- namespace included, so two `entities` or two `Route`s are told apart at a glance --, what it does.
	inherited($symbol)
	inline($text)	Render the small subset of markdown a one-line summary actually uses, without pulling in a parser or an element for every cell of every table on the page.
	languageOf($symbol)
	lead($text)	The lead paragraph under a heading -- a symbol's or a member's summary.
	markdown($text)
	memberLabel($member)
	memberLanguage($symbol, $member)
	parameters($params, $return, $throws, $sees)	The contract of a callable, as one table: what goes in, what comes out, what can go wrong.
	reference($reference)
	relations($symbol)
	renderRail($page, $options)	The sticky outline: every symbol of the page, and under each one its members grouped by kind.
	renderTopbar($options)	The bar pinned at the top of every documentation page: the way back to the index.
	see($text, $sees)
	source($file, $line)
	type($type)
	usage($symbol)
	__construct($config)

Properties3

defaultLanguage

string $defaultLanguage = 'php'

Type: string

kindIcons

array $kindIcons = […13 items]

Type: array

markdownLevel

int $markdownLevel = 5

Type: int

Methods29

code($source, $language)

HtmlPrinter.php:523

function code(string $source, string $language): string

$source	string
$language	string
returns	string	a `<mmo-code>` block; the element highlights it client side through Prism.

crumbs($crumbs)

HtmlPrinter.php:640

protected function crumbs(array $crumbs): string

$crumbs	array
returns	string	the breadcrumb trail above the page title.

escape($text)

HtmlPrinter.php:658

function escape(?string $text): string

$text	null \| string
returns	string

examples($examples, $language, $options)

HtmlPrinter.php:496

Every @example. A php one whose symbol is known becomes a runnable block: <mmo-doc-example> posts only {symbol, index}, and the server re-reads the code from that symbol's own doc comment before running it in a sandbox (ExampleController) -- the browser never submits code.

protected function examples(array $examples, string $language, array $options): string

$examples	array
$language	string
$options	array
returns	string

exportIndex($sections, $options)

HtmlPrinter.php:151

The index page's body: every namespace, class, interface, trait, enum, exception, function, element… of every library, one section per kind (DocIndex::Sections). Each entry carries what the page's filters need (data-lib, data-lang, data-text), so filtering never goes back to the server.

function exportIndex(array $sections, array $options = []): string

$sections	array	kind => entries
$options = []	array	unused, kept for the printer's signature
returns	string

exportMember($member, $options)

HtmlPrinter.php:404

function exportMember(MMO\doc\models\DocMember $member, array $options = []): string

$member	DocMember
$options = []	array
returns	string

exportPage($page, $options)

HtmlPrinter.php:70

function exportPage(MMO\doc\models\DocPage $page, array $options = []): string

$page	DocPage
$options = []	array	`exampleUrl`: where `ExampleController` runs a snippet (no run button without it); `crumbs`: `[label => url\|null]` shown above the title
returns	string	the page body -- the rail is rendered separately, `renderRail`

exportSymbol($symbol, $options)

HtmlPrinter.php:243

function exportSymbol(MMO\doc\models\DocSymbol $symbol, array $options = []): string

$symbol	DocSymbol
$options = []	array
returns	string

firstSentence($text)

HtmlPrinter.php:678

protected function firstSentence(string $text): string

$text	string
returns	string	the first sentence of a text -- what an index row or a tooltip has room for. A summary written across several lines would otherwise blow a table row up to five lines high

href($reference)

HtmlPrinter.php:610

Resolve a reference to a url now, in the context of this request.

function href(array $reference): ?string

A generated page is stored as a path (`mmo.core/php/server/Route.md`) rather than a url, because the generator usually runs from a shell where `{siteurl}` means nothing -- [`Documentor::getPagePath`](https://mmoframework.fr/documentation/mmo.doc/php/Documentor.md#documentor-getpagepath). An external target (php.net) is already absolute and is used as it is.

$reference	array
returns	null \| string

index($sections)

HtmlPrinter.php:326

protected function index(array $sections): string

$sections	array
returns	string	the member index -- the whole api of a symbol on one screen

indexEntry($entry)

HtmlPrinter.php:204

One line of the index page: what it is, its name -- namespace included, so two entities or two Routes are told apart at a glance --, what it does. A guide has no namespace: the folder it sits in says where it is.

protected function indexEntry(array $entry): string

$entry	array
returns	string

inherited($symbol)

HtmlPrinter.php:349

protected function inherited(MMO\doc\models\DocSymbol $symbol): string

$symbol	DocSymbol
returns	string	the inherited members, folded away but linked to wherever they are really documented.

inline($text)

HtmlPrinter.php:564

Render the small subset of markdown a one-line summary actually uses, without pulling in a parser or an element for every cell of every table on the page.

function inline(string $text): string

The result is always **one line**: this feeds table cells and lead paragraphs, and a source comment wrapped over three lines is still one sentence.

$text	string
returns	string	html -- escaped first, so nothing in the source can inject markup

languageOf($symbol)

HtmlPrinter.php:685

protected function languageOf(MMO\doc\models\DocSymbol $symbol): string

$symbol	DocSymbol
returns	string	the fenced-code language a symbol's own declaration is highlighted as.

lead($text)

HtmlPrinter.php:545

The lead paragraph under a heading -- a symbol's or a member's summary.

function lead(string $text): string

Most summaries are one sentence wrapped over a few source lines, and those only need the cheap inline pass. A few really are markdown (a heading, a list, a fenced block), and paying for an `<mmo-markdown>` on those, and only those, keeps a page of ninety members from instantiating ninety elements.

$text	string
returns	string

markdown($text)

HtmlPrinter.php:532

function markdown(string $text): string

$text	string	markdown
returns	string	an `<mmo-markdown>` block. The text is entity-encoded on purpose: the element decodes its own `innerHTML` before parsing it, so anything that looks like a tag survives intact

memberLabel($member)

HtmlPrinter.php:663

protected function memberLabel(MMO\doc\models\DocMember $member): string

$member	DocMember
returns	string	how a member is labelled, identically to `MarkdownPrinter::memberLabel`.

memberLanguage($symbol, $member)

HtmlPrinter.php:697

protected function memberLanguage(MMO\doc\models\DocSymbol $symbol, MMO\doc\models\DocMember $member): string

$symbol	DocSymbol
$member	DocMember
returns	string	the language that member's signature is highlighted as -- markup for the parts that really are markup (an attribute, a slot, a css hook), the host language for everything else

parameters($params, $return, $throws, $sees)

HtmlPrinter.php:458

The contract of a callable, as one table: what goes in, what comes out, what can go wrong.

protected function parameters(array $params, ?array $return, array $throws, array $sees = []): string

$params	array
$return	null \| array
$throws	array
$sees = []	array	the `@see` references of the callable, `see`
returns	string

reference($reference)

HtmlPrinter.php:592

function reference(?array $reference): string

$reference	null \| array	a `{name, short, page, anchor, url}` reference
returns	string	a link to wherever it is documented, or inline code when it is documented nowhere

relations($symbol)

HtmlPrinter.php:296

protected function relations(MMO\doc\models\DocSymbol $symbol): string

$symbol	DocSymbol
returns	string	the extends/implements/uses/source definition list, or '' when there is nothing to say.

renderRail($page, $options)

HtmlPrinter.php:98

The sticky outline: every symbol of the page, and under each one its members grouped by kind. This is the page's navigation -- the reason a 90-method class stays usable.

function renderRail(MMO\doc\models\DocPage $page, array $options = []): string

$page	DocPage
$options = []	array
returns	string

renderTopbar($options)

HtmlPrinter.php:130

The bar pinned at the top of every documentation page: the way back to the index. It has no search box: the documentation is searched from <mmo-app>'s command palette, the one search box of the application (addSearchSource).

function renderTopbar(array $options = []): string

$options = []	array	`indexUrl`: the index page; `current`: true on the index itself
returns	string

\MMO\doc\HtmlPrinter::Shared()->renderTopbar(['indexUrl' => \MMO\url('documentation')]);

see($text, $sees)

HtmlPrinter.php:584

function see(string $text, array $sees): string

$text	string	markdown
$sees	array	the `@see` references of the node the text belongs to
returns	string	$text, each of its `@see` references turned into a markdown link to wherever its target is documented (`linkSees`) -- `inline` and `<mmo-markdown>` both render those

source($file, $line)

HtmlPrinter.php:629

function source(?string $file, ?int $line): string

$file	null \| string
$line	null \| int
returns	string	the "where this is written" link, in the header's far right.

type($type)

HtmlPrinter.php:616

function type(MMO\doc\models\DocType $type): string

$type	DocType
returns	string	every atom of a type, each linked to wherever it is documented.

usage($symbol)

HtmlPrinter.php:372

protected function usage(MMO\doc\models\DocSymbol $symbol): string

$symbol	DocSymbol
returns	string	the call graph slice, rendered server side (the model already holds it).

__construct($config)

HtmlPrinter.php:51

protected function __construct(array &$config)

$config

array

Inherited members (102)

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`	TextPrinter
	`templates`	TextPrinter
	`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()`	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).
`exportArray($value, $options)`	aExporter	Built-in 'array' converter (a list): recursively exports every value, in place.
`exportBoolean($value, $options)`	TextPrinter	Typecast to a boolean and return template 'true' or 'false'
`exportClosure($value, $options)`	TextPrinter	Closure
`exportDateTime($value, $options)`	TextPrinter	Render a DatimeInterface
`exportDump($value, $options)`	TextPrinter	The 'dump' type exporter -- same as `idump` but registered for explicit dispatch via `__invoke($v, [], 'dump')`.
`exportEntity($value, $options)`	TextPrinter	An entity (any `iArrayProperties`) is printed as its toArray() -- what an API returns of it -- the same as
`exportEnum($value, $options)`	TextPrinter
`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
`exportNull($value, $options)`	TextPrinter	Return template 'null'
`exportNumber($value, $options)`	TextPrinter	Format number
`exportObject($value, $options)`	TextPrinter	array options: {HashList} hashes: the hash list {int\|false} max-level: the max level to go to.
`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…
`exportString($value, $options)`	TextPrinter	Typecast to a string
`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…