Documentation

LintConfiguration
in package

Tags
phpstan-import-type

ReferentialData from Referential

phpstan-type

AllowedIndentationChars array

LintConfigurationOptions array{ allowedIndentationChars?: AllowedIndentationChars, constructors?: ReferentialData, standards?: ReferentialData, nonStandards?: ReferentialData }

Table of Contents

Properties

$allowedIndentationChars  : AllowedIndentationChars
List of allowed indentation chars
$atRulesNonStandards  : ReferentialData
List of non standards at-rules
$atRulesPropertiesNonStandards  : ReferentialData
List of non standards at-rules properties
$atRulesPropertiesStandards  : ReferentialData
List of standards at-rules properties
$atRulesStandards  : ReferentialData
List of standards at-rules
$constructors  : ReferentialData
List of existing constructor prefix
$propertiesNonStandards  : ReferentialData
List of non standards properties
$propertiesStandards  : ReferentialData
List of standards properties

Methods

__construct()  : mixed
atRuleExists()  : bool
atRuleHasProperties()  : bool
atRulePropertyExists()  : bool
getAllowedIndentationChars()  : AllowedIndentationChars
Retrieve indentation chars allowed by the linter
getLinters()  : array<string|int, TokenLinter>
Get the list of linters
isAllowedIndentationChar()  : bool
Check if the given char is allowed as an indentation char
mergeAtRulesNonStandards()  : void
Merge the given non standards atrules with the current ones
mergeAtRulesPropertiesNonStandards()  : void
Merge the given non standards at-rules properties with the current ones
mergeAtRulesPropertiesStandards()  : void
Merge the given standards at-rules properties with the current ones
mergeAtRulesStandards()  : void
Merge the given standards at-rules with the current ones
mergeConstructors()  : void
Merge the given constructors properties with the current ones
mergePropertiesNonStandards()  : void
Merge the given non standards properties with the current ones
mergePropertiesStandards()  : void
Merge the given standards properties with the current ones
propertyExists()  : bool
Checks that the given CSS property is an existing one
setAllowedIndentationChars()  : void
Define the indentation chars allowed by the linter
setOptions()  : void

Properties

$allowedIndentationChars

List of allowed indentation chars

protected AllowedIndentationChars $allowedIndentationChars = [' ']

$atRulesNonStandards

List of non standards at-rules

protected ReferentialData $atRulesNonStandards

$atRulesPropertiesNonStandards

List of non standards at-rules properties

protected ReferentialData $atRulesPropertiesNonStandards

$atRulesPropertiesStandards

List of standards at-rules properties

protected ReferentialData $atRulesPropertiesStandards

$atRulesStandards

List of standards at-rules

protected ReferentialData $atRulesStandards

$constructors

List of existing constructor prefix

protected ReferentialData $constructors

$propertiesNonStandards

List of non standards properties

protected ReferentialData $propertiesNonStandards

$propertiesStandards

List of standards properties

protected ReferentialData $propertiesStandards

Methods

atRuleExists()

public atRuleExists(string $atRule) : bool
Parameters
$atRule : string
Return values
bool

atRuleHasProperties()

public atRuleHasProperties(string $atRule) : bool
Parameters
$atRule : string
Return values
bool

atRulePropertyExists()

public atRulePropertyExists(string $atRule, string $property) : bool
Parameters
$atRule : string
$property : string
Return values
bool

getAllowedIndentationChars()

Retrieve indentation chars allowed by the linter

public getAllowedIndentationChars() : AllowedIndentationChars
Return values
AllowedIndentationChars —

a list of allowed indentation chars

isAllowedIndentationChar()

Check if the given char is allowed as an indentation char

public isAllowedIndentationChar(string $charValue) : bool
Parameters
$charValue : string

the character to be checked

Return values
bool —

according to whether the character is allowed or not

mergeAtRulesNonStandards()

Merge the given non standards atrules with the current ones

public mergeAtRulesNonStandards(ReferentialData $nonStandards) : void
Parameters
$nonStandards : ReferentialData

non the standards atrules to be merged

mergeAtRulesPropertiesNonStandards()

Merge the given non standards at-rules properties with the current ones

public mergeAtRulesPropertiesNonStandards(ReferentialData $nonStandards) : void
Parameters
$nonStandards : ReferentialData

non the standards at-rules properties to be merged

mergeAtRulesPropertiesStandards()

Merge the given standards at-rules properties with the current ones

public mergeAtRulesPropertiesStandards(ReferentialData $standards) : void
Parameters
$standards : ReferentialData

the standards at-rules properties to be merged

mergeAtRulesStandards()

Merge the given standards at-rules with the current ones

public mergeAtRulesStandards(ReferentialData $standards) : void
Parameters
$standards : ReferentialData

the standards at-rules to be merged

mergeConstructors()

Merge the given constructors properties with the current ones

public mergeConstructors(ReferentialData $constructors) : void
Parameters
$constructors : ReferentialData

the constructors properties to be merged

mergePropertiesNonStandards()

Merge the given non standards properties with the current ones

public mergePropertiesNonStandards(ReferentialData $nonStandards) : void
Parameters
$nonStandards : ReferentialData

non the standards properties to be merged

mergePropertiesStandards()

Merge the given standards properties with the current ones

public mergePropertiesStandards(ReferentialData $standards) : void
Parameters
$standards : ReferentialData

the standards properties to be merged

propertyExists()

Checks that the given CSS property is an existing one

public propertyExists(string $property) : bool
Parameters
$property : string

the property to check

Return values
bool —

true if the property exists, else returns false

setAllowedIndentationChars()

Define the indentation chars allowed by the linter

public setAllowedIndentationChars(AllowedIndentationChars $allowedIndentationChars) : void
Parameters
$allowedIndentationChars : AllowedIndentationChars

a list of allowed indentation chars

setOptions()

public setOptions([LintConfigurationOptions $options = [] ]) : void
Parameters
$options : LintConfigurationOptions = []

Override default options "allowedIndentationChars" => [" "] or ["\t"] "constructors": ["property" => bool] "standards": ["property" => bool] "nonStandards": ["property" => bool]

On this page

Search results