PHPFUI/InstaDoc
 
Copied!
Abstract Interface
Methods
public abstract getAttribute ( string $key , $default = NULL )
 

Returns the value of an attribute.

  • param string $key
  • param mixed $default
  • return mixed
public abstract getAttributes () : array
 

Returns all the attributes of this node.

  • return array
public abstract getComments () : array
 

Gets all comments directly preceding this node.

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

public abstract getDocComment ()
 

Gets the doc comment of the node.

public abstract 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 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 abstract 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 getLine () : int
 

Gets line the node started in (alias of getStartLine).

  • return int Start line (or -1 if not available)
public abstract 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 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 abstract 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 getSubNodeNames () : array
 

Gets the names of the sub nodes.

  • return array Names of sub nodes
public abstract getType () : string
 

Gets the type of the node.

  • return string Type of the node
public abstract hasAttribute ( string $key ) : bool
 

Returns whether an attribute exists.

  • param string $key
  • return bool
public abstract setAttribute ( string $key , $value )
 

Sets an attribute on a node.

  • param string $key
  • param mixed $value
public abstract setAttributes ( array $attributes )
 

Replaces all the attributes of this node.

  • param array $attributes
public abstract 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.
© 2022 Bruce Wells
Search Namespaces \ Classes
Configuration