Definition::dataPreProcessor() - Code Metrics - CuyZ/NotiZ - Measure and Improve Code Quality continuously with Scrutinizer

Definition::dataPreProcessor() A
last analyzed 2024-02-23 10:19 UTC

↳ Parent: Definition
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0
<?php
declare(strict_types=1);

/*
 * Copyright (C)
 * Nathan Boiron <[email protected]>
 * Romain Canon <[email protected]>
 *
 * 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;

use CuyZ\Notiz\Core\Definition\Tree\EventGroup\Event\EventDefinition;
use CuyZ\Notiz\Core\Definition\Tree\EventGroup\EventGroup;
use CuyZ\Notiz\Core\Definition\Tree\Notification\NotificationDefinition;
use CuyZ\Notiz\Core\Exception\EntryNotFoundException;
use CuyZ\Notiz\Core\Support\NotizConstants;
use Generator;
use Romm\ConfigurationObject\ConfigurationObjectInterface;
use Romm\ConfigurationObject\Service\Items\Cache\CacheService;
use Romm\ConfigurationObject\Service\Items\DataPreProcessor\DataPreProcessor;
use Romm\ConfigurationObject\Service\Items\DataPreProcessor\DataPreProcessorInterface;
use Romm\ConfigurationObject\Service\ServiceFactory;
use Romm\ConfigurationObject\Service\ServiceInterface;
use Romm\ConfigurationObject\Traits\ConfigurationObject\ArrayConversionTrait;

/**
 * Root object for the whole definition object tree.
 *
 * From this very object you can access to any definition value that you need.
 */
class Definition extends AbstractDefinitionComponent implements ConfigurationObjectInterface, DataPreProcessorInterface
{
    use ArrayConversionTrait;

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

    /**
     * @var \CuyZ\Notiz\Core\Definition\Tree\Notification\NotificationDefinition[]
     */
    protected $notifications = [];

    /**
     * @return EventGroup[]
     */
    public function getEventGroups(): array
    {
        return $this->eventGroups;
    }

    /**
     * @return Generator|EventDefinition[]
     */
    public function getEvents(): Generator
    {
        foreach ($this->eventGroups as $eventGroup) {
            foreach ($eventGroup->getEvents() as $event) {
                yield $eventGroup => $event;
            }
        }
    }

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

    /**
     * @param string $identifier
     * @return EventGroup
     *
     * @throws EntryNotFoundException
     */
    public function getEventGroup(string $identifier): EventGroup
    {
        if (false === $this->hasEventGroup($identifier)) {
            throw EntryNotFoundException::definitionEventGroupNotFound($identifier);
        }

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

    /**
     * @param string $fullIdentifier
     * @return EventDefinition
     *
     * @throws EntryNotFoundException
     */
    public function getEventFromFullIdentifier(string $fullIdentifier): EventDefinition
    {
        if (!$this->hasEventFromFullIdentifier($fullIdentifier)) {
            throw EntryNotFoundException::definitionEventFullIdentifierNotFound($fullIdentifier);
        }

        list($eventGroup, $event) = explode('.', $fullIdentifier);

        return $this->getEventGroup($eventGroup)->getEvent($event);
    }

    /**
     * @param string $fullIdentifier
     * @return bool
     */
    public function hasEventFromFullIdentifier(string $fullIdentifier): bool
    {
        list($eventGroup, $event) = explode('.', $fullIdentifier);

        return $this->hasEventGroup($eventGroup)
            && $this->getEventGroup($eventGroup)->hasEvent($event);
    }

    /**
     * @return EventGroup
     */
    public function getFirstEventGroup(): EventGroup
    {
        return array_pop(array_reverse($this->getEventGroups()));
        return array_pop(/** @scrutinizer ignore-type */ array_reverse($this->getEventGroups()));
    }

    /**
     * @return NotificationDefinition[]
     */
    public function getNotifications(): array
    {
        return $this->notifications;
    }

    /**
     * @return NotificationDefinition[]
     */
    public function getListableNotifications(): array
    {
        return array_filter(
            $this->notifications,
            function (NotificationDefinition $notificationDefinition) {
                return $notificationDefinition->isListable();
            }
        );
    }

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

    /**
     * @param string $identifier
     * @return NotificationDefinition
     *
     * @throws EntryNotFoundException
     */
    public function getNotification(string $identifier): NotificationDefinition
    {
        if (false === $this->hasNotification($identifier)) {
            throw EntryNotFoundException::definitionNotificationNotFound($identifier);
        }

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

    /**
     * @inheritdoc
     */
    public static function getConfigurationObjectServices()
    {
        return ServiceFactory::getInstance()
            ->attach(ServiceInterface::SERVICE_CACHE)
            ->setOption(CacheService::OPTION_CACHE_NAME, NotizConstants::CACHE_KEY_DEFINITION_OBJECT)
            ->attach(ServiceInterface::SERVICE_PARENTS)
            ->attach(ServiceInterface::SERVICE_DATA_PRE_PROCESSOR)
            ->attach(ServiceInterface::SERVICE_MIXED_TYPES);
    }

    /**
     * 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 event
     * groups and notifications with the keys of the array.
     *
     * @param DataPreProcessor $processor
     */
    public static function dataPreProcessor(DataPreProcessor $processor)
    {
        self::forceIdentifierForProperty($processor, 'eventGroups');
        self::forceIdentifierForProperty($processor, 'notifications');
    }
}

CuyZ / NotiZ

Definition::dataPreProcessor() A last analyzed 2024-02-23 10:19 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Definition::dataPreProcessor() A
last analyzed 2024-02-23 10:19 UTC
