API Documentation

Node

Node::getNodeKindName

public function getNodeKindName ( ) : string

Node::getStartPosition

Gets start position of Node, not including leading comments and whitespace.

public function getStartPosition ( ) : int

Node::getFullStartPosition

Gets start position of Node, including leading comments and whitespace

public function getFullStartPosition ( ) : int

Node::getParent

Gets parent of current node (returns null if has no parent)

public function getParent ( )

Node::getFirstAncestor

Gets first ancestor that is an instance of one of the provided classes. Returns null if there is no match.

public function getFirstAncestor ( ...$classNames )

Node::getFirstChildNode

Gets first child that is an instance of one of the provided classes. Returns null if there is no match.

public function getFirstChildNode ( ...$classNames )

Node::getFirstDescendantNode

Gets first descendant node that is an instance of one of the provided classes. Returns null if there is no match.

public function getFirstDescendantNode ( ...$classNames )

Node::getRoot

Gets root of the syntax tree (returns self if has no parents)

public function getRoot ( ) : Node

Node::getDescendantNodesAndTokens

Gets generator containing all descendant Nodes and Tokens.

public function getDescendantNodesAndTokens ( callable $shouldDescendIntoChildrenFn = null )

Node::getDescendantNodes

Gets a generator containing all descendant Nodes.

public function getDescendantNodes ( callable $shouldDescendIntoChildrenFn = null )

Node::getDescendantTokens

Gets generator containing all descendant Tokens.

public function getDescendantTokens ( callable $shouldDescendIntoChildrenFn = null )

Node::getChildNodesAndTokens

Gets generator containing all child Nodes and Tokens (direct descendants). Does not return null elements.

public function getChildNodesAndTokens ( ) : \Generator

Node::getChildNodes

Gets generator containing all child Nodes (direct descendants)

public function getChildNodes ( ) : \Generator

Node::getChildTokens

Gets generator containing all child Tokens (direct descendants)

public function getChildTokens ( )

Node::getChildNames

Gets array of declared child names (cached). This is used as an optimization when iterating over nodes: For direct iteration PHP will create a properties hashtable on the object, thus doubling memory usage. We avoid this by iterating over just the names instead.

public function getChildNames ( )

Node::getWidth

Gets width of a Node (not including comment / whitespace trivia)

public function getWidth ( ) : int

Node::getFullWidth

Gets width of a Node (including comment / whitespace trivia)

public function getFullWidth ( ) : int

Node::getText

Gets string representing Node text (not including leading comment + whitespace trivia)

public function getText ( ) : string

Node::getFullText

Gets full text of Node (including leading comment + whitespace trivia)

public function getFullText ( ) : string

Node::getLeadingCommentAndWhitespaceText

Gets string representing Node's leading comment and whitespace text.

public function getLeadingCommentAndWhitespaceText ( ) : string

Node::jsonSerialize

public function jsonSerialize ( )

Node::getEndPosition

Get the end index of a Node.

public function getEndPosition ( )

Node::getFileContents

public function getFileContents ( ) : string

Node::getUri

public function getUri ( ) : string

Node::getLastChild

public function getLastChild ( )

Node::getDescendantNodeAtPosition

Searches descendants to find a Node at the given position.

public function getDescendantNodeAtPosition ( int $pos )

Node::getDocCommentText

Gets leading PHP Doc Comment text corresponding to the current Node. Returns last doc comment in leading comment / whitespace trivia, and returns null if there is no preceding doc comment.

public function getDocCommentText ( )

Node::__toString

public function __toString ( )

Node::getImportTablesForCurrentScope

public function getImportTablesForCurrentScope ( )

Node::getNamespaceDefinition

Gets corresponding NamespaceDefinition for Node. Returns null if in global namespace.

public function getNamespaceDefinition ( )

Node::getPreviousSibling

public function getPreviousSibling ( )

Token

Token::__construct

public function __construct ( $kind, $fullStart, $start, $length )

Token::getLeadingCommentsAndWhitespaceText

public function getLeadingCommentsAndWhitespaceText ( string $document ) : string

Token::getText

public function getText ( string $document = null )

Token::getFullText

public function getFullText ( string & $document ) : string

Token::getStartPosition

public function getStartPosition ( )

Token::getFullStartPosition

public function getFullStartPosition ( )

Token::getWidth

public function getWidth ( )

Token::getFullWidth

public function getFullWidth ( )

Token::getEndPosition

public function getEndPosition ( )

Token::getTokenKindNameFromValue

public static function getTokenKindNameFromValue ( $kind )

Token::jsonSerialize

public function jsonSerialize ( )

Parser

Parser::__construct

public function __construct ( )

Parser::parseSourceFile

Generates AST from source file contents. Returns an instance of SourceFileNode, which is always the top-most Node-type of the tree.

public function parseSourceFile ( string $fileContents, string $uri = null ) : SourceFileNode

Associativity

DiagnosticsProvider

DiagnosticsProvider::checkDiagnostics

public static function checkDiagnostics ( $node )

DiagnosticsProvider::getDiagnostics

public static function getDiagnostics ( Node $n ) : array

PositionUtilities

PositionUtilities::getRangeFromPosition

Gets a Range from 0-indexed position into $text. Out of bounds positions are handled gracefully. Positions greater than the length of text length are resolved to the end of the text, and negative positions are resolved to the beginning.

public static function getRangeFromPosition ( $pos, $length, $text ) : Range

PositionUtilities::getLineCharacterPositionFromPosition

Gets 0-indexed LineCharacterPosition from 0-indexed position into $text. Out of bounds positions are handled gracefully. Positions greater than the length of text length are resolved to text length, and negative positions are resolved to 0. TODO consider throwing exception instead.

public static function getLineCharacterPositionFromPosition ( $pos, $text ) : LineCharacterPosition

LineCharacterPosition

LineCharacterPosition::__construct

public function __construct ( int $line, int $character )

MissingToken

MissingToken::__construct

public function __construct ( int $kind, int $fullStart )

MissingToken::jsonSerialize

public function jsonSerialize ( )

SkippedToken

SkippedToken::__construct

public function __construct ( Token $token )

SkippedToken::jsonSerialize

public function jsonSerialize ( )

Node types

Files

ApiDocumentation.md

Latest commit

History