DaveLiddament\StaticAnalysisResultsBaseliner\Domain\BaseLiner\BaseLineAnalysisResult

Complexity

Total Complexity

12

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getFileName()	0	3	1
A	make()	0	8	1
A	getSeverity()	0	3	1
A	asArray()	0	8	1
A	getType()	0	3	1
A	fromArray()	0	9	1
A	getMessage()	0	3	1
A	getLineNumber()	0	3	1
A	isMatch()	0	6	3
A	__construct()	0	12	1

<?php

declare(strict_types=1);

namespace DaveLiddament\StaticAnalysisResultsBaseliner\Domain\BaseLiner;

use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\LineNumber;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\PreviousLocation;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\RelativeFileName;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Severity;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Type;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ArrayParseException;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ArrayUtils;

class BaseLineAnalysisResult
{
    private const LINE_NUMBER = 'lineNumber';
    private const FILE_NAME = 'fileName';
    private const TYPE = 'type';
    private const MESSAGE = 'message';
    private const SEVERITY = 'severity';

    /**
     * @var RelativeFileName
     */
    private $fileName;
    /**
     * @var LineNumber
     */
    private $lineNumber;
    /**
     * @var Type
     */
    private $type;
    /**
     * @var string
     */
    private $message;
    /**
     * @var Severity
     */
    private $severity;

    /**
     * @psalm-param array<mixed> $array
     *
     * @throws ArrayParseException
     */
    public static function fromArray(array $array): self
    {
        $lineNumber = new LineNumber(ArrayUtils::getIntValue($array, self::LINE_NUMBER));
        $fileName = new RelativeFileName(ArrayUtils::getStringValue($array, self::FILE_NAME));
        $type = new Type(ArrayUtils::getStringValue($array, self::TYPE));
        $severity = Severity::fromStringOrNull(ArrayUtils::getOptionalStringValue($array, self::SEVERITY));
        $message = ArrayUtils::getStringValue($array, self::MESSAGE);

        return new self($fileName, $lineNumber, $type, $message, $severity);
    }

    public static function make(
        RelativeFileName $fileName,
        LineNumber $lineNumber,
        Type $type,
        string $message,
        Severity $severity
    ): self {
        return new self($fileName, $lineNumber, $type, $message, $severity);
    }

    private function __construct(
        RelativeFileName $fileName,
        LineNumber $lineNumber,
        Type $type,
        string $message,
        Severity $severtiy
        ) {
        $this->fileName = $fileName;
        $this->lineNumber = $lineNumber;
        $this->type = $type;
        $this->message = $message;
        $this->severity = $severtiy;
    }

    public function getFileName(): RelativeFileName
    {
        return $this->fileName;
    }

    public function getLineNumber(): LineNumber
    {
        return $this->lineNumber;
    }

    public function getType(): Type
    {
        return $this->type;
    }

    public function getMessage(): string
    {
        return $this->message;
    }

    public function getSeverity(): Severity
    {
        return $this->severity;
    }

    /**
     * @psalm-return array<string,string|int>
     */
    public function asArray(): array
    {
        return [
            self::LINE_NUMBER => $this->getLineNumber()->getLineNumber(),
            self::FILE_NAME => $this->getFileName()->getFileName(),
            self::TYPE => $this->type->getType(),
            self::MESSAGE => $this->message,
            self::SEVERITY => $this->severity->getSeverity(),
        ];
    }

    /**
     * Return true if this matches matches given FileName, LineNumber and type.
     */
    public function isMatch(PreviousLocation $location, Type $type): bool
    {
        return
            $this->fileName->isEqual($location->getRelativeFileName()) &&
            $this->lineNumber->isEqual($location->getLineNumber()) &&
            $this->type->isEqual($type);
    }
}