PHPFUI/InstaDoc

public abstract PhpParser\Node::getAttribute(string $key, $default = NULL)

Returns the value of an attribute.

param mixed $default
return mixed

public abstract PhpParser\Node::getAttributes() : array

Returns all the attributes of this node.

return array<string,mixed>

public abstract PhpParser\Node::getComments() : array

Gets all comments directly preceding this node.

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

return \Comment[]

public abstract PhpParser\Node::getDocComment() : ?PhpParser\Comment\Doc

Gets the doc comment of the node.

return null|\Comment\Doc Doc comment object or null

public abstract PhpParser\Node::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 abstract PhpParser\Node::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 abstract PhpParser\Node::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 abstract PhpParser\Node::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
deprecated Use getStartLine() instead

public abstract PhpParser\Node::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 abstract PhpParser\Node::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 abstract PhpParser\Node::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 string[] Names of sub nodes

public abstract PhpParser\Node::getType() : string

Gets the type of the node.

psalm-return non-empty-string
return string Type of the node

public abstract PhpParser\Node::hasAttribute(string $key) : bool

Returns whether an attribute exists.

public abstract PhpParser\Node::setAttribute(string $key, $value) : void

Sets an attribute on a node.

param mixed $value

public abstract PhpParser\Node::setAttributes(array $attributes) : void

Replaces all the attributes of this node.

param array<string,mixed> $attributes

public abstract PhpParser\Node::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