DaveLiddament / sarb

src/Domain/Common/PreviousLocation.php

<?php

/**
 * Static Analysis Results Baseliner (sarb).
 *
 * (c) Dave Liddament
 *
 * For the full copyright and licence information please view the LICENSE file distributed with this source code.
 */

declare(strict_types=1);

namespace DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common;

use Webmozart\Assert\Assert;

final class PreviousLocation
{
    public static function noPreviousLocation(): self
    {
        return new self(null, null);
    }

    public static function fromFileNameAndLineNumber(RelativeFileName $relativeFileName, LineNumber $lineNumber): self
    {
        return new self($relativeFileName, $lineNumber);
    }

    private function __construct(
        private ?RelativeFileName $relativeFileName,
        private ?LineNumber $lineNumber,
    ) {
    }

    public function isNoPreviousLocation(): bool
    {
        return null === $this->relativeFileName;
    }

    public function getRelativeFileName(): RelativeFileName
    {
        Assert::notNull($this->relativeFileName, 'Trying to get FileName when PreviousLocation is not set');

        return $this->relativeFileName;

The expression return $this->relativeFileName could return the type null which is incompatible with the type-hinted return DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\RelativeFileName. Consider adding an additional type-check to rule them out.

    }

    public function getLineNumber(): LineNumber
    {
        Assert::notNull($this->lineNumber, 'Trying to get LineNumber when PreviousLocation is not set');

        return $this->lineNumber;

The expression return $this->lineNumber could return the type null which is incompatible with the type-hinted return DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\LineNumber. Consider adding an additional type-check to rule them out.

    }
}