Documentation

GetMethodPropertiesTest extends AbstractMethodUnitTest

in package

• Application

Tests for the \PHP_CodeSniffer\Files\File::getMethodProperties 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

dataNotAFunctionException()  : array<string, array<string, string|int|array<string|int, 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.

testAbstractMethod()  : void

Test a basic abstract method.

testAbstractReturnMethod()  : void

Test an abstract method with a return type.

testArrowFunction()  : void

Test a static arrow function.

testArrowFunctionArrayReturnValue()  : void

Test handling of incorrect tokenization of array return type declarations for arrow functions in a very specific code sample in PHPCS < 3.5.4.

testArrowFunctionReturnByRef()  : void

Test handling of an arrow function returning by reference.

testBasicFunction()  : void

Test a basic function.

testBasicMethod()  : void

Test a basic method.

testClosureWithUseMultiParamWithReturnType()  : void

Test handling of closure declarations with a use variable import with a return type declaration.

testClosureWithUseNoReturnType()  : void

Test handling of closure declarations with a use variable import without a return type declaration.

testClosureWithUseNoReturnTypeIllegalUseProp()  : void

Test handling of closure declarations with an illegal use variable for a property import (not allowed in PHP) without a return type declaration.

testClosureWithUseWithReturnType()  : void

Test handling of closure declarations with a use variable import with a return type declaration.

testFinalMethod()  : void

Test a basic final method.

testFunctionDeclarationNestedInTernaryPHPCS2975()  : void

Test handling of function declaration nested in a ternary, where the colon for the return type was incorrectly tokenized as T_INLINE_ELSE prior to PHPCS 3.5.7.

testInterfaceMethod()  : void

Test a basic interface method.

testMessyNullableReturnMethod()  : void

Test a public method with a nullable return type.

testNamespaceOperatorTypeHint()  : void

Test a function with return type using the namespace operator.

testNestedClosure()  : void

Test a closure used as a function argument.

testNotAFunctionException()  : void

Test receiving an expected exception when a non function token is passed.

testNullableReturnMethod()  : void

Test a public method with a nullable return type.

testPHP81IllegalIntersectionTypes()  : void

Verify recognition of PHP8.1 intersection type declaration with illegal simple types.

testPHP81IntersectionArrowFunction()  : void

Verify recognition of PHP8.1 intersection type declaration in arrow function.

testPHP81MoreIntersectionTypes()  : void

Verify recognition of PHP8.1 intersection type declaration with more types.

testPHP81NeverType()  : void

Verify recognition of PHP8.1 type "never".

testPHP81NullableIntersectionTypes()  : void

Verify recognition of PHP8.1 intersection type declaration with (illegal) nullability.

testPHP81NullableNeverType()  : void

Verify recognition of PHP8.1 type "never" with (illegal) nullability.

testPHP82DNFType()  : void

Verify recognition of PHP 8.2 DNF return type declaration.

testPHP82DNFTypeAbstractMethod()  : void

Verify recognition of PHP 8.2 DNF return type declaration on an abstract method.

testPHP82DNFTypeClosure()  : void

Verify recognition of PHP 8.2 DNF return type declaration on a closure.

testPHP82DNFTypeFn()  : void

Verify recognition of PHP 8.2 DNF return type declaration on an arrow function.

testPHP82DNFTypeIllegalNullable()  : void

Verify recognition of PHP 8.2 DNF return type declaration with illegal nullability.

testPHP82PseudoTypeFalseAndTrue()  : void

Verify recognition of PHP 8.2 type declaration with (illegal) type false combined with type true.

testPHP82PseudoTypeTrue()  : void

Verify recognition of PHP 8.2 stand-alone `true` type.

testPHP8DuplicateTypeInUnionWhitespaceAndComment()  : void

Verify recognition of PHP8 type declaration with (illegal) duplicate types.

testPHP8IntersectionTypes()  : void

Verify recognition of PHP8.1 intersection type declaration.

testPHP8MixedTypeHint()  : void

Test a function with return type "mixed".

testPHP8MixedTypeHintNullable()  : void

Test a function with return type "mixed" and nullability.

testPHP8ObjectAndClass()  : void

Verify recognition of PHP8 type declaration with (illegal) type object combined with a class name.

testPHP8PseudoTypeFalse()  : void

Verify recognition of PHP8 type declaration with (illegal) single type false.

testPHP8PseudoTypeFalseAndBool()  : void

Verify recognition of PHP8 type declaration with (illegal) type false combined with type bool.

testPHP8PseudoTypeIterableAndArray()  : void

Verify recognition of PHP8 type declaration with (illegal) type iterable combined with array/Traversable.

testPHP8PseudoTypeNull()  : void

Verify recognition of PHP8 type declaration with (illegal) single type null.

testPHP8UnionTypesAllBaseTypes()  : void

Verify recognition of PHP8 union type declaration with all base types.

testPHP8UnionTypesAllPseudoTypes()  : void

Verify recognition of PHP8 union type declaration with all pseudo types.

testPHP8UnionTypesNullable()  : void

Verify recognition of PHP8 union type declaration with (illegal) nullability.

testPHP8UnionTypesSimple()  : void

Verify recognition of PHP8 union type declaration.

testPHP8UnionTypesTwoClasses()  : void

Verify recognition of PHP8 union type declaration with two classes.

testPhpcsIssue1264()  : void

Test for incorrect tokenization of array return type declarations in PHPCS < 2.8.0.

testPrivateStaticMethod()  : void

Test a private static method.

testProtectedReturnMethod()  : void

Test a protected method with a return type.

testPublicReturnMethod()  : void

Test a public method with a return type.

testReturnFunction()  : void

Test a function with a return type.

testReturnMultilineNamespace()  : void

Test a method with a messy namespaces return type.

testReturnNamespace()  : void

Test a method with a namespaced return type.

testReturnPartiallyQualifiedName()  : void

Test a method with a partially qualified namespaced return type.

testReturnTypeNullableStatic()  : void

Test a function with return type "?static".

testReturnTypeStatic()  : void

Test a function with return type "static".

testReturnUnqualifiedName()  : void

Test a method with an unqualified named return type.

getMethodPropertiesTestHelper()  : void

Test helper.