Documentation

FindStartOfStatementTest extends AbstractMethodUnitTest
in package

Application

FinalYes

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

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

dataFindStartInsideClosedScopeNestedWithinMatch() : array<string, array<string, int|string>>: Data provider.
dataFindStartInsideParenthesesNestedWithinMatch() : array<string, array<string, int|string>>: Data provider.
dataFindStartInsideParenthesesNestedWithinNestedMatch() : array<string, array<string, int|string>>: Data provider.
dataFindStartInsideShortArrayNestedWithinMatch() : array<string, array<string, int|string>>: Data provider.
dataFindStartInsideSwitchCaseDefaultStatements() : array<string, array<string, int|string>>: 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.
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.
testFindStartInsideClosedScopeNestedWithinMatch() : void: Test finding the start of a statement inside a closed scope nested within a match expressions.
testFindStartInsideParenthesesNestedWithinMatch() : void: Test finding the start of a statement for a token within a set of parentheses within a match expressions.
testFindStartInsideParenthesesNestedWithinNestedMatch() : void: Test finding the start of a statement for a token within a set of parentheses within a match expressions, which itself is nested within parentheses.
testFindStartInsideShortArrayNestedWithinMatch() : void: Test finding the start of a statement for a token within a short array within a match expressions.
testFindStartInsideSwitchCaseDefaultStatements() : void: Test finding the start of a statement inside a switch control structure case/default statement.
testFunctionCall() : void: Test a function call.
testFunctionCallArgument() : void: Test a function call.
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.
testObjectCallPrecededByArrowFunctionAsFunctionCallParameterInArray() : void: Test object call on result of static function call with arrow function as parameter and wrapped within an array.
testOpenTag() : void: Test PHP open tag.
testOpenTagWithEcho() : void: Test PHP short open echo tag.
testSimpleAssignment() : void: Test a simple assignment.
testStartIsNeverMoreThanCurrentToken() : void: Test that start of statement is NEVER beyond the "current" token.
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.

$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.