Page MenuHomePhorge

abstract class AASTNode
Arcanist Technical Documentation ()

This class is not documented.

Methods

public function __get($name)
Inherited

This method is not documented.
Parameters
$name
Return
wild

public function __set($name, $value)
Inherited

This method is not documented.
Parameters
$name
$value
Return
wild

public function current()
Inherited

This method is not documented.
Return
wild

public function key()
Inherited

This method is not documented.
Return
wild

public function next()
Inherited

This method is not documented.
Return
wild

public function rewind()
Inherited

This method is not documented.
Return
wild

public function valid()
Inherited

This method is not documented.
Return
wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.
Return
wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters
string$keyName of the constant.
int|null$byte_limitMaximum number of bytes permitted in the value.
Return
stringValue of the constant.

abstract public function isStaticScalar()

This method is not documented.
Return
wild

abstract public function getDocblockToken()

This method is not documented.
Return
wild

abstract public function evalStatic()

This method is not documented.
Return
wild

abstract public function getStringLiteralValue()

This method is not documented.
Return
wild

public function __construct($id, $data, $tree)

This method is not documented.
Parameters
$id
array$data
AASTTree$tree
Return
this//Implicit.//

final public function getParentNode()

This method is not documented.
Return
wild

final public function setParentNode($node)

This method is not documented.
Parameters
AASTNode$node
Return
wild

final public function getPreviousSibling()

This method is not documented.
Return
wild

final public function setPreviousSibling($node)

This method is not documented.
Parameters
AASTNode$node
Return
wild

final public function getNextSibling()

This method is not documented.
Return
wild

final public function setNextSibling($node)

This method is not documented.
Parameters
AASTNode$node
Return
wild

final public function getID()

This method is not documented.
Return
wild

final public function getTypeID()

This method is not documented.
Return
wild

final public function getTree()

This method is not documented.
Return
wild

final public function getTypeName()

This method is not documented.
Return
wild

final public function getChildren()

This method is not documented.
Return
wild

final public function setChildren($children)

This method is not documented.
Parameters
array$children
Return
wild

public function getChildrenOfType($type)

This method is not documented.
Parameters
$type
Return
wild

public function getChildOfType($index, $type)

This method is not documented.
Parameters
$index
$type
Return
wild

public function getChildByIndex($index)

This method is not documented.
Parameters
$index
Return
wild

public function buildSelectCache()

Build a cache to improve the performance of selectDescendantsOfType(). This cache makes a time/memory tradeoff by aggressively caching node descendants. It may improve the tree's query performance substantially if you make a large number of queries, but also requires a significant amount of memory.

This builds a cache for the entire tree and improves performance of all selectDescendantsOfType() calls.

Return
wild

public function buildTokenCache()

Build a cache to improve the performance of selectTokensOfType(). This cache makes a time/memory tradeoff by aggressively caching token types. It may improve the tree's query performance substantially if you make a large number of queries, but also requires a significant amount of memory.

This builds a cache for this node only.

Return
wild

public function selectTokensOfType($type_name)

This method is not documented.
Parameters
$type_name
Return
wild

public function selectTokensOfTypes($type_names)

Select all tokens of any given types.

Parameters
array$type_names
Return
wild

final public function isDescendantOf($node)

This method is not documented.
Parameters
AASTNode$node
Return
wild

public function selectDescendantsOfType($type_name)

This method is not documented.
Parameters
$type_name
Return
wild

public function selectDescendantsOfTypes($type_names)

This method is not documented.
Parameters
array$type_names
Return
wild

protected function executeSelectDescendantsOfType($node, $type)

This method is not documented.
Parameters
$node
$type
Return
wild

public function getTokens()

This method is not documented.
Return
wild

public function getConcreteString()

This method is not documented.
Return
wild

public function getSemanticString()

This method is not documented.
Return
wild

public function getIndentation()

This method is not documented.
Return
wild

public function getDescription()

This method is not documented.
Return
wild

final protected function getTypeIDFromTypeName($type_name)

This method is not documented.
Parameters
$type_name
Return
wild

final public function getOffset()

This method is not documented.
Return
wild

final public function getLength()

This method is not documented.
Return
wild
This method is not documented.
Return
wild

final public function getLineNumber()

This method is not documented.
Return
wild

final public function getEndLineNumber()

This method is not documented.
Return
wild

final public function isAfter($node)

Determines whether the current node appears after a specified node in the tree.

Parameters
AASTNode$node
Return
bool

final public function isBefore($node)

Determines whether the current node appears before a specified node in the tree.

Parameters
AASTNode$node
Return
bool

final public function containsDescendant($node)

Determines whether a specified node is a descendant of the current node.

Parameters
AASTNode$node
Return
bool

public function dispose()

This method is not documented.
Return
wild