CreateParenthesisNestingMapDNFTypesTest
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.
- dataDNFTypeParentheses() : array<string, array<string, string>>
- Data provider.
- dataNormalParentheses() : array<string, array<string, string|int|false>>
- Data provider.
- testDNFTypeParentheses() : void
- Test that parentheses when used in a DNF type declaration are correctly tokenized.
- testNormalParentheses() : void
- Test that parentheses when **not** used in a type declaration are correctly tokenized.
- 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.
dataDNFTypeParentheses()
Data provider.
public
static dataDNFTypeParentheses() : array<string, array<string, string>>
Tags
Return values
array<string, array<string, string>>dataNormalParentheses()
Data provider.
public
static dataNormalParentheses() : array<string, array<string, string|int|false>>
Tags
Return values
array<string, array<string, string|int|false>>testDNFTypeParentheses()
Test that parentheses when used in a DNF type declaration are correctly tokenized.
public
testDNFTypeParentheses(string $testMarker) : void
Includes verifying that:
- the tokens between the parentheses all have a "nested_parenthesis" key.
- all ampersands between the parentheses are tokenized as T_TYPE_INTERSECTION.
Parameters
- $testMarker : string
-
The comment prefacing the target token.
Tags
testNormalParentheses()
Test that parentheses when **not** used in a type declaration are correctly tokenized.
public
testNormalParentheses(string $testMarker[, int|false $owner = false ]) : void
Parameters
- $testMarker : string
-
The comment prefacing the target token.
- $owner : int|false = false
-
Optional. The parentheses owner or false when no parentheses owner is expected.
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.