Documentation

NullsafeObjectOperatorTest extends AbstractTokenizerTestCase
in package

FinalYes

Table of Contents

Properties

$fileExtension  : string
The file extension of the test case file (without leading dot).
$find  : array<string|int, int|string>
Tokens to search for.
$phpcsFile  : File
The \PHP_CodeSniffer\Files\File object containing the parsed contents of the test case file.
$tabWidth  : int
The tab width setting to use when tokenizing the file.

Methods

clearResolvedTokensCache()  : void
Clear the static "resolved tokens" cache property on the Tokenizer\PHP class.
dataNullsafeObjectOperator()  : array<string, array<string|int, string>>
Data provider.
dataTernaryThen()  : array<string, array<string, string|bool>>
Data provider.
testNullsafeObjectOperator()  : void
Test that a nullsafe object operator is tokenized as such.
testObjectOperator()  : void
Test that a normal object operator is still tokenized as such.
testTernaryThen()  : void
Test that a question mark not followed by an object operator is tokenized as T_TERNARY_THEN.
getTargetToken()  : int
Get the token pointer for a target token based on a specific comment found on the line before.
initializeFile()  : void
Initialize & tokenize \PHP_CodeSniffer\Files\File with code from the test case file.

Properties

$fileExtension

The file extension of the test case file (without leading dot).

protected string $fileExtension = 'inc'

This allows child classes to overrule the default inc with, for instance, js or css when applicable.

$find

Tokens to search for.

protected array<string|int, int|string> $find = [T_NULLSAFE_OBJECT_OPERATOR, T_OBJECT_OPERATOR, T_INLINE_THEN]

$phpcsFile

The \PHP_CodeSniffer\Files\File object containing the parsed contents of the test case file.

protected File $phpcsFile

$tabWidth

The tab width setting to use when tokenizing the file.

protected int $tabWidth = 4

This allows for test case files to use a different tab width than the default.

Methods

clearResolvedTokensCache()

Clear the static "resolved tokens" cache property on the Tokenizer\PHP class.

public static clearResolvedTokensCache() : void

This method should be used selectively by tests to ensure the code under test is actually hit by the test testing the code.

dataNullsafeObjectOperator()

Data provider.

public static dataNullsafeObjectOperator() : array<string, array<string|int, string>>
Tags
see
testNullsafeObjectOperator()
Return values
array<string, array<string|int, string>>

dataTernaryThen()

Data provider.

public static dataTernaryThen() : array<string, array<string, string|bool>>
Tags
see
testTernaryThen()
Return values
array<string, array<string, string|bool>>

testNullsafeObjectOperator()

Test that a nullsafe object operator is tokenized as such.

public testNullsafeObjectOperator(string $testMarker) : void
Parameters
$testMarker : string

The comment which prefaces the target token in the test file.

Tags
dataProvider

dataNullsafeObjectOperator

covers

testObjectOperator()

Test that a normal object operator is still tokenized as such.

public testObjectOperator() : void
Tags
covers

testTernaryThen()

Test that a question mark not followed by an object operator is tokenized as T_TERNARY_THEN.

public testTernaryThen(string $testMarker[, bool $testObjectOperator = false ]) : void
Parameters
$testMarker : string

The comment which prefaces the target token in the test file.

$testObjectOperator : bool = false

Whether to test for the next non-empty token being tokenized as an object operator.

Tags
dataProvider

dataTernaryThen

covers

getTargetToken()

Get the token pointer for a target token based on a specific comment found on the line before.

protected getTargetToken(string $commentString, int|string|array<string|int, mixed> $tokenType[, string $tokenContent = null ]) : int

Note: the test delimiter comment MUST start with "/* test" to allow this function to distinguish between comments used in a test and test delimiters.

Parameters
$commentString : string

The delimiter comment to look for.

$tokenType : int|string|array<string|int, mixed>

The type of token(s) to look for.

$tokenContent : string = null

Optional. The token content for the target token.

Return values
int

initializeFile()

Initialize & tokenize \PHP_CodeSniffer\Files\File with code from the test case file.

protected initializeFile() : void

The test case file for a unit test class has to be in the same directory directory and use the same file name as the test class, using the .inc extension.

Tags
before

        
On this page

Search results