Page MenuHomePhorge

final class XHPASTNode
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.

public function isStaticScalar()

This method is not documented.
Return
wild

public function getDocblockToken()

This method is not documented.
Return
wild

public function evalStatic()

This method is not documented.
Return
wild

public function getStringLiteralValue()

This method is not documented.
Return
wild

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

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

final public function getParentNode()
Inherited

This method is not documented.
Return
wild

final public function setParentNode($node)
Inherited

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

final public function getPreviousSibling()
Inherited

This method is not documented.
Return
wild

final public function setPreviousSibling($node)
Inherited

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

final public function getNextSibling()
Inherited

This method is not documented.
Return
wild

final public function setNextSibling($node)
Inherited

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

final public function getID()
Inherited

This method is not documented.
Return
wild

final public function getTypeID()
Inherited

This method is not documented.
Return
wild

final public function getTree()
Inherited

This method is not documented.
Return
wild

final public function getTypeName()
Inherited

This method is not documented.
Return
wild

final public function getChildren()
Inherited

This method is not documented.
Return
wild

final public function setChildren($children)
Inherited

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

public function getChildrenOfType($type)
Inherited

This method is not documented.
Parameters
$type
Return
wild

public function getChildOfType($index, $type)
Inherited

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

public function getChildByIndex($index)
Inherited

This method is not documented.
Parameters
$index
Return
wild

public function buildSelectCache()
Inherited

AASTNode

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()
Inherited

AASTNode

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)
Inherited

This method is not documented.
Parameters
$type_name
Return
wild

public function selectTokensOfTypes($type_names)
Inherited

AASTNode

Select all tokens of any given types.

Parameters
array$type_names
Return
wild

final public function isDescendantOf($node)
Inherited

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

public function selectDescendantsOfType($type_name)
Inherited

This method is not documented.
Parameters
$type_name
Return
wild

public function selectDescendantsOfTypes($type_names)
Inherited

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

protected function executeSelectDescendantsOfType($node, $type)
Inherited

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

public function getTokens()
Inherited

This method is not documented.
Return
wild

public function getConcreteString()
Inherited

This method is not documented.
Return
wild

public function getSemanticString()
Inherited

This method is not documented.
Return
wild

public function getIndentation()
Inherited

This method is not documented.
Return
wild

public function getDescription()
Inherited

This method is not documented.
Return
wild

final protected function getTypeIDFromTypeName($type_name)
Inherited

This method is not documented.
Parameters
$type_name
Return
wild

final public function getOffset()
Inherited

This method is not documented.
Return
wild

final public function getLength()
Inherited

This method is not documented.
Return
wild

public function getSurroundingNonsemanticTokens()
Inherited

This method is not documented.
Return
wild

final public function getLineNumber()
Inherited

This method is not documented.
Return
wild

final public function getEndLineNumber()
Inherited

This method is not documented.
Return
wild

final public function isAfter($node)
Inherited

AASTNode

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

Parameters
AASTNode$node
Return
bool

final public function isBefore($node)
Inherited

AASTNode

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

Parameters
AASTNode$node
Return
bool

final public function containsDescendant($node)
Inherited

AASTNode

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

Parameters
AASTNode$node
Return
bool

public function dispose()
Inherited

This method is not documented.
Return
wild

public function isConstantString()

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

private function checkIsConstantString($additional_types)

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

public function getStringVariables()

This method is not documented.
Return
wild

private function newStringLiteralFromSemanticString($value)

This method is not documented.
Parameters
$value
Return
wild

public function getNamespace(...)

Determines the parent namespace for a node.

Traverses the AST upwards from a given node in order to determine the namespace in which the node is declared.

To prevent any possible ambiguity, the returned namespace will always be prefixed with the namespace separator.

Parameters
XHPASTNodeThe input node.
Return
string|nullThe namespace which contains the input node, or `null` if no such node exists.

private function getNamespaceName()

Returns the namespace name from a node of type n_NAMESPACE.

Return
string|null