DocType

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

class

DocType

One rendered type expression, already resolved: the display text plus, for every atom of it, where that atom is documented. Types are resolved once, at generation time (the generator has the reflection/parser context needed to know that Route means MMO\core\server\Route and where its page is) so that both renderers only ever have to print what is already here.

class MMO\doc\models\DocType extends MMO\doc\models\DocNode implements Stringable

Namespace: MMO\doc\models
Extends: DocNode
Implements: Stringable

``` ['text' => '?Route', 'separator' => '|', 'parts' => [ ['name' => 'null', 'short' => 'null', 'url' => 'https://www.php.net/...'], ['name' => 'MMO\core\server\Route', 'short' => 'Route', 'url' => 'documentation/mmo.core/php/server/Route.md#route'], ]] ```

Index

	defaults()
	isEmpty()
	part($name, $short, $url)
	text()
	__toString()

Methods5

defaults()

DocType.php:18

protected function defaults(): array

returns

array

isEmpty()

DocType.php:34

function isEmpty(): bool

returns

bool

true when there is nothing at all to print.

part($name, $short, $url)

DocType.php:28

function part(string $name, ?string $short = null, ?string $url = null): static

$name	string	the fully qualified (or primitive) type name
$short = null	null \| string	the name as it should be displayed (defaults to the last `\` segment)
$url = null	null \| string	where that type is documented, if anywhere
returns	static	$this, for chaining

text()

DocType.php:39

function text(): string

returns

string

the display text, rebuilt from the parts when it was not given explicitly.

__toString()

DocType.php:44

function __toString(): string

returns

string

Inherited members (20)

	Properties	Declared by	Description
	`content`	DocNode
	`nodeCache`	DocNode

Methods	Declared by	Description
`add($key, $node)`	DocNode	Append a child node under $key.
`clear()`	DocNode	Empty the underlying content, keeping the object itself.
`compact()`	DocNode	Drop every key whose value is null, '' or [] -- keeps the generated json readable and small.
`count()`	DocNode	\Countable::count
`Flatten($value)`	DocNode
`get($key, $default)`	DocNode	Read a key, without the "undefined array key" notice `$node['missing']` would raise (`tArray::offsetGet` returns by reference, so it cannot null-coalesce on its own).
`getIterator()`	DocNode	\IteratorAggregate::getIterator
`jsonSerialize()`	DocNode
`keys()`	DocNode
`loadArray($data)`	DocNode	Load every entry of a plain array into the content, through `offsetSet` (so any offsetSet() override defined by the class using this trait, e.g.
`nodes($key, $class)`	DocNode	Read a key as a list of child nodes, rebuilding each one into $class if it is still a plain array (which is what it is right after `json_decode`).
`offsetExists($key)`	DocNode	\ArrayAccess::offsetExists
`offsetGet($key)`	DocNode	\ArrayAccess::offsetGet
`offsetSet($key, $value)`	DocNode	Store a value, dropping whatever `nodes` had already rebuilt for that key.
`offsetUnset($key)`	DocNode	\ArrayAccess::offsetUnset -- on a list (sequential integer keys, as produced by `$bag[] = ...`), the element is spliced out (closing the gap and reindexing), matching \unset() semantics on a plain …
`storeValue($key, $value)`	DocNode	\ArrayAccess::offsetSet -- a null $key appends (`$bag[] = $value`), like a plain PHP array.
`toArray()`	DocNode	Recursively convert to plain arrays.
`__construct($data)`	DocNode