Copied!
CloneableInstantiable
Properties
public array $attrGroups
 
  • var \AttributeGroup[] PHP attribute groups
public bool $byRef
 
  • var bool Whether parameter is passed by reference
public ?PhpParser\Node\Expr $default
 
  • var null|\Expr Default value
public int $flags
 
  • var int Optional visibility flags
public array $hooks
 
  • var \PropertyHook[] Property hooks for promoted properties
public ?PhpParser\Node $type
 
  • var null|\Identifier|\Name|\ComplexType Type declaration
public PhpParser\Node\Expr $var
 
  • var \Expr\Variable|\Expr\Error Parameter variable
public bool $variadic
 
  • var bool Whether this is a variadic argument
Methods
public __construct(PhpParser\Node\Expr $var, ?PhpParser\Node\Expr $default = NULL, ?PhpParser\Node $type = NULL, bool $byRef = false, bool $variadic = false, array $attributes = [], int $flags = 0, array $attrGroups = [], array $hooks = [])
 

Constructs a parameter node.

  • param \Expr\Variable|\Expr\Error $var Parameter variable
  • param null|\Expr $default Default value
  • param null|\Identifier|\Name|\ComplexType $type Type declaration
  • param bool $byRef Whether is passed by reference
  • param bool $variadic Whether this is a variadic argument
  • param array<string,mixed> $attributes Additional attributes
  • param int $flags Optional visibility flags
  • param list<\AttributeGroup> $attrGroups PHP attribute groups
  • param \PropertyHook[] $hooks Property hooks for promoted properties
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)
  • phpstan-return -1|positive-int
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)
  • phpstan-return -1|positive-int
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)
  • phpstan-return -1|positive-int
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 isPrivate() : bool
public isPrivateSet() : bool
 

Whether the promoted property has explicit private(set) visibility.

public isPromoted() : bool
 

Whether this parameter uses constructor property promotion.

public isProtected() : bool
public isProtectedSet() : bool
 

Whether the promoted property has explicit protected(set) visibility.

public isPublic() : bool
public isPublicSet() : bool
 

Whether the promoted property has explicit public(set) visibility.

public isReadonly() : bool
public PhpParser\NodeAbstract::jsonSerialize() : array
 
  • return array<string,mixed>
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