PHPFUI/InstaDoc
 
Copied!
Cloneable Instantiable
Properties
public $default
 
  • var null | Node\Expr Default
public $name
 
  • var Node\VarLikeIdentifier Name
Methods
public __construct ( $name , ? PhpParser\Node\Expr $default = NULL , array $attributes = [ ] )
 

Constructs a class property node.

  • param array $attributes Array of attributes
  • param null | Node\Expr $default Default value
  • param array $attributes Additional attributes
public PhpParser\NodeAbstract :: getAttribute ( string $key , $default = NULL )
public PhpParser\NodeAbstract :: getAttributes () : array
public PhpParser\NodeAbstract :: getComments () : array
 

Gets all comments directly preceding this node.

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

  • return Comment []
public PhpParser\NodeAbstract :: getDocComment ()
 

Gets the doc comment of the node.

  • return null | Comment\Doc Doc comment object or null
public PhpParser\NodeAbstract :: 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 PhpParser\NodeAbstract :: 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 PhpParser\NodeAbstract :: 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 PhpParser\NodeAbstract :: getLine () : int
 

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

  • return int Start line (or -1 if not available)
public PhpParser\NodeAbstract :: 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 PhpParser\NodeAbstract :: 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 PhpParser\NodeAbstract :: 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 getSubNodeNames () : array
public getType () : string
public PhpParser\NodeAbstract :: hasAttribute ( string $key ) : bool
public PhpParser\NodeAbstract :: jsonSerialize () : array
 
  • return array
public PhpParser\NodeAbstract :: setAttribute ( string $key , $value )
public PhpParser\NodeAbstract :: setAttributes ( array $attributes )
public PhpParser\NodeAbstract :: 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.

  • param Comment\Doc $docComment Doc comment to set
Properties
protected PhpParser\NodeAbstract :: $attributes
© 2022 Bruce Wells
Search Namespaces \ Classes
Configuration