CommentTestCase
extends AbstractTokenizerTestCase
in package
Base class for testing DocBlock comment tokenization.
Tags
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.
- dataDocblockOpenerCloser() : array<string, array<string, string|int|array<string|int, int>>>
- Data provider.
- testDocblockOpenerCloser() : void
- Test whether the docblock opener and closer have the expected extra keys.
- checkTokenSequence() : void
- Test helper. Check a token sequence complies with an expected token sequence.
- 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.
dataDocblockOpenerCloser()
Data provider.
public
abstract static dataDocblockOpenerCloser() : array<string, array<string, string|int|array<string|int, int>>>
Tags
Return values
array<string, array<string, string|int|array<string|int, int>>>testDocblockOpenerCloser()
Test whether the docblock opener and closer have the expected extra keys.
public
testDocblockOpenerCloser(string $marker, int $closerOffset, array<string|int, int> $expectedTags) : void
Parameters
- $marker : string
-
The comment prefacing the target token.
- $closerOffset : int
-
The offset of the closer from the opener.
- $expectedTags : array<string|int, int>
-
The expected tags offsets array.
Tags
checkTokenSequence()
Test helper. Check a token sequence complies with an expected token sequence.
protected
checkTokenSequence(int $startPtr, array<string|int, array<int|string, string>> $expectedSequence) : void
Parameters
- $startPtr : int
-
The position in the file to start checking from.
- $expectedSequence : array<string|int, array<int|string, string>>
-
The consecutive token constants and their contents to expect.
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.