CodeCoverageInterface.php

<?php

/*
 * This file is part of the doyo/code-coverage project.
 *
 * (c) Anthonius Munthi <https://itstoni.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Doyo\Bridge\CodeCoverage;

use Doyo\Bridge\CodeCoverage\Event\CoverageEvent;

/**
 * A main code coverage actions that contain main processor
 * for collecting code coverage.
 */
interface CodeCoverageInterface
{
    /**
     * Refresh code coverage and remove all data.
     *
     * @return CoverageEvent
     */
    public function refresh(): CoverageEvent;

    /**
     * @param TestCase $testCase
     *
     * @return CoverageEvent
     */
    public function start(TestCase $testCase): CoverageEvent;

    /**
     * Stop code coverage.
     *
     * @return CoverageEvent
     */
    public function stop(): CoverageEvent;

    /**
     * Complete code coverage and process report.
     *
     * @return CoverageEvent
     */
    public function complete(): CoverageEvent;

    public function setResult(int $result): CoverageEvent;
}