PHPFUI/InstaDoc
 
Copied!

Represents a name that is written in source code with a leading dollar,
but is not a proper variable. The leading dollar is not stored as part of the name.

Examples: Names in property declarations are formatted as variables. Names in static property
lookups are also formatted as variables.

Cloneable Instantiable
Properties
public PhpParser\Node\Identifier :: $name
 
  • var string Identifier as string
Methods
public PhpParser\Node\Identifier :: __construct ( string $name , array $attributes = [ ] )
 

Constructs an identifier node.

  • param array $attributes Array of attributes
  • param array $attributes Additional attributes
public PhpParser\Node\Identifier :: __toString () : string
 

Get identifier as string.

  • return string Identifier as string
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 PhpParser\Node\Identifier :: getSubNodeNames () : array
public getType () : string
public PhpParser\NodeAbstract :: hasAttribute ( string $key ) : bool
public PhpParser\Node\Identifier :: isSpecialClassName () : bool
 

Checks whether the identifier is a special class name (self, parent or static).

  • return bool Whether identifier is a special class name
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
public PhpParser\Node\Identifier :: toLowerString () : string
 

Get lowercased identifier as string.

  • return string Lowercased identifier as string
public PhpParser\Node\Identifier :: toString () : string
 

Get identifier as string.

  • return string Identifier as string.
Properties
protected PhpParser\NodeAbstract :: $attributes
© 2022 Bruce Wells
Search Namespaces \ Classes
Configuration