HistoryFactory.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\ProjectRoot;

interface HistoryFactory
{
    /**
     * Creates a HistoryAnalyser by passing in HistoryMarker for when BaseLine was created.
     *
     * @throws HistoryAnalyserException
     */
    public function newHistoryAnalyser(HistoryMarker $baseLineHistoryMarker, ProjectRoot $projectRoot): HistoryAnalyser;

    /**
     * Return factory for creating a HistoryMarker from a string representation of it.
     */
    public function newHistoryMarkerFactory(): HistoryMarkerFactory;

    /**
     * Returns Identifier for HistoryMarker (e.g. "git").
     */
    public function getIdentifier(): string;
}