GetClassPropertiesTest
extends AbstractMethodUnitTest
in package
Tests for the \PHP_CodeSniffer\Files\File:getClassProperties method.
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
- dataGetClassProperties() : array<string, array<string, string|array<string, bool|int>>>
- Data provider.
- dataNotAClassException() : array<string, array<string, string|int>>
- Data provider.
- expectRunTimeException() : void
- Helper method to tell PHPUnit to expect a PHPCS RuntimeException in a PHPUnit cross-version compatible manner.
- getTargetToken() : int
- Get the token pointer for a target token based on a specific comment found on the line before.
- getTargetTokenFromFile() : 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.
- testGetClassProperties() : void
- Test retrieving the properties for a class declaration.
- testNotAClassException() : void
- Test receiving an expected exception when a non class token is passed.
Properties
$fileExtension
The file extension of the test case file (without leading dot).
protected
static 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
static File
$phpcsFile
$tabWidth
The tab width setting to use when tokenizing the file.
protected
static int
$tabWidth
= 4
This allows for test case files to use a different tab width than the default.
Methods
dataGetClassProperties()
Data provider.
public
static dataGetClassProperties() : array<string, array<string, string|array<string, bool|int>>>
Tags
Return values
array<string, array<string, string|array<string, bool|int>>>dataNotAClassException()
Data provider.
public
static dataNotAClassException() : array<string, array<string, string|int>>
Tags
Return values
array<string, array<string, string|int>>expectRunTimeException()
Helper method to tell PHPUnit to expect a PHPCS RuntimeException in a PHPUnit cross-version compatible manner.
public
expectRunTimeException(string $message) : void
Parameters
- $message : string
-
The expected exception message.
getTargetToken()
Get the token pointer for a target token based on a specific comment found on the line before.
public
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
intgetTargetTokenFromFile()
Get the token pointer for a target token based on a specific comment found on the line before.
public
static getTargetTokenFromFile(File $phpcsFile, 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
- $phpcsFile : File
-
The file to find the token in.
- $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.
Tags
Return values
intinitializeFile()
Initialize & tokenize \PHP_CodeSniffer\Files\File with code from the test case file.
public
static 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
testGetClassProperties()
Test retrieving the properties for a class declaration.
public
testGetClassProperties(string $testMarker, array<string, bool> $expected) : void
Parameters
- $testMarker : string
-
The comment which prefaces the target token in the test file.
- $expected : array<string, bool>
-
Expected function output.
Tags
testNotAClassException()
Test receiving an expected exception when a non class token is passed.
public
testNotAClassException(string $testMarker, int|string $tokenType) : void
Parameters
- $testMarker : string
-
The comment which prefaces the target token in the test file.
- $tokenType : int|string
-
The type of token to look for after the marker.