Index

DocMember

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

class

DocMember

DocMember.php:9

One member of a symbol: a constant, a property, a method, a plain function, a custom element's attribute, a css hook or a slot. The kind says which, and drives both how it is grouped on the page and which of the keys below actually carry anything.

class MMO\doc\models\DocMember extends MMO\doc\models\DocNode
Namespace
MMO\doc\models
Extends
DocNode

Index

KIND_ATTRIBUTE
KIND_CONSTANT
KIND_CSS
KIND_EVENT
KIND_FUNCTION
KIND_METHOD
KIND_PROPERTY
KIND_SLOT
SECTIONS
badges()
defaults()
is($modifier)
isInherited()
offsetSet($key, $value)Modifiers are written as a full name => bool map by the reflectors (it reads better at the call site); only the true ones are worth keeping, so the generated json stays about what a symbol *is*.
params()
type()

Constants9

KIND_ATTRIBUTE

const KIND_ATTRIBUTE = 'attribute'

KIND_CONSTANT

const KIND_CONSTANT = 'constant'

KIND_CSS

const KIND_CSS = 'css'

KIND_EVENT

const KIND_EVENT = 'event'

KIND_FUNCTION

const KIND_FUNCTION = 'function'

KIND_METHOD

const KIND_METHOD = 'method'

KIND_PROPERTY

const KIND_PROPERTY = 'property'

KIND_SLOT

const KIND_SLOT = 'slot'

SECTIONS

const SECTIONS = […8 items]

Methods7

badges()

DocMember.php:96
function badges(): array
returnsarraythe modifier names that are actually set, in a stable, readable order.

isInherited()

DocMember.php:91
function isInherited(): bool
returnsbooltrue when the member is declared by another class/trait than the one being documented.

offsetSet($key, $value)

DocMember.php:71

Modifiers are written as a full name => bool map by the reflectors (it reads better at the call site); only the true ones are worth keeping, so the generated json stays about what a symbol *is*.

function offsetSet(mixed $key, mixed $value): void
$keymixed
$valuemixed
returnsvoid
Inherited members (20)
PropertiesDeclared byDescription
contentDocNode
nodeCacheDocNode
MethodsDeclared byDescription
add($key, $node)DocNodeAppend a child node under $key.
clear()DocNodeEmpty the underlying content, keeping the object itself.
compact()DocNodeDrop every key whose value is null, '' or [] -- keeps the generated json readable and small.
count()DocNode\Countable::count
Flatten($value)DocNode
get($key, $default)DocNodeRead 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)DocNodeLoad 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)DocNodeRead 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
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()DocNodeRecursively convert to plain arrays.
__construct($data)DocNode