Documentation

PropertyTypeHandlingSniff
in package
implements Sniff

FinalYes

Table of Contents

Interfaces

Sniff

Properties

$emptyStringBecomesNull  : string|null
Used to verify that a string value with only whitespace will end up being set as null.
$expectsArrayWithExtendedKeysAndValues  : array<string|int, mixed>
Used to verify that array properties can get extended.
$expectsArrayWithExtendedValues  : array<string|int, mixed>
Used to verify that array properties can get extended.
$expectsArrayWithKeysAndValues  : array<string, mixed>
Used to verify that array properties with keys get parsed to a proper array.
$expectsArrayWithOnlyValues  : array<string|int, mixed>
Used to verify that array properties get parsed to a proper array.
$expectsBooleanFalse  : bool
Used to verify that booleans get set as proper boolean values.
$expectsBooleanFalseCase  : bool
Used to verify that booleans get set as proper boolean values.
$expectsBooleanFalseTrimmed  : bool
Used to verify that booleans get set as proper boolean values.
$expectsBooleanTrue  : bool
Used to verify that booleans get set as proper boolean values.
$expectsBooleanTrueCase  : bool
Used to verify that booleans get set as proper boolean values.
$expectsBooleanTrueTrimmed  : bool
Used to verify that booleans get set as proper boolean values.
$expectsEmptyArray  : array<string|int, mixed>
Used to verify that array properties allow for setting a property to an empty array.
$expectsFloatButAcceptsString  : float
Used to verify that floating point properties do not have special handling and will be set as a string.
$expectsIntButAcceptsString  : int
Used to verify that integer properties do not have special handling and will be set as a string.
$expectsNull  : null
Used to verify that null gets set as a string.
$expectsNullCase  : null
Used to verify that null gets set as a string.
$expectsOldSchoolArrayWithExtendedKeysAndValues  : array<string, mixed>
Used to verify that array properties passed as a string can get extended.
$expectsOldSchoolArrayWithExtendedValues  : array<string, mixed>
Used to verify that array properties passed as a string can get extended.
$expectsOldSchoolArrayWithKeysAndValues  : array<string, mixed>
Used to verify that array properties passed as a string with keys get parsed to a proper array.
$expectsOldSchoolArrayWithOnlyValues  : array<string|int, mixed>
Used to verify that array properties passed as a string get parsed to a proper array.
$expectsOldSchoolEmptyArray  : array<string|int, mixed>
Used to verify that array properties passed as a string allow for setting a property to an empty array.
$expectsString  : string
Used to verify that string properties are set as string.
$expectsTrimmedString  : string
Used to verify that string properties are set as string, with surrounding whitespace trimmed.

Methods

process()  : void|int
Called when one of the token types that this sniff is listening for is found.
register()  : array<string|int, int|string>
Registers the tokens that this sniff wants to listen for.

Properties

$emptyStringBecomesNull

Used to verify that a string value with only whitespace will end up being set as null.

public string|null $emptyStringBecomesNull

$expectsArrayWithExtendedKeysAndValues

Used to verify that array properties can get extended.

public array<string|int, mixed> $expectsArrayWithExtendedKeysAndValues

$expectsArrayWithExtendedValues

Used to verify that array properties can get extended.

public array<string|int, mixed> $expectsArrayWithExtendedValues

$expectsArrayWithKeysAndValues

Used to verify that array properties with keys get parsed to a proper array.

public array<string, mixed> $expectsArrayWithKeysAndValues

$expectsArrayWithOnlyValues

Used to verify that array properties get parsed to a proper array.

public array<string|int, mixed> $expectsArrayWithOnlyValues

$expectsBooleanFalse

Used to verify that booleans get set as proper boolean values.

public bool $expectsBooleanFalse

$expectsBooleanFalseCase

Used to verify that booleans get set as proper boolean values.

public bool $expectsBooleanFalseCase

$expectsBooleanFalseTrimmed

Used to verify that booleans get set as proper boolean values.

public bool $expectsBooleanFalseTrimmed

$expectsBooleanTrue

Used to verify that booleans get set as proper boolean values.

public bool $expectsBooleanTrue

$expectsBooleanTrueCase

Used to verify that booleans get set as proper boolean values.

public bool $expectsBooleanTrueCase

$expectsBooleanTrueTrimmed

Used to verify that booleans get set as proper boolean values.

public bool $expectsBooleanTrueTrimmed

$expectsEmptyArray

Used to verify that array properties allow for setting a property to an empty array.

public array<string|int, mixed> $expectsEmptyArray

$expectsFloatButAcceptsString

Used to verify that floating point properties do not have special handling and will be set as a string.

public float $expectsFloatButAcceptsString

$expectsIntButAcceptsString

Used to verify that integer properties do not have special handling and will be set as a string.

public int $expectsIntButAcceptsString

$expectsOldSchoolArrayWithExtendedKeysAndValues

Used to verify that array properties passed as a string can get extended.

public array<string, mixed> $expectsOldSchoolArrayWithExtendedKeysAndValues

$expectsOldSchoolArrayWithExtendedValues

Used to verify that array properties passed as a string can get extended.

public array<string, mixed> $expectsOldSchoolArrayWithExtendedValues

$expectsOldSchoolArrayWithKeysAndValues

Used to verify that array properties passed as a string with keys get parsed to a proper array.

public array<string, mixed> $expectsOldSchoolArrayWithKeysAndValues

$expectsOldSchoolArrayWithOnlyValues

Used to verify that array properties passed as a string get parsed to a proper array.

public array<string|int, mixed> $expectsOldSchoolArrayWithOnlyValues

$expectsOldSchoolEmptyArray

Used to verify that array properties passed as a string allow for setting a property to an empty array.

public array<string|int, mixed> $expectsOldSchoolEmptyArray

$expectsString

Used to verify that string properties are set as string.

public string $expectsString

This is the default behaviour.

$expectsTrimmedString

Used to verify that string properties are set as string, with surrounding whitespace trimmed.

public string $expectsTrimmedString

This is the default behaviour.

Methods

process()

Called when one of the token types that this sniff is listening for is found.

public process(File $phpcsFile, mixed $stackPtr) : void|int

The stackPtr variable indicates where in the stack the token was found. A sniff can acquire information about this token, along with all the other tokens within the stack by first acquiring the token stack:

$tokens = $phpcsFile->getTokens(); echo 'Encountered a '.$tokens[$stackPtr]['type'].' token'; echo 'token information: '; print_r($tokens[$stackPtr]);

If the sniff discovers an anomaly in the code, they can raise an error by calling addError() on the \PHP_CodeSniffer\Files\File object, specifying an error message and the position of the offending token:

$phpcsFile->addError('Encountered an error', $stackPtr);
Parameters
$phpcsFile : File

The PHP_CodeSniffer file where the token was found.

$stackPtr : mixed

The position in the PHP_CodeSniffer file's token stack where the token was found.

Return values
void|int —

Optionally returns a stack pointer. The sniff will not be called again on the current file until the returned stack pointer is reached. Return $phpcsFile->numTokens to skip the rest of the file.

register()

Registers the tokens that this sniff wants to listen for.

public register() : array<string|int, int|string>

An example return value for a sniff that wants to listen for whitespace and any comments would be:

return array( T_WHITESPACE, T_DOC_COMMENT, T_COMMENT, );
Return values
array<string|int, int|string>
On this page

Search results