DocSymbol

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

class

DocSymbol

One top-level documented thing: a php class/interface/trait/enum/function, a javascript class/function/ namespace, or a .jhs custom element/view. Holds its own doc text, its signature, its relations and every member it declares.

class MMO\doc\models\DocSymbol extends MMO\doc\models\DocNode

Namespace: MMO\doc\models
Extends: DocNode
See: DocMember one constant, property, method, attribute, slot or css hook

Index

	KIND_CLASS
	KIND_CONSTANT
	KIND_ELEMENT
	KIND_ENUM
	KIND_FUNCTION
	KIND_INTERFACE
	KIND_MIXIN
	KIND_NAMESPACE
	KIND_TRAIT
	KIND_VIEW
	defaults()
	is($modifier)
	isSingle()
	members()
	membersOfKind($kind, $inherited)
	params()
	sections($inherited)

Constants10

KIND_CLASS

const KIND_CLASS = 'class'

KIND_CONSTANT

const KIND_CONSTANT = 'constant'

KIND_ELEMENT

const KIND_ELEMENT = 'element'

KIND_ENUM

const KIND_ENUM = 'enum'

KIND_FUNCTION

const KIND_FUNCTION = 'function'

KIND_INTERFACE

const KIND_INTERFACE = 'interface'

KIND_MIXIN

const KIND_MIXIN = 'mixin'

KIND_NAMESPACE

const KIND_NAMESPACE = 'namespace'

KIND_TRAIT

const KIND_TRAIT = 'trait'

KIND_VIEW

const KIND_VIEW = 'view'

Methods7

defaults()

DocSymbol.php:22

protected function defaults(): array

returns

array

is($modifier)

DocSymbol.php:83

function is(string $modifier): bool

$modifier	string
returns	bool

isSingle()

DocSymbol.php:109

function isSingle(): bool

returns

bool

true when the symbol has no member at all (a bare function, a marker interface).

members()

DocSymbol.php:74

function members(): array

returns

array

membersOfKind($kind, $inherited)

DocSymbol.php:92

function membersOfKind(string $kind, ?bool $inherited = null): array

$kind	string	one of `DocMember::KIND_*`
$inherited = null	null \| bool	null for every member, true/false to keep only the inherited/own ones
returns	array

params()

DocSymbol.php:79

function params(): array

returns

array

the parameters of a function symbol.

sections($inherited)

DocSymbol.php:100

function sections(?bool $inherited = null): array

$inherited = null	null \| bool
returns	array	every non-empty section, keyed by its title, in `DocMember::SECTIONS` order.

Inherited members (21)

	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
`isEmpty()`	DocNode
`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