CuyZ\Notiz\Core\Definition\Tree\EventGroup\EventGroup

Complexity

Total Complexity

9

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getLabel()	0	3	1
A	dataPreProcessor()	0	3	1
A	getFirstEvent()	0	3	1
A	hasEvent()	0	3	1
A	getEvent()	0	7	2
A	getEvents()	0	3	1
A	getIdentifier()	0	3	1
A	__construct()	0	3	1

<?php
declare(strict_types=1);

/*
 * Copyright (C)
 * Nathan Boiron <nathan.boiron@gmail.com>
 * Romain Canon <romain.hydrocanon@gmail.com>
 *
 * This file is part of the TYPO3 NotiZ project.
 * It is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, either
 * version 3 of the License, or any later version.
 *
 * For the full copyright and license information, see:
 * http://www.gnu.org/licenses/gpl-3.0.html
 */

namespace CuyZ\Notiz\Core\Definition\Tree\EventGroup;

use CuyZ\Notiz\Core\Definition\Tree\AbstractDefinitionComponent;
use CuyZ\Notiz\Core\Definition\Tree\EventGroup\Event\EventDefinition;
use CuyZ\Notiz\Core\Exception\EntryNotFoundException;
use CuyZ\Notiz\Service\LocalizationService;
use Romm\ConfigurationObject\Service\Items\DataPreProcessor\DataPreProcessor;
use Romm\ConfigurationObject\Service\Items\DataPreProcessor\DataPreProcessorInterface;

class EventGroup extends AbstractDefinitionComponent implements DataPreProcessorInterface
{
    /**
     * @var string
     *
     * @validate NotEmpty
     */
    protected $identifier;

    /**
     * @var string
     */
    protected $label;

    /**
     * @var \CuyZ\Notiz\Core\Definition\Tree\EventGroup\Event\EventDefinition[]
     *
     * @validate NotEmpty
     */
    protected $events = [];

    /**
     * @param string $identifier
     */
    public function __construct(string $identifier)
    {
        $this->identifier = $identifier;
    }

    /**
     * @return string
     */
    public function getIdentifier(): string
    {
        return $this->identifier;
    }

    /**
     * @return string
     */
    public function getLabel(): string
    {
        return LocalizationService::localize($this->label);
    }

    /**
     * @return EventDefinition[]
     */
    public function getEvents(): array
    {
        return $this->events;
    }

    /**
     * @param string $identifier
     * @return bool
     */
    public function hasEvent(string $identifier): bool
    {
        return true === isset($this->events[$identifier]);
    }

    /**
     * @param string $identifier
     * @return EventDefinition
     *
     * @throws EntryNotFoundException
     */
    public function getEvent(string $identifier): EventDefinition
    {
        if (false === $this->hasEvent($identifier)) {
            throw EntryNotFoundException::definitionEventNotFound($identifier);
        }

        return $this->events[$identifier];
    }

    /**
     * @return EventDefinition
     */
    public function getFirstEvent(): EventDefinition
    {
        return array_pop(array_reverse($this->getEvents()));

array_reverse($this->getEvents()) cannot be passed to array_pop() as the parameter $array expects a reference.

    }

    /**
     * Method called during the definition object construction: it allows
     * manipulating the data array before it is actually used to construct the
     * object.
     *
     * We use it to automatically fill the `identifier` property of the events
     * with the keys of the array.
     *
     * @param DataPreProcessor $processor
     */
    public static function dataPreProcessor(DataPreProcessor $processor)
    {
        self::forceIdentifierForProperty($processor, 'events');
    }
}