DocPageController

MMO\doc\controllers · 1 symbol · generated 30 Sep 2026

class

DocPageController

Renders a generated documentation page as real html, instead of dropping its markdown into an <mmo-markdown>.

class MMO\doc\controllers\DocPageController extends MMO\core\classes\aController

Namespace: MMO\doc\controllers
Extends: aController

It reads the `.json` model the generator writes next to every `.md` page ([`DocPage`](https://mmoframework.fr/documentation/mmo.doc/php/models/DocPage.md#docpage)) and hands it to [`HtmlPrinter`](https://mmoframework.fr/documentation/mmo.doc/php/HtmlPrinter.md#htmlprinter), which paints it with mmo.client's own elements and the Simple CSS design system (`src/styles/documentation.scs`). Nothing is reflected, parsed or fetched at request time: the model already holds resolved types, resolved cross links and the call graph. ### How it takes over It claims `documentation*` at a lower `order` than `MMO\client\controllers\PageController`'s catch-all `**` (1000), so it runs first -- and only calls [`Route::stop`](https://mmoframework.fr/documentation/mmo.core/php/server/Route.md#route-stop) when it really has a model to render. A page without one (a hand-written `.md`, a pdf, anything else in a library's documentation folder) is left alone, and `PageController` handles it exactly as before -- under the top bar this controller puts at the top of every documentation page (the way back to the index, and the search box). `documentation` itself is the index of everything documented ([`renderIndex`](https://mmoframework.fr/documentation/mmo.doc/php/controllers/DocPageController.md#docpagecontroller-renderindex)).

Index

	ROOT
	cssClass
	indexTemplate
	template
	decorate($document, $content, $page, $trail)	Give the document the chrome a page of the site is expected to have: a title, a description, the sibling navigation and the breadcrumbs -- the same things `PageController` would have added had it h…
	findContent($route, $trail)	Walk the page tree the way `PageController` does, and return the content the url points at -- but only when it is a documentation page carrying a model (`includeDocumentation`, which re…
	IndexUrl() static
	onRoute($route)	Never claims the route: this listener runs before `PageController`'s (-10 vs -9), and claiming would make `PageController` drop out of the route -- leaving nobody to render the pages this controlle…
	relpath($route)
	renderIndex($route)	The index of the whole documentation: every namespace, class, interface, trait, enum, exception, function, element… of every installed library (`DocIndex::Sections`).
	routeDocumentation($route)
	TopbarOptions() static	The top bar has no search box of its own: the documentation is searched from the application's command palette (`addSearchSource`), the one search box of the application.

Constants1

ROOT

const ROOT = 'documentation'

Properties3

cssClass

string $cssClass = 'doc'

Type: string

indexTemplate

string $indexTemplate = 'doc/index.phtml'

Type: string

template

string $template = 'doc/page.phtml'

Type: string

Methods8

decorate($document, $content, $page, $trail)

DocPageController.php:202

Give the document the chrome a page of the site is expected to have: a title, a description, the sibling navigation and the breadcrumbs -- the same things PageController would have added had it handled the route itself.

protected function decorate( MMO\core\documents\HtmlDocument $document, MMO\client\entities\File $content, MMO\doc\models\DocPage $page, array $trail ): void

$document	HtmlDocument
$content	File
$page	DocPage
$trail	array	the `label => url` trail leading to the page, page included
returns	void

findContent($route, $trail)

DocPageController.php:169

Walk the page tree the way PageController does, and return the content the url points at -- but only when it is a documentation page carrying a model (includeDocumentation, which records it as data.model). Anything else returns null, so the normal page controller keeps the route.

protected function findContent(MMO\core\server\Route $route, ?array &$trail = null): ?MMO\client\entities\File

$route	Route
$trail = null	null \| array	filled with the `label => url` trail leading to the page, page included
returns	null \| File

IndexUrl()

staticDocPageController.php:143

static function IndexUrl(): string

returns string the url of the documentation index, renderIndex

onRoute($route)

DocPageController.php:54

Never claims the route: this listener runs before PageController's (-10 vs -9), and claiming would make PageController drop out of the route -- leaving nobody to render the pages this controller passes on (a library's index, a hand-written .md...). It only takes over, in routeDocumentation, when it really has a model to render.

function onRoute(MMO\core\server\Route $route): bool

$route	Route
returns	bool

relpath($route)

DocPageController.php:157

protected function relpath(MMO\core\server\Route $route): string

$route	Route
returns	string	the path of the page asked for, from the site's root: `documentation/mmo.core/php/Route.md`

renderIndex($route)

DocPageController.php:122

The index of the whole documentation: every namespace, class, interface, trait, enum, exception, function, element… of every installed library (DocIndex::Sections). It is what documentation itself shows, and what the top bar of every other page links back to.

function renderIndex(MMO\core\server\Route $route): void

$route	Route
returns	void

routeDocumentation($route)

DocPageController.php:65

#[MMO\core\attributes\APIRoute('documentation/**', 'Render a generated documentation page as html.', order: 900, mediaTypes: ['html'])] function routeDocumentation(MMO\core\server\Route $route): void

$route	Route
returns	void

TopbarOptions()

staticDocPageController.php:152

The top bar has no search box of its own: the documentation is searched from the application's command palette (addSearchSource), the one search box of the application.

static function TopbarOptions(): array

returns array the options of HtmlPrinter::renderTopbar

Inherited members (55)

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
	`verbosity`	aModule

Methods	Declared by	Description
`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).
`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.
`ExtractRoutes($config)`	aController	Extract all the APIRoute from this class, regardless of the fact they are registered in the application
`getVerbosity()`	aModule
`HasRoutes()`	aController	Tells if any APIRoute are registered in the application
`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
`Link($method, $data)`	aController	Build a `Link` (URL + label/icon/description/title, taken from the route's APIRoute metadata) for a registered route.
`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`.
`Route($method)`	aController	Get a registered APIRoute WARNING: if this class was not registered in the application, it will return null.
`Routes()`	aController	Get a list of registered APIRoutes (from this class) in the application WARNING: if this class was not registered in the application, it will return an empty array.
`serialize($path, $serializer)`	aModule	\MMO\core\interfaces\iSerializable::serialize -- exports every property (via
`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.
`Url($method, $data)`	aController	Build the URL for a registered route, filling in any `{placeholder}` from $data.
`warning($message, $context)`	aModule	Exceptional occurrences that are not errors.
`__construct($config)`	aModule	protected constructor, so it is not possible to do `new Module(...)` called by the serialization process just before being injected with data.
`__wakeup()`	aController	Called automatically right after the controller's shared instance is built (`aModule::unserialize`): registers `onRoute` as a Route listener with a low priority (-10), so it…