AlecRabbit\Tools\Reports\Traits\HasReport

Complexity

Total Complexity

4

Size/Duplication

Total Lines	35
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	report()	0	11	2
A	meetConditions()	0	2	1
A	beforeReport()	0	2	1

<?php declare(strict_types=1);

namespace AlecRabbit\Tools\Reports\Traits;

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

trait HasReport
{
    /** @var ReportInterface */
    protected $report;

    /**
     * @param bool $rebuild Rebuild report object
     * @return ReportInterface
     * @throws \Exception
     */
    public function report(bool $rebuild = true): ReportInterface
    {
        if (true === $rebuild) {
            $this->meetConditions();
            $this->beforeReport();
            /** @var ReportableInterface $that */
            $that = $this;
            $this->report->buildOn($that); // $that used for static analysis
        }
        return
            $this->report;
    }

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

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