Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x

DeadCatchSniff.php

Namespace

SlevomatCodingStandard\Sniffs\Exceptions

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/DeadCatchSniff.php

View source
<?php

declare (strict_types=1);
namespace SlevomatCodingStandard\Sniffs\Exceptions;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use SlevomatCodingStandard\Helpers\CatchHelper;
use SlevomatCodingStandard\Helpers\TokenHelper;
use function in_array;
use const T_CATCH;
class DeadCatchSniff implements Sniff {
    public const CODE_CATCH_AFTER_THROWABLE_CATCH = 'CatchAfterThrowableCatch';
    
    /**
     * @return array<int, (int|string)>
     */
    public function register() : array {
        return [
            T_CATCH,
        ];
    }
    
    /**
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
     * @param int $catchPointer
     */
    public function process(File $phpcsFile, $catchPointer) : void {
        $tokens = $phpcsFile->getTokens();
        $catchToken = $tokens[$catchPointer];
        $caughtTypes = CatchHelper::findCaughtTypesInCatch($phpcsFile, $catchToken);
        if (!in_array('\\Throwable', $caughtTypes, true)) {
            return;
        }
        $nextCatchPointer = TokenHelper::findNextEffective($phpcsFile, $catchToken['scope_closer'] + 1);
        while ($nextCatchPointer !== null) {
            $nextCatchToken = $tokens[$nextCatchPointer];
            if ($nextCatchToken['code'] !== T_CATCH) {
                break;
            }
            $phpcsFile->addError('Unreachable catch block.', $nextCatchPointer, self::CODE_CATCH_AFTER_THROWABLE_CATCH);
            $nextCatchPointer = TokenHelper::findNextEffective($phpcsFile, $nextCatchToken['scope_closer'] + 1);
        }
    }

}

Classes

Title Deprecated Summary
DeadCatchSniff

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal