PHPFUI/InstaDoc
 
Copied!
Abstract
Methods
public __construct ( array $attributes = [ ] )
 

Creates a Node.

public getAttribute ( string $key , $default = NULL )
public getAttributes () : array
public getComments () : array
 

Gets all comments directly preceding this node.

The comments are also available through the "comments" attribute.

public getDocComment ()
 

Gets the doc comment of the node.

public getEndFilePos () : int
 

Gets the file offset of the last character that is part of this node.

Requires the 'endFilePos' attribute to be enabled in the lexer (DISABLED by default).

  • return int File end position (or -1 if not available)
public getEndLine () : int
 

Gets the line the node ended in.

Requires the 'endLine' attribute to be enabled in the lexer (enabled by default).

  • return int End line (or -1 if not available)
public getEndTokenPos () : int
 

Gets the token offset of the last token that is part of this node.

The offset is an index into the array returned by Lexer::getTokens().

Requires the 'endTokenPos' attribute to be enabled in the lexer (DISABLED by default).

  • return int Token end position (or -1 if not available)
public getLine () : int
 

Gets line the node started in (alias of getStartLine).

  • return int Start line (or -1 if not available)
public getStartFilePos () : int
 

Gets the file offset of the first character that is part of this node.

Requires the 'startFilePos' attribute to be enabled in the lexer (DISABLED by default).

  • return int File start position (or -1 if not available)
public getStartLine () : int
 

Gets line the node started in.

Requires the 'startLine' attribute to be enabled in the lexer (enabled by default).

  • return int Start line (or -1 if not available)
public getStartTokenPos () : int
 

Gets the token offset of the first token that is part of this node.

The offset is an index into the array returned by Lexer::getTokens().

Requires the 'startTokenPos' attribute to be enabled in the lexer (DISABLED by default).

  • return int Token start position (or -1 if not available)
public abstract PhpParser\Node :: getSubNodeNames () : array
 

Gets the names of the sub nodes.

  • return array Names of sub nodes
public abstract PhpParser\Node :: getType () : string
 

Gets the type of the node.

  • return string Type of the node
public hasAttribute ( string $key ) : bool
public jsonSerialize () : array
 
  • return array
public setAttribute ( string $key , $value )
public setAttributes ( array $attributes )
public setDocComment ( PhpParser\Comment\Doc $docComment )
 

Sets the doc comment of the node.

This will either replace an existing doc comment or add it to the comments array.
Properties
protected $attributes
© 2021 Bruce Wells
Search Namespaces \ Classes
Configuration