Documentation

Linter

in package

• Application

Table of Contents

Constants

CONTEXT_NESTED_SELECTOR_CONTENT  = 'nested selector content'

CONTEXT_PROPERTY_CONTENT  = 'property content'

CONTEXT_PROPERTY_NAME  = 'property name'

CONTEXT_SELECTOR  = 'selector'

CONTEXT_SELECTOR_CONTENT  = 'selector content'

Properties

$charNumber  : int

Current char number

$comment  : bool

Tells if the linter is parsing a comment

$context  : string|null

Current context of parsing (must be a constant starting by CONTEXT_...)

$contextContent  : string

Current content of parse. Ex: the selector name, the property name or the property content

$cssLintProperties  : Properties|null

Class to provide css properties knowledge

$errors  : array<string|int, mixed>|null

Errors occurred during the lint process

$lineNumber  : int

Current line number

$nestedSelector  : bool

Tells if the linter is parsing a nested selector. Ex: @media, @keyframes.

$previousChar  : string|null

The previous linted char

Methods

__construct()  : mixed

Constructor

getCssLintProperties()  : Properties

Return an instance of the "\CssLint\Properties" helper, initialize a new one if not define already

getErrors()  : array<string|int, mixed>

Return the errors occurred during the lint process

lintFile()  : bool

Performs lint for a given file path

lintString()  : bool

Performs lint on a given string

setCssLintProperties()  : void

Set an instance of the "\CssLint\Properties" helper

addContextContent()  : Linter

Append new value to context content

addError()  : Linter

Add a new error message to the errors property, it adds extra infos to the given error message

assertContext()  : bool

Assert that current context is the same as given

assertPreviousChar()  : bool

Assert that previous char is the same as given

getCharNumber()  : int

Return the current char number

getContextContent()  : string

Return context content

getLineNumber()  : int

Return the current line number

incrementCharNumber()  : Linter

Add 1 to the current char number

incrementLineNumber()  : Linter

Add 1 to the current line number

initLint()  : Linter

Initialize linter, reset all process properties

isComment()  : bool

Tells if the linter is parsing a comment

isEndOfLine()  : bool

Check if a given char is an end of line token

isNestedSelector()  : bool

Tells if the linter is parsing a nested selector

lintChar()  : bool

Performs lint on a given char

lintCommentChar()  : bool|null

Performs lint for a given char, check comment part

lintNestedSelectorChar()  : bool|null

Performs lint for a given char, check nested selector part

lintPropertyContentChar()  : bool|null

Performs lint for a given char, check property content part

lintPropertyNameChar()  : bool|null

Performs lint for a given char, check property name part

lintSelectorChar()  : bool|null

Performs lint for a given char, check selector part

lintSelectorContentChar()  : bool|null

Performs lint for a given char, check selector content part

resetCharNumber()  : Linter

Reset current char number property

resetContext()  : Linter

Reset context property

resetContextContent()  : Linter

Reset context content property

resetErrors()  : Linter

Reset the errors property

resetLineNumber()  : Linter

Reset current line number property

resetPreviousChar()  : Linter

Reset previous char property

setComment()  : void

Set the comment flag

setContext()  : Linter

Set new context

setNestedSelector()  : void

Set the nested selector flag

setPreviousChar()  : Linter

Set new previous char