Merge pull request #618 from PHPCSStandards/php-8.4/update-for-exit-as-function-call

PHP 8.4: updates for exit as function call

Author: jrfnl

PHPCSUtils/Tokens/Collections.php

@@ -692,6 +692,10 @@ public static function functionCallTokens()
         $tokens[\T_ANON_CLASS] = \T_ANON_CLASS;
         $tokens               += self::$ooHierarchyKeywords;
 
+        // As of PHP 8.4, exit()/die() should be treated as function call tokens.
+        // Sniffs using this collection should safeguard against use as a constant.
+        $tokens[\T_EXIT] = \T_EXIT;
+
         return $tokens;
     }
 

PHPCSUtils/Utils/PassedParameters.php

@@ -65,6 +65,9 @@ final class PassedParameters
      *   a short array opener.
      * - If passed a `T_ISSET` or `T_UNSET` stack pointer, it will detect whether those
      *   language constructs have "parameters".
+     * - If passed a `T_EXIT` stack pointer, it will treat it as a function call and detect whether
+     *   it has been passed parameters. When the `T_EXIT` is used as a constant, the return value
+     *   will be `false` (no parameters).
      *
      * @since 1.0.0
      *
@@ -94,7 +97,7 @@ public static function hasParameters(File $phpcsFile, $stackPtr, $isShortArray =
             throw OutOfBoundsStackPtr::create(2, '$stackPtr', $stackPtr);
         }
 
-        $acceptedTokens = 'function call, array, isset or unset';
+        $acceptedTokens = 'function call, array, isset, unset or exit';
         if (isset(Collections::parameterPassingTokens()[$tokens[$stackPtr]['code']]) === false) {
             throw UnexpectedTokenType::create(2, '$stackPtr', $acceptedTokens, $tokens[$stackPtr]['type']);
         }
@@ -131,7 +134,7 @@ public static function hasParameters(File $phpcsFile, $stackPtr, $isShortArray =
             return true;
         }
 
-        // Deal with function calls, long arrays, isset and unset.
+        // Deal with function calls, long arrays, isset, unset and exit/die.
         // Next non-empty token should be the open parenthesis.
         if ($tokens[$next]['code'] !== \T_OPEN_PARENTHESIS) {
             return false;

Tests/Tokens/Collections/FunctionCallTokensTest.php

@@ -40,6 +40,7 @@ public function testFunctionCallTokens()
             \T_PARENT               => \T_PARENT,
             \T_SELF                 => \T_SELF,
             \T_STATIC               => \T_STATIC,
+            \T_EXIT                 => \T_EXIT,
         ];
 
         $this->assertSame($expected, Collections::functionCallTokens());

Tests/Tokens/Collections/ParameterPassingTokensTest.php

@@ -40,6 +40,7 @@ public function testParameterPassingTokens()
             \T_PARENT               => \T_PARENT,
             \T_SELF                 => \T_SELF,
             \T_STATIC               => \T_STATIC,
+            \T_EXIT                 => \T_EXIT,
             \T_ISSET                => \T_ISSET,
             \T_UNSET                => \T_UNSET,
             \T_ARRAY                => \T_ARRAY,

Tests/Utils/PassedParameters/GetParametersNamedTest.inc

@@ -53,6 +53,9 @@ foo( label: $cond ? true : false, more: $cond ? CONSTANT_A : CONSTANT_B );
 /* testTernaryWithFunctionCallsInThenElse */
 echo $cond ? foo( label: $something ) : /* testTernaryWithFunctionCallsInElse */ bar( more: $something_else );
 
+/* testExitWithNamedParam */
+exit( status: 1 );
+
 /* testCompileErrorNamedBeforePositional */
 // Not the concern of PHPCSUtils. Should still be handled.
 test(param: $bar, $foo);

Tests/Utils/PassedParameters/GetParametersNamedTest.php

@@ -426,6 +426,20 @@ public static function dataGetParameters()
                     ],
                 ],
             ],
+            'named-args-for-exit' => [
+                'testMarker' => '/* testExitWithNamedParam */',
+                'targetType' => \T_EXIT,
+                'expected'   => [
+                    'status' => [
+                        'name'       => 'status',
+                        'name_token' => 3,
+                        'start'      => 5,
+                        'end'        => 7,
+                        'raw'        => '1',
+                    ],
+                ],
+            ],
+
             'named-args-compile-error-named-before-positional' => [
                 'testMarker' => '/* testCompileErrorNamedBeforePositional */',
                 'targetType' => \T_STRING,

Tests/Utils/PassedParameters/GetParametersSkipShortArrayCheckTest.php

@@ -45,7 +45,7 @@ public function testHasParametersDontSkipShortArrayCheck($testMarker, $targetTyp
         if ($expectException === true) {
             $this->expectException('PHPCSUtils\Exceptions\UnexpectedTokenType');
             $this->expectExceptionMessage(
-                'Argument #2 ($stackPtr) must be of type function call, array, isset or unset;'
+                'Argument #2 ($stackPtr) must be of type function call, array, isset, unset or exit;'
             );
         }
 
@@ -96,7 +96,7 @@ public function testGetParametersSkipShortArrayCheck($testMarker, $targetType, $
         if ($targetType === \T_OPEN_SQUARE_BRACKET) {
             $this->expectException('PHPCSUtils\Exceptions\UnexpectedTokenType');
             $this->expectExceptionMessage(
-                'Argument #2 ($stackPtr) must be of type function call, array, isset or unset;'
+                'Argument #2 ($stackPtr) must be of type function call, array, isset, unset or exit;'
             );
         }
 

Tests/Utils/PassedParameters/GetParametersTest.inc

@@ -120,6 +120,9 @@ if ( isset(
 /* testUnset */
 unset( $variable, $object->property, static::$property, $array[$name], );
 
+/* testDie */
+die( $status );
+
 /* testAnonClass */
 $anon = new class( $param1, $param2 ) {
     public function __construct($param1, $param2) {}

Tests/Utils/PassedParameters/GetParametersTest.php

@@ -523,6 +523,18 @@ public function test( $foo, $bar ) {
                     ],
                 ],
             ],
+            'die' => [
+                'testMarker' => '/* testDie */',
+                'targetType' => \T_EXIT,
+                'expected'   => [
+                    1 => [
+                        'start' => 2,
+                        'end'   => 4,
+                        'raw'   => '$status',
+                    ],
+                ],
+            ],
+
             'anon-class' => [
                 'testMarker' => '/* testAnonClass */',
                 'targetType' => \T_ANON_CLASS,

Tests/Utils/PassedParameters/HasParametersTest.inc

@@ -19,6 +19,13 @@ class Foo {
 /* testShortListNotShortArray */
 [ $a, $b ] = $array;
 
+/* testExitAsConstant */
+exit;
+
+/* testDieAsConstant */
+die;
+
+
 // Function calls: no parameters.
 
 /* testNoParamsFunctionCall1 */
@@ -163,6 +170,18 @@ unset(
 
 );
 
+/* testNoParamsExit */
+exit();
+
+/* testHasParamsExit */
+exit( $code );
+
+/* testNoParamsDie */
+die( /*comment*/ );
+
+/* testHasParamsDie */
+die( $status );
+
 /* testNoParamsNoParensAnonClass */
 $anon = new class extends FooBar {};