BestIt\CodeSniffer\Helper\ExceptionHelper

Complexity

Total Complexity

4

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	handleException()	0	19	3

<?php

declare(strict_types=1);

namespace BestIt\CodeSniffer\Helper;

use BestIt\CodeSniffer\CodeError;
use BestIt\CodeSniffer\CodeWarning;
use PHP_CodeSniffer\Files\File;

/**
 * Registers the exception as an error or warning on the file.
 *
 * @author blange <bjoern.lange@bestit-online.de>
 * @package BestIt\CodeSniffer
 */
class ExceptionHelper
{
    /**
     * The sniffed file.
     *
     * @var File
     */
    private $file;

    /**
     * ExceptionHelper constructor.
     *
     * @param File $file The sniffed file.
     */
    public function __construct(File $file)
    {
        $this->file = $file;
    }

    /**
     * Registers the exception as an error or warning on the file.
     *
     * @param CodeWarning $exception The error which should be handled.
     *
     * @return bool Should this error be fixed?
     */
    public function handleException(CodeWarning $exception): bool
    {
        $isError = $exception instanceof CodeError;
        $isFixable = $exception->isFixable();
        $method = 'add';

        if ($isFixable) {
            $method .= 'Fixable';
        }

        $method .= $isError ? 'Error' : 'Warning';

        return $this->file->$method(
            $exception->getMessage(),
            $exception->getStackPosition(),
            $exception->getCode(),
            $exception->getPayload()
        );
    }
}