\Charcoal\ObjectHierarchicalInterface

hasMaster()

hasMaster() : boolean

Determine if this object has a direct parent.

Returns

isTopLevel()

isTopLevel() : boolean

Determine if this object is the head (top-level) of its hierarchy.

Top-level objects do not have a parent (master).

Returns

isLastLevel()

isLastLevel() : boolean

Determine if this object is the tail (last-level) of its hierarchy.

Last-level objects do not have a children.

Returns

hierarchyLevel()

hierarchyLevel() : integer

Retrieve this object's position (level) in its hierarchy.

Starts at "1" (top-level).

Returns

master()

master() : \Charcoal\Object\HierarchicalInterface|null

Retrieve this object's immediate parent.

Returns

toplevelMaster()

toplevelMaster() : \Charcoal\Object\HierarchicalInterface|null

Retrieve the top-level ancestor of this object.

Returns

hasParents()

hasParents() : boolean

Determine if this object has any ancestors.

Returns

hierarchy()

hierarchy() : array

Retrieve this object's ancestors (from immediate parent to top-level).

Returns

invertedHierarchy()

invertedHierarchy() : array

Retrieve this object's ancestors, inverted from top-level to immediate.

Returns

isMasterOf()

isMasterOf(mixed  $child) : boolean

Determine if the object is the parent of the given object.

Parameters

Returns

recursiveIsMasterOf()

recursiveIsMasterOf(mixed  $child) : boolean

Determine if the object is a parent/ancestor of the given object.

Parameters

Returns

hasChildren()

hasChildren() : boolean

Get wether the object has any children at all

Returns

numChildren()

numChildren() : integer

Get the number of chidlren directly under this object.

Returns

recursiveNumChildren()

recursiveNumChildren() : integer

Get the total number of children in the entire hierarchy.

This method counts all children and sub-children, unlike numChildren() which only count 1 level.

Returns

children()

children() : array

Get the children directly under this object.

Returns

isChildOf()

isChildOf(mixed  $master) : boolean

Parameters

Returns

The master object (or ident) to check against.

recursiveIsChildOf()

recursiveIsChildOf(mixed  $master) : boolean

Parameters

Returns

hasSiblings()

hasSiblings() : boolean

Returns

numSiblings()

numSiblings() : integer

Returns

siblings()

siblings() : array

Get all the objects on the same level as this one.

Returns

isSiblingOf()

isSiblingOf(mixed  $sibling) : boolean

Parameters

Returns