CodeSniffer.php

Go to the documentation of this file.

<?php
namespace Magento\TestFramework\CodingStandard\Tool;

use Magento\TestFramework\CodingStandard\Tool\CodeSniffer\Wrapper;
use Magento\TestFramework\CodingStandard\ToolInterface;

class CodeSniffer implements ToolInterface, ExtensionInterface
{
    private $rulesetDir;

    private $reportFile;

    private $wrapper;

    private $extensions = [
        'php' => 'PHP',
        'phtml' => 'PHP',
    ];

    public function __construct($rulesetDir, $reportFile, Wrapper $wrapper)
    {
        $this->rulesetDir = $rulesetDir;
        if (!file_exists($rulesetDir) && file_exists($fullPath = realpath(__DIR__ . '/../../../../' . $rulesetDir))) {
            $this->rulesetDir = $fullPath;
        }
        $this->reportFile = $reportFile;
        $this->wrapper = $wrapper;
    }

    public function setExtensions(array $extensions)
    {
        $this->extensions = $extensions;
    }

    public function canRun()
    {
        return class_exists('\PHP_CodeSniffer\Runner');
    }

    public function run(array $whiteList)
    {
        if (empty($whiteList)) {
            return 0;
        }

        if (!defined('PHP_CODESNIFFER_IN_TESTS')) {
            define('PHP_CODESNIFFER_IN_TESTS', true);
        }

        $this->wrapper->checkRequirements();
        $settings = [];
        $settings['files'] = $whiteList;
        $settings['standards'] = [$this->rulesetDir];
        $settings['extensions'] = $this->extensions;
        $settings['warningSeverity'] = 0;
        $settings['reports']['full'] = $this->reportFile;
        $this->wrapper->setSettings($settings);

        ob_start();
        $result = $this->wrapper->runPHPCS();
        ob_end_clean();

        return $result;
    }
}