Documentation

CommentCharLinter
in package
implements CharLinter

Table of Contents

Interfaces

CharLinter

Properties

$COMMENT_DELIMITER  : string

Methods

lintChar()  : bool|null
Performs lint for a given char, check comment part
isCommentDelimiter()  : bool
Check if the current char is a comment
isCommentEnd()  : bool
Check if the current char is the end of a comment
isCommentStart()  : bool
Check if the current char is the start of a comment

Properties

Methods

lintChar()

Performs lint for a given char, check comment part

public lintChar(string $charValue, LintContext $lintContext) : bool|null
Parameters
$charValue : string
$lintContext : LintContext
Return values
bool|null

: true if the process should continue, else false, null if this char is not about comment

isCommentDelimiter()

Check if the current char is a comment

private isCommentDelimiter(string $charValue) : bool
Parameters
$charValue : string
Return values
bool

isCommentEnd()

Check if the current char is the end of a comment

private isCommentEnd(string $charValue, LintContext $lintContext) : bool
Parameters
$charValue : string
$lintContext : LintContext
Return values
bool

isCommentStart()

Check if the current char is the start of a comment

private isCommentStart(string $charValue, LintContext $lintContext) : bool
Parameters
$charValue : string
$lintContext : LintContext
Return values
bool

        
On this page

Search results