Class Node

A node in the PHP syntax tree.

Pharborist\Node implements Pharborist\NodeInterface

Direct known subclasses

Pharborist\ParentNode, Pharborist\TokenNode

Indirect known subclasses

Abstract
Namespace: Pharborist
Located at Node.php

Methods summary
`public Pharborist\ParentNode`	# `parent( callable $callback = NULL )` Get the parent node. Get the parent node. Parameters `$callback` An optional callback to filter by. Returns `Pharborist\ParentNode` Implementation of `Pharborist\NodeInterface::parent()`
`public Pharborist\NodeCollection`	# `parents( callable $callback = NULL )` Get the ancestors of this node. Get the ancestors of this node. Parameters `$callback` An optional callback to filter by. Returns `Pharborist\NodeCollection` Implementation of `Pharborist\NodeInterface::parents()`
`public Pharborist\NodeCollection`	# `parentsUntil( callable $callback, boolean $inclusive = FALSE )` Get ancestors up to the node matched by callback. Get ancestors up to the node matched by callback. Parameters `$callback` Callback to test for match. `$inclusive` TRUE to include the node matched by callback. Returns `Pharborist\NodeCollection` Implementation of `Pharborist\NodeInterface::parentsUntil()`
`public Pharborist\Node`	# `closest( callable $callback )` Get the first node matched by the callback by testing this node and traversing up through its ancestors in the tree. Get the first node matched by the callback by testing this node and traversing up through its ancestors in the tree. Parameters `$callback` Callback to test for match. Returns `Pharborist\Node` Implementation of `Pharborist\NodeInterface::closest()`
`public Pharborist\Node`	# `furthest( callable $callback )` Get the last node matched by the callback by testing this node and traversing up through its ancestors in the tree. Get the last node matched by the callback by testing this node and traversing up through its ancestors in the tree. Parameters `$callback` Callback to test for match. Returns `Pharborist\Node` Implementation of `Pharborist\NodeInterface::furthest()`
`public integer`	# `index( )` Get the position of the element relative to its sibling elements. Get the position of the element relative to its sibling elements. Returns integer Implementation of `Pharborist\NodeInterface::index()`
`public Pharborist\Node`	# `previous( callable $callback = NULL )` Get the previous sibling. Get the previous sibling. Parameters `$callback` An optional callback to filter by. Returns `Pharborist\Node` Implementation of `Pharborist\NodeInterface::previous()`
`public Pharborist\NodeCollection`	# `previousAll( callable $callback = NULL )` Get the previous siblings of this node. Get the previous siblings of this node. Parameters `$callback` An optional callback to filter by. Returns `Pharborist\NodeCollection` Implementation of `Pharborist\NodeInterface::previousAll()`
`public Pharborist\NodeCollection`	# `previousUntil( callable $callback, boolean $inclusive = FALSE )` Get all the preceding siblings up to but not including the match. Get all the preceding siblings up to but not including the match. Parameters `$callback` Callback to test for match. `$inclusive` TRUE to include the node matched by callback. Returns `Pharborist\NodeCollection` Implementation of `Pharborist\NodeInterface::previousUntil()`
`public Pharborist\Node`	# `next( callable $callback = NULL )` Get the next immediate sibling. Get the next immediate sibling. Parameters `$callback` An optional callback to filter by. Returns `Pharborist\Node` Implementation of `Pharborist\NodeInterface::next()`
`public Pharborist\NodeCollection`	# `nextAll( callable $callback = NULL )` Get all the following siblings. Get all the following siblings. Parameters `$callback` An optional callback to filter by. Returns `Pharborist\NodeCollection` Implementation of `Pharborist\NodeInterface::nextAll()`
`public Pharborist\NodeCollection`	# `nextUntil( callable $callback, boolean $inclusive = FALSE )` Get all the following siblings up to but not including the match. Get all the following siblings up to but not including the match. Parameters `$callback` Callback to test for match. `$inclusive` TRUE to include the node matched by callback. Returns `Pharborist\NodeCollection` Implementation of `Pharborist\NodeInterface::nextUntil()`
`public Pharborist\NodeCollection`	# `siblings( callable $callback = NULL )` Get the siblings. Get the siblings. Parameters `$callback` An optional callback to filter by. Returns `Pharborist\NodeCollection` Implementation of `Pharborist\NodeInterface::siblings()`
`public`	# `insertBefore( Pharborist\Node\|Pharborist\Node[]\|Pharborist\NodeCollection $targets )` Insert this node before targets. Insert this node before targets. Parameters `$targets` Nodes to insert before. Returns $this Implementation of `Pharborist\NodeInterface::insertBefore()`
`public`	# `before( Pharborist\Node\|Pharborist\Node[]\|Pharborist\NodeCollection $nodes )` Insert nodes before this node. Insert nodes before this node. Parameters `$nodes` Nodes to insert. Returns $this Implementation of `Pharborist\NodeInterface::before()`
`public`	# `insertAfter( Pharborist\Node\|Pharborist\Node[]\|Pharborist\NodeCollection $targets )` Insert this node after targets. Insert this node after targets. Parameters `$targets` Nodes to insert after. Returns $this Implementation of `Pharborist\NodeInterface::insertAfter()`
`public`	# `after( Pharborist\Node\|Pharborist\Node[]\|Pharborist\NodeCollection $nodes )` Insert nodes after this node. Insert nodes after this node. Parameters `$nodes` Nodes to insert. Returns $this Implementation of `Pharborist\NodeInterface::after()`
`public`	# `remove( )` Remove this node from its parent. Remove this node from its parent. Returns $this Implementation of `Pharborist\NodeInterface::remove()`
`public`	# `replaceWith( Pharborist\Node\|Pharborist\Node[]\|Pharborist\NodeCollection\|callable $nodes )` Replace this node with another node. Replace this node with another node. Parameters `$nodes` $node Replacement node. Returns $this Implementation of `Pharborist\NodeInterface::replaceWith()`
`public`	# `replaceAll( Pharborist\Node\|Pharborist\Node[]\|Pharborist\NodeCollection $targets )` Replace nodes with this node. Replace nodes with this node. Parameters `$targets` Nodes to replace. Returns $this Implementation of `Pharborist\NodeInterface::replaceAll()`
`public`	# `swapWith( Pharborist\Node $replacement )` Swap this node with another. Swap this node with another. Parameters `$replacement` $node Node to swap with. Returns $this Implementation of `Pharborist\NodeInterface::swapWith()`
`public`	# `prependTo( Pharborist\ParentNode\|Pharborist\ParentNode[]\|Pharborist\NodeCollection $targets )` Prepend this node to target. Prepend this node to target. Parameters `$targets` Targets to prepend to. Returns $this Implementation of `Pharborist\NodeInterface::prependTo()`
`public`	# `appendTo( Pharborist\ParentNode\|Pharborist\ParentNode[]\|Pharborist\NodeCollection $targets )` Append this node to target. Append this node to target. Parameters `$targets` Targets to append to. Returns $this Implementation of `Pharborist\NodeInterface::appendTo()`
`public string`	# `sortKey( )` Get a unique key for sorting this node. Get a unique key for sorting this node. Used to sort nodes into tree order. That is top to bottom and then left to right. Returns string
`public boolean`	# `is( callable\|string $test )` Tests this node against a condition. Tests this node against a condition. Parameters `$test` Either a callback function to test the node against, or a class name (wrapper around instanceof). Eventually this will accept a callable or a filter query (issue #61). Returns boolean Throws InvalidArgumentException
`public boolean`	# `isAnyOf( array $tests )` Tests if this node matches any the tests in the array. Tests if this node matches any the tests in the array. Parameters `$tests` Returns boolean
`public boolean`	# `isAllOf( array $tests )` Tests if this node matches all of the tests in the array. Tests if this node matches all of the tests in the array. Parameters `$tests` Returns boolean
`public Pharborist\StatementBlockNode\|Pharborist\RootNode\|null`	# `getLogicalBlock( )` Returns the code block containing this node. The code block could be a control structure (if statement, for loop, case statement, etc.), a function, a class definition, or the whole syntax tree. Returns the code block containing this node. The code block could be a control structure (if statement, for loop, case statement, etc.), a function, a class definition, or the whole syntax tree. Returns `Pharborist\StatementBlockNode`\|`Pharborist\RootNode`\|null
`public static Pharborist\Types\FloatNode\|Pharborist\Types\IntegerNode\|Pharborist\Types\StringNode\|Pharborist\Types\BooleanNode\|Pharborist\Types\NullNode\|Pharborist\Types\ArrayNode`	# `fromValue( string\|integer\|float\|boolean\|array\|null $value )` Creates a Node from a php value. Creates a Node from a php value. Parameters `$value` The value to create a node for. Returns `Pharborist\Types\FloatNode`\|`Pharborist\Types\IntegerNode`\|`Pharborist\Types\StringNode`\|`Pharborist\Types\BooleanNode`\|`Pharborist\Types\NullNode`\|`Pharborist\Types\ArrayNode` Throws InvalidArgumentException if $value is not a scalar.
`public Pharborist\StatementNode\|null`	# `getStatement( )` Returns the statement (or statement block) which contains this node, if it's part of a statement. Returns the statement (or statement block) which contains this node, if it's part of a statement. Returns `Pharborist\StatementNode`\|null
`public Pharborist\RootNode\|null`	# `getRoot( )` Returns the root node if this node belongs to one. Returns the root node if this node belongs to one. Returns `Pharborist\RootNode`\|null Implementation of `Pharborist\NodeInterface::getRoot()`
`public`	# `hasRoot( )` Returns TRUE if this node belongs to a root node. Returns TRUE if this node belongs to a root node. Implementation of `Pharborist\NodeInterface::hasRoot()`
`public Pharborist\TokenNode`	# `previousToken( )` Returns `Pharborist\TokenNode`
`public Pharborist\TokenNode`	# `nextToken( )` Returns `Pharborist\TokenNode`
`public`	# `__clone( )`

Methods inherited from Pharborist\NodeInterface
`getSourcePosition(), getText()`

Namespaces

Classes

Interfaces

Traits

Class Node

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Parameters

Returns

Throws

Parameters

Returns