Copied!
CloneableInstantiable
Properties
public array $attrGroups
 
  • var \Node\AttributeGroup[] PHP attribute groups
public bool $byRef
 
  • var bool Whether function returns by reference
public PhpParser\Node\Identifier $name
 
  • var \Node\Identifier Name
public ?PhpParser\Node\Name $namespacedName
 
  • var \Node\Name|null Namespaced name (if using NameResolver)
public array $params
 
  • var \Node\Param[] Parameters
public ?PhpParser\Node $returnType
 
  • var null|\Node\Identifier|\Node\Name|\Node\ComplexType Return type
public array $stmts
 
  • var \Node\Stmt[] Statements
Methods
public __construct( $name, array $subNodes = [], array $attributes = [])
 

Constructs a function node.

  • param string|\Node\Identifier $name Name
  • param array{byRef?: bool, params?: \Node\Param[], returnType?: null|\Node\Identifier|\Node\Name|\Node\ComplexType, stmts?: \Node\Stmt[], attrGroups?: \Node\AttributeGroup[]} $subNodes Array of the following optional subnodes: 'byRef' => false : Whether to return by reference 'params' => array(): Parameters 'returnType' => null : Return type 'stmts' => array(): Statements 'attrGroups' => array(): PHP attribute groups
  • param array<string,mixed> $attributes Additional attributes
public getAttrGroups() : array
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() : ?PhpParser\Comment\Doc
 

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 getParams() : array
public getReturnType()
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 getStmts() : array
 
  • return \Node\Stmt[]
public getSubNodeNames() : array
public getType() : string
public PhpParser\NodeAbstract::hasAttribute(string $key) : bool
public PhpParser\NodeAbstract::jsonSerialize() : array
 
  • return array<string,mixed>
public returnsByRef() : bool
public PhpParser\NodeAbstract::setAttribute(string $key, $value) : void
public PhpParser\NodeAbstract::setAttributes(array $attributes) : void
public PhpParser\NodeAbstract::setDocComment(PhpParser\Comment\Doc $docComment) : void
 

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 array PhpParser\NodeAbstract::$attributes
 
  • var array<string,mixed> Attributes
© 2024 Bruce Wells
Search Namespaces \ Classes
Configuration