RestrictedCodeSniff.php

<?php

/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

declare(strict_types=1);

namespace Magento2\Sniffs\Legacy;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Util\Common;

/**
 * Tests to find usage of restricted code
 */
class RestrictedCodeSniff implements Sniff
{
    private const ERROR_MESSAGE = "Class '%s' is restricted in %s. Suggested replacement: %s";

    /**
     * List of fixtures that contain restricted classes and should not be tested
     *
     * @var array
     */
    private $fixtureFiles = [];

    /**
     * Restricted classes
     *
     * @var array
     */
    private $classes = [];

    /**
     * RestrictedCodeSniff constructor.
     */
    public function __construct()
    {
        // phpcs:ignore Magento2.Security.IncludeFile.FoundIncludeFile
        $this->classes = include __DIR__ . '/_files/restricted_classes.php';
    }

    /**
     * @inheritdoc
     */
    public function register()
    {
        return [
            T_STRING,
            T_CONSTANT_ENCAPSED_STRING
        ];
    }

    /**
     * @inheritdoc
     */
    public function process(File $phpcsFile, $stackPtr)
    {
        // phpcs:ignore Magento2.Functions.DiscouragedFunction
        if (array_key_exists(basename($phpcsFile->getFilename()), $this->fixtureFiles)) {
            return;
        }

        $tokens = $phpcsFile->getTokens();
        $token = $tokens[$stackPtr]['content'];
        if (array_key_exists($token, $this->classes)) {
            if ($this->isExcluded($token, $phpcsFile)) {
                return;
            }

            $phpcsFile->addError(
                self::ERROR_MESSAGE,
                $stackPtr,
                $this->classes[$token]['warning_code'],
                [
                    $token,
                    Common::stripBasepath($phpcsFile->getFilename(), $phpcsFile->config->basepath),
                    $this->classes[$token]['replacement'],
                ]
            );
        }
    }

    /**
     * Checks if currently parsed file should be excluded from analysis
     *
     * @param string $token
     * @param File $phpcsFile
     *
     * @return bool
     */
    private function isExcluded(string $token, File $phpcsFile): bool
    {
        if (in_array($phpcsFile->getFilename(), $this->fixtureFiles)) {
            return true;
        }

        foreach ($this->classes[$token]['exclude'] as $exclude) {
            if (strpos($phpcsFile->getFilename(), $exclude) !== false) {
                return true;
            }
        }

        return false;
    }
}