MonsieurBiz\SyliusSalesReportsPlugin\Event\CustomReportEvent

Complexity

Total Complexity

9

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	removeReport()	0	6	2
A	getCustomReports()	0	3	1
A	getFromDate()	0	3	1
A	getToDate()	0	3	1
A	getChannel()	0	3	1
A	addReport()	0	6	2

<?php

declare(strict_types=1);

namespace MonsieurBiz\SyliusSalesReportsPlugin\Event;

use MonsieurBiz\SyliusSalesReportsPlugin\Exception\AlreadyExistsReport;
use MonsieurBiz\SyliusSalesReportsPlugin\Exception\NotExistsReport;
use Sylius\Component\Core\Model\ChannelInterface;
use Symfony\Component\EventDispatcher\Event;

final class CustomReportEvent extends Event

The class Symfony\Component\EventDispatcher\Event has been deprecated: since Symfony 4.3, use "Symfony\Contracts\EventDispatcher\Event" instead

{
    /**
     * @var array
     */
    private $customReports = [];

    /**
     * @var ChannelInterface
     */
    private $channel;

    /**
     * @var \DateTimeInterface
     */
    private $fromDate;

    /**
     * @var \DateTimeInterface|null
     */
    private $toDate;

    public function __construct(
        ChannelInterface $channel,
        \DateTimeInterface $fromDate,
        ?\DateTimeInterface $toDate = null
    ) {
        $this->channel = $channel;
        $this->fromDate = $fromDate;
        $this->toDate = $toDate;
    }

    /**
     * Retrieve custom reports, use a template override to display it
     *
     * @return array
     */
    public function getCustomReports(): array
    {
        return $this->customReports;
    }

    /**
     * Add a new custom report, you can't have reports with the same key
     *
     * @param string $key
     * @param array $data
     * @throws AlreadyExistsReport
     */
    public function addReport(string $key, array $data)
    {
        if (isset($this->customReports[$key])) {
            throw new AlreadyExistsReport(sprintf('Report "%s" already exists', $key));
        }
        $this->customReports[$key] = $data;
    }

    /**
     * Remove a custom report, you cannot remove a key which not exists
     *
     * @param string $key
     * @throws NotExistsReport
     */
    public function removeReport(string $key)
    {
        if (!isset($this->customReports[$key])) {
            throw new NotExistsReport(sprintf('Report "%s" does not exist', $key));
        }
        unset($this->customReports[$key]);
    }

    /**
     * @return ChannelInterface
     */
    public function getChannel(): ChannelInterface
    {
        return $this->channel;
    }

    /**
     * @return \DateTimeInterface
     */
    public function getFromDate(): \DateTimeInterface
    {
        return $this->fromDate;
    }

    /**
     * @return \DateTimeInterface|null
     */
    public function getToDate(): ?\DateTimeInterface
    {
        return $this->toDate;
    }
}