Base class for adding inheritance to an element.

category phpDocumentor
package Transformer
subpackage Behaviour
author Mike van Riel
license MIT
link http://phpdoc.org

 Methods

Passes all unknown method directly into the node.

__call(string $name, \mixed[] $arguments) : mixed

Parameters

$name

string

Method name.

$arguments

\mixed[]

Array containing the method arguments.

Returns

mixed

Load the node belonging to this object and make an associative array of classes and interfaces available.

__construct(DOMElement $node, array $nodes) 

Parameters

$node

\DOMElement

Node that needs to be decorated by this class.

$nodes

\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class[]

&$nodes Associative array containing all class/interface type nodes.

Returns the docblock element for the given node; if none exists it will be added.

getDocBlock() : \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_DocBlock

Returns the contained node.

getNode() : \DOMElement

Returns

Derived methods will inherit properties from the parent object into this one.

inherit(\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Abstract $parent) : void

Parameters

Sets the nodes.

setNodes(\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class[] $nodes) 

Parameters

$nodes

\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class[]

&$nodes Associative array containing all class/interface type nodes.

Returns the elements with the given tag name that can be found as direct children of $node.

getDirectElementsByTagName(\DOMElement | \InheritClass $node, string $element_name) : \DOMElement[]

getElementsByTagName returns all DOMElements with the given tag name regardless where in the DOM subtree they are. This method checks whether the parent node matches the given node and thus determines whether it is a direct child.

Parameters

$node

\DOMElement\InheritClass

Node to search in.

$element_name

string

Name of the element to find.

Returns

 Properties

 

$node

$node : \DOMElement