AlecRabbit\Traits\ForReports\Core\Reportable

Complexity

Total Complexity

7

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Test Coverage

Coverage

93.75%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	checkReport()	0	7	2
A	beforeReport()	0	2	1
A	report()	0	11	3
A	checkConditions()	0	2	1

<?php declare(strict_types=1);

namespace AlecRabbit\Traits\ForReports\Core;

use AlecRabbit\Traits\ForReports\Contracts\ReportableInterface;
use AlecRabbit\Traits\ForReports\Contracts\ReportInterface;

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

    /**
     * @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;
    }

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

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

    abstract protected function createEmptyReport(): ReportInterface;

    /**
     * @return bool
     */
    protected function checkReport(): bool
    {
        if (null === $this->report) {
            $this->report = $this->createEmptyReport();
            return true;
        }
        return false;
    }
}