Documentation

FindEndOfStatementTest extends AbstractMethodUnitTest
in package

FinalYes

Tests for the \PHP_CodeSniffer\Files\File::findEndOfStatement method.

Tags
covers

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

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.
testArrowFunctionArrayValue()  : void
Test arrow function as array value.
testArrowFunctionAsArgument()  : void
Test arrow function used as a function argument.
testArrowFunctionReturnValue()  : void
Test arrow function with return value.
testArrowFunctionWithArrayAsArgument()  : void
Test arrow function with arrays used as a function argument.
testClosureAssignment()  : void
Test the assignment of a closure.
testControlStructure()  : void
Test a direct call to a control structure.
testEndIsNeverLessThanCurrentToken()  : void
Test that end of statement is NEVER before the "current" token.
testHeredocFunctionArg()  : void
Test using a heredoc in a function argument.
testMatchArray()  : void
Test match expression with array declaration.
testMatchCase()  : void
Test simple match expression case.
testMatchClosure()  : void
Test match expression with closure.
testMatchDefault()  : void
Test simple match expression default case.
testMatchDefaultComma()  : void
Test match expression default case with trailing comma.
testMatchFunctionCall()  : void
Test match expression with function call.
testMatchFunctionCallArm()  : void
Test match expression with function call in the arm.
testMatchMultipleCase()  : void
Test multiple comma-separated match expression case values.
testNestedMatch()  : void
Test nested match expressions.
testSimpleAssignment()  : void
Test a simple assignment.
testStatementAsArrayValue()  : void
Test statements that are array values.
testStaticArrowFunction()  : void
Test static arrow function.
testSwitch()  : void
Test parts of a switch statement.
testUseGroup()  : void
Test a use group.

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

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
int

getTargetTokenFromFile()

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
throws
Exception

When the test delimiter comment is not found.

throws
Exception

When the test target token is not found.

Return values
int

initializeFile()

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
beforeClass

testArrowFunctionArrayValue()

Test arrow function as array value.

public testArrowFunctionArrayValue() : void

testArrowFunctionAsArgument()

Test arrow function used as a function argument.

public testArrowFunctionAsArgument() : void

testArrowFunctionReturnValue()

Test arrow function with return value.

public testArrowFunctionReturnValue() : void

testArrowFunctionWithArrayAsArgument()

Test arrow function with arrays used as a function argument.

public testArrowFunctionWithArrayAsArgument() : void

testControlStructure()

Test a direct call to a control structure.

public testControlStructure() : void

testEndIsNeverLessThanCurrentToken()

Test that end of statement is NEVER before the "current" token.

public testEndIsNeverLessThanCurrentToken() : void

testHeredocFunctionArg()

Test using a heredoc in a function argument.

public testHeredocFunctionArg() : void

testMatchDefaultComma()

Test match expression default case with trailing comma.

public testMatchDefaultComma() : void

testMatchFunctionCall()

Test match expression with function call.

public testMatchFunctionCall() : void

testMatchFunctionCallArm()

Test match expression with function call in the arm.

public testMatchFunctionCallArm() : void

testMatchMultipleCase()

Test multiple comma-separated match expression case values.

public testMatchMultipleCase() : void

testStatementAsArrayValue()

Test statements that are array values.

public testStatementAsArrayValue() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results