TypedConstantsTest
extends AbstractTokenizerTestCase
in package
Table of Contents
Properties
- $fileExtension : string
- The file extension of the test case file (without leading dot).
- $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.
- dataDNFTypedConstant() : array<string, array<string, string>>
- Data provider.
- dataIntersectionTypedConstant() : array<string, array<string, string>>
- Data provider.
- dataNullableTypedConstant() : array<string, array<string, string>>
- Data provider.
- dataTypedConstant() : array<string, array<string, string|array<string|int, int|string>>>
- Data provider.
- dataUnionTypedConstant() : array<string, array<string, string>>
- Data provider.
- dataUntypedConstant() : array<string, array<string, string>>
- Data provider.
- testTernaryIsInlineThen() : void
- Test that a ? after a "const" which is not the constant keyword is tokenized as ternary then, not as the nullable operator.
- testTypedConstant() : void
- Test the tokens in the type of a typed constant as well as the constant name are tokenized correctly.
- testUntypedConstant() : void
- Test the token name for an untyped constant is tokenized as T_STRING.
- 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.
$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.
dataDNFTypedConstant()
Data provider.
public
static dataDNFTypedConstant() : array<string, array<string, string>>
Tags
Return values
array<string, array<string, string>>dataIntersectionTypedConstant()
Data provider.
public
static dataIntersectionTypedConstant() : array<string, array<string, string>>
Tags
Return values
array<string, array<string, string>>dataNullableTypedConstant()
Data provider.
public
static dataNullableTypedConstant() : array<string, array<string, string>>
Tags
Return values
array<string, array<string, string>>dataTypedConstant()
Data provider.
public
static dataTypedConstant() : array<string, array<string, string|array<string|int, int|string>>>
Tags
Return values
array<string, array<string, string|array<string|int, int|string>>>dataUnionTypedConstant()
Data provider.
public
static dataUnionTypedConstant() : array<string, array<string, string>>
Tags
Return values
array<string, array<string, string>>dataUntypedConstant()
Data provider.
public
static dataUntypedConstant() : array<string, array<string, string>>
Tags
Return values
array<string, array<string, string>>testTernaryIsInlineThen()
Test that a ? after a "const" which is not the constant keyword is tokenized as ternary then, not as the nullable operator.
public
testTernaryIsInlineThen() : void
Tags
testTypedConstant()
Test the tokens in the type of a typed constant as well as the constant name are tokenized correctly.
public
testTypedConstant(string $testMarker, array<string|int, int|string> $sequence) : void
Parameters
- $testMarker : string
-
The comment prefacing the target token.
- $sequence : array<string|int, int|string>
-
The expected token sequence.
Tags
testUntypedConstant()
Test the token name for an untyped constant is tokenized as T_STRING.
public
testUntypedConstant(string $testMarker) : void
Parameters
- $testMarker : string
-
The comment prefacing the target token.
Tags
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
intinitializeFile()
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.