HistoryAnalyser.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\HistoryAnalyser;

use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\LineNumber;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Location;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\PreviousLocation;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\RelativeFileName;

/**
 * Provides mappings between the current Location (file and line number) and where it in the baseline. (If anywhere).
 */
interface HistoryAnalyser
{
    /**
     * Return PreviousLocation (e.g. where it was in the baseline) for the current Location.
     */
    public function getPreviousLocation(RelativeFileName $fileName, LineNumber $lineNumber): PreviousLocation;
}