phpDocumentor
Back to top  

Responsible for adding inheritance behaviour to an individual constant.

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
Inherited

inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Abstract::__call()
inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Property::__call()

Parameters

$name

string

Method name.

$arguments

\mixed[]

Array containing the method arguments.

Returns

mixed

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

__construct(DOMElement $node, array $nodes, phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class $class) 
Inherited

inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Property::__construct()

Parameters

$node

\DOMElement

Node to decorate.

$nodes

array

&$nodes List of classes/interface elements

$class

\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class

Class to which this property belongs.

Copies this object onto the give class or interface.

copyTo(phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class $class_or_interface) : void
Inherited

inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Property::copyTo()

Parameters

$class_or_interface

\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class

Object to copy this property onto.

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

getDocBlock() : \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_DocBlock
Inherited

inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Abstract::getDocBlock()
inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Property::getDocBlock()

Returns

\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_DocBlock

Returns the name.

getName() : string
Inherited

inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Property::getName()

Returns

string

Returns the contained node.

getNode() : \DOMElement
Inherited

inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Abstract::getNode()
inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Property::getNode()

Returns

\DOMElement

Returns the full string identifier of this constant.

getReferrerString(string | null $parent_class_name) : string

Example: MyClass::CONSTANT

Parameters

$parent_class_name

stringnull

The class name to use; if null uses the current class name.

Returns

string

Inherits the properties of an element in another class.

inherit(\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Property $parent) : void
Inherited

inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Property::inherit()

Parameters

$parent

\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Property

parent property to inherit from.

Sets the nodes.

setNodes(\phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class[] $nodes) 
Inherited

inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Abstract::setNodes()
inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Property::setNodes()

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[]
Inherited

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()
inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Property::getDirectElementsByTagName()

Parameters

$node

\DOMElement\InheritClass

Node to search in.

$element_name

string

Name of the element to find.

Returns

\DOMElement[]

 Properties

 

$class

$class : \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class
Inherited

inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Property::$$class
 

<p>Defined which tags to inherit</p>

$inherited_tags : \string[]
Inherited

inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Property::$$inherited_tags
 

$node

$node : \DOMElement
Inherited

inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Abstract::$$node
inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Property::$$node
 

$nodes

$nodes : \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Class[]
Inherited

inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Abstract::$$nodes
inherited_from \phpDocumentor_Plugin_Core_Transformer_Behaviour_Inherit_Node_Property::$$nodes