__call()
__construct()
getConstants()
getDocBlock()
getFQCN()
getInterfacesNames()
getMethods()
getNode()
getProperties()
getSuperclassName()
inherit()
setNodes()
getDirectElementsByTagName()
importReflectedMethod()
inheritClassObject()
inheritConstants()
inheritInterfaceObject()
inheritMethods()
inheritProperties()
reflectExternalClass()
$is_processed
$node
$nodes
Responsible for adding inheritance behaviour to an individual class.
| category | phpDocumentor |
|---|---|
| package | Transformer |
| subpackage | Behaviour |
| author | Mike van Riel |
| license | MIT |
| link | http://phpdoc.org |
__call(string $name, \mixed[] $arguments) : mixed
| inherited_from | \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Abstract::__call() |
|---|
stringMethod name.
\mixed[]Array containing the method arguments.
mixed__construct(DOMElement $node, array $nodes)
| inherited_from | \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Abstract::__construct() |
|---|
\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class[]&$nodes Associative array containing all class/interface type nodes.
getConstants() : \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Constant
getDocBlock() : \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_DocBlock
| inherited_from | \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Abstract::getDocBlock() |
|---|
getFQCN() : string
stringgetInterfacesNames() : \string[]
\string[]getMethods() : \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Method[]
getNode() : \DOMElement
| inherited_from | \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Abstract::getNode() |
|---|
getProperties() : \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Property
getSuperclassName() : string
stringinherit(null $parent) : void
nullis not used in this method. Only there because it is required by the parent class.
setNodes(\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class[] $nodes)
| inherited_from | \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Abstract::setNodes() |
|---|
\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class[]&$nodes Associative array containing all class/interface type nodes.
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.
| inherited_from | \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Abstract::getDirectElementsByTagName() |
|---|
stringName of the element to find.
importReflectedMethod(ReflectionMethod $method) : \DOMElement | null
inheritClassObject(phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class $parent) : void
| todo | this method and inheritInterface should be separated into different objects |
|---|
\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_ClassParent class to inherit from.
inheritConstants(phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class $parent) : void
\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Classparent object to inherit constants from.
inheritInterfaceObject(phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class $parent) : void
| todo | this method and inheritClass should be separated into different objects |
|---|
\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_ClassParent interface to inherit from.
inheritMethods(phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class $parent) : void
\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Classparent object to inherit methods from.
inheritProperties(phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class $parent) : void
\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Classparent object to inherit properties from.
reflectExternalClass(string $parent_class_name) : void
This method is used when the parent class is not any of the files that were parsed by phpDocumentor but is obtainable in the path. For these files we want to import their methods so that the overview is complete. Examples of such classes are classes that are in PHP Core (i.e. Exception) or available via PECL extensions.
| todo | consider moving this to a separate object? |
|---|
stringFQCL of the external class.
$is_processed : bool
This is used for the algorythm that build the inheritance tree; whenever this class is instructed to start inheriting it will first check whether its parent interfaces and classes are processed. If not then those are processed first; by always processing the parents first you get a recursive algorythm where independent of your starting class you always end up with a bottom-to-top population mechanism. A positive side-effect is that no class is processed multiple times; optimizing performance.
$node : \DOMElement
| inherited_from | \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Abstract::$$node |
|---|
$nodes : \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class[]
| inherited_from | \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Abstract::$$nodes |
|---|