alecrabbit / php-reports

src/Reports/Core/Reportable.php

<?php declare(strict_types=1);

namespace AlecRabbit\Reports\Core;

use AlecRabbit\Reports\Contracts\ReportableInterface;
use AlecRabbit\Reports\Contracts\ReportInterface;

abstract class Reportable implements ReportableInterface
{
    /** @var ReportInterface */
    protected $report;

    public function __construct()
    {
        $this->report = $this->createEmptyReport();
    }

    abstract protected function createEmptyReport(): ReportInterface;

    /**
     * @param bool $rebuild Rebuild report object
     * @return ReportInterface
     */
    public function report(bool $rebuild = true): ReportInterface
    {
        $rebuild = $this->checkReport() || $rebuild;
        if (true === $rebuild) {
            $this->checkConditions();
            $this->beforeReport();
            /** @noinspection PhpParamsInspection */
            $this->report->buildOn($this);
        }
        return
            $this->report;
    }

    /**
     * @return bool
     * @psalm-suppress RedundantConditionGivenDocblockType
     */
    protected function checkReport(): bool
    {
        if ($this->report instanceof ReportInterface) {

$this->report is always a sub-type of AlecRabbit\Reports\Contracts\ReportInterface.

            return false;
        }
        $this->report = $this->createEmptyReport();
        return true;
    }

    /**
     * Checks if all conditions needed for report are met
     */
    protected function checkConditions(): void
    {
    }

    /**
     * Makes all necessary actions before report
     */
    protected function beforeReport(): void
    {
    }
}