file-fetcher
Public Member Functions | Protected Attributes | List of all members
PHP_TokenWithScope Class Reference
Inheritance diagram for PHP_TokenWithScope:
PHP_Token PHP_Token_NAMESPACE PHP_TokenWithScopeAndVisibility PHP_Token_FUNCTION PHP_Token_INTERFACE PHP_Token_CLASS PHP_Token_TRAIT

Public Member Functions

 getDocblock ()
 
 getEndTokenId ()
 
 getEndLine ()
 
- Public Member Functions inherited from PHP_Token
 __construct ($text, $line, PHP_Token_Stream $tokenStream, $id)
 
 __toString ()
 
 getLine ()
 
 getId ()
 

Protected Attributes

 $endTokenId
 
- Protected Attributes inherited from PHP_Token
 $text
 
 $line
 
 $tokenStream
 
 $id
 

Member Function Documentation

◆ getDocblock()

PHP_TokenWithScope::getDocblock ( )

Get the docblock for this token

This method will fetch the docblock belonging to the current token. The docblock must be placed on the line directly above the token to be recognized.

Returns
string|null Returns the docblock as a string if found

◆ getEndLine()

PHP_TokenWithScope::getEndLine ( )
Returns
int

◆ getEndTokenId()

PHP_TokenWithScope::getEndTokenId ( )
Returns
int

Member Data Documentation

◆ $endTokenId

PHP_TokenWithScope::$endTokenId
protected

The documentation for this class was generated from the following file: