PHPFUI/InstaDoc
 
Copied!
Abstract Interface
Methods
public abstract getAttrGroups () : array
 

Get PHP attribute groups.

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

Returns the value of an attribute.

  • return mixed
public abstract PhpParser\Node :: getAttributes () : array
 

Returns all the attributes of this node.

  • return array
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 ()
 

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)
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)
public abstract getParams () : array
 

List of parameters

public abstract getReturnType ()
 

Get the declared return type or null

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)
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 getStmts ()
 

The function body

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

Gets the names of the sub nodes.

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

Gets the type of the node.

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

Returns whether an attribute exists.

  • return bool
public abstract returnsByRef () : bool
 

Whether to return by reference

  • return bool
public abstract PhpParser\Node :: setAttribute ( string $key , $value )
 

Sets an attribute on a node.

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

Replaces all the attributes of this node.

public abstract PhpParser\Node :: 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.
© 2021 Bruce Wells
Search Namespaces \ Classes
Configuration