PHPFUI/InstaDoc
 
Copied!
CloneableInstantiable
Constants
public PhpParser\Node\Scalar\String_::KIND_DOUBLE_QUOTED = 2
public PhpParser\Node\Scalar\String_::KIND_HEREDOC = 3
public PhpParser\Node\Scalar\String_::KIND_NOWDOC = 4
public PhpParser\Node\Scalar\String_::KIND_SINGLE_QUOTED = 1
Properties
public string $value
 
  • var string String value
Methods
public __construct(string $value, array $attributes = [])
 

Constructs a string scalar node.

  • param string $value Value of the string
  • param array<string,mixed> $attributes Additional attributes
public static fromString(string $str, array $attributes = [], bool $parseUnicodeEscape = true) : self
 
  • param array<string,mixed> $attributes
  • param bool $parseUnicodeEscape Whether to parse PHP 7 \u escapes
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 PhpParser\NodeAbstract::jsonSerialize() : array
 
  • return array<string,mixed>
public static parse(string $str, bool $parseUnicodeEscape = true) : string
 
  • internal Parses a string token.
  • param string $str String token content
  • param bool $parseUnicodeEscape Whether to parse PHP 7 \u escapes
  • return string The parsed string
public static parseEscapeSequences(string $str, ?string $quote, bool $parseUnicodeEscape = true) : string
 
  • internal Parses escape sequences in strings (all string types apart from single quoted).
  • param string $str String without quotes
  • param null|string $quote Quote type
  • param bool $parseUnicodeEscape Whether to parse PHP 7 \u escapes
  • return string String with escape sequences parsed
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
protected static array $replacements = ['\' => '\', '$' => '$', 'n' => ' ', 'r' => ' ', 't' => ' ', 'f' => ' ', 'v' => ' ', 'e' => '']
 
  • var array<string,string> Escaped character to its decoded value
Methods
private static codePointToUtf8(int $num) : string
 

Converts a Unicode code point to its UTF-8 encoded representation.

  • param int $num Code point
  • return string UTF-8 representation of code point
Properties
protected static array $replacements = ['\' => '\', '$' => '$', 'n' => ' ', 'r' => ' ', 't' => ' ', 'f' => ' ', 'v' => ' ', 'e' => '']
 
  • var array<string,string> Escaped character to its decoded value
Methods
private static codePointToUtf8(int $num) : string
 

Converts a Unicode code point to its UTF-8 encoded representation.

  • param int $num Code point
  • return string UTF-8 representation of code point
public static fromString(string $str, array $attributes = [], bool $parseUnicodeEscape = true) : self
 
  • param array<string,mixed> $attributes
  • param bool $parseUnicodeEscape Whether to parse PHP 7 \u escapes
public static parse(string $str, bool $parseUnicodeEscape = true) : string
 
  • internal Parses a string token.
  • param string $str String token content
  • param bool $parseUnicodeEscape Whether to parse PHP 7 \u escapes
  • return string The parsed string
public static parseEscapeSequences(string $str, ?string $quote, bool $parseUnicodeEscape = true) : string
 
  • internal Parses escape sequences in strings (all string types apart from single quoted).
  • param string $str String without quotes
  • param null|string $quote Quote type
  • param bool $parseUnicodeEscape Whether to parse PHP 7 \u escapes
  • return string String with escape sequences parsed
© 2024 Bruce Wells
Search Namespaces \ Classes
Configuration