EndOfLineParser
extends AbstractParser
in package
Tags
Table of Contents
Properties
- $END_OF_LINE_CHARS : array<string|int, non-empty-string>
Methods
- getHandledTokenClass() : Token>
- Get the token class that this parser handles
- parseCurrentContext() : TToken|LintError|null
- Performs parsing tokenizer current context, check end of line part
- handleTokenForCurrentContext() : TToken|LintError|null
- lastCharIsSpace() : bool
- removeEndingString() : string
- removeStartingString() : string
- stringIsSpace() : bool
- isEndOfLineChar() : bool
- Check if a given char is an end of line token
Properties
$END_OF_LINE_CHARS
public
static array<string|int, non-empty-string>
$END_OF_LINE_CHARS
= ["\r\n", "\n"]
Methods
getHandledTokenClass()
Get the token class that this parser handles
public
getHandledTokenClass() : Token>
Return values
Token>parseCurrentContext()
Performs parsing tokenizer current context, check end of line part
public
parseCurrentContext(TokenizerContext $tokenizerContext) : TToken|LintError|null
Parameters
- $tokenizerContext : TokenizerContext
-
The context of the tokenizer to parse.
Return values
TToken|LintError|null —A token if parsing is successful, an error if there is an issue, or null if no action is taken.
handleTokenForCurrentContext()
protected
handleTokenForCurrentContext(TokenizerContext $tokenizerContext,
Warning: Array to string conversion in /opt/phpdoc/src/phpDocumentor/Transformer/Writer/Twig/LinkRenderer/CallableAdapter.php on line 70
Warning: Array to string conversion in /opt/phpdoc/src/phpDocumentor/Transformer/Writer/Twig/LinkRenderer/CallableAdapter.php on line 78
callable(Array): Array $generateToken) : TToken|LintError|null
Parameters
- $tokenizerContext : TokenizerContext
- $generateToken : Warning: Array to string conversion in /opt/phpdoc/src/phpDocumentor/Transformer/Writer/Twig/LinkRenderer/CallableAdapter.php on line 70 Warning: Array to string conversion in /opt/phpdoc/src/phpDocumentor/Transformer/Writer/Twig/LinkRenderer/CallableAdapter.php on line 78 callable(Array): Array
Return values
TToken|LintError|nulllastCharIsSpace()
protected
lastCharIsSpace(TokenizerContext $tokenizerContext) : bool
Parameters
- $tokenizerContext : TokenizerContext
Return values
boolremoveEndingString()
protected
static removeEndingString(string $content, string $search) : string
Parameters
- $content : string
- $search : string
Return values
stringremoveStartingString()
protected
static removeStartingString(string $content, string $search) : string
Parameters
- $content : string
- $search : string
Return values
stringstringIsSpace()
protected
stringIsSpace(string $char) : bool
Parameters
- $char : string
Return values
boolisEndOfLineChar()
Check if a given char is an end of line token
private
isEndOfLineChar(TokenizerContext $tokenizerContext) : bool
Parameters
- $tokenizerContext : TokenizerContext
Return values
bool —: true if the char is an end of line token, else false