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

EventDefinition::getIdentifier() A
last analyzed 2024-02-23 10:19 UTC

↳ Parent: EventDefinition

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
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\EventGroup\Event;

use CuyZ\Notiz\Core\Definition\Tree\AbstractDefinitionComponent;
use CuyZ\Notiz\Core\Definition\Tree\Definition;
use CuyZ\Notiz\Core\Definition\Tree\EventGroup\Event\Configuration\EventConfiguration;
use CuyZ\Notiz\Core\Definition\Tree\EventGroup\Event\Connection\Connection;
use CuyZ\Notiz\Core\Definition\Tree\EventGroup\EventGroup;
use CuyZ\Notiz\Core\Notification\Notification;
use CuyZ\Notiz\Core\Property\Factory\PropertyDefinition;
use CuyZ\Notiz\Core\Property\Factory\PropertyFactory;
use CuyZ\Notiz\Service\LocalizationService;
use Romm\ConfigurationObject\Service\Items\DataPreProcessor\DataPreProcessor;
use Romm\ConfigurationObject\Service\Items\DataPreProcessor\DataPreProcessorInterface;
use Romm\ConfigurationObject\Service\Items\Parents\ParentsTrait;

class EventDefinition extends AbstractDefinitionComponent implements DataPreProcessorInterface
{
    use ParentsTrait;

    /**
     * @var string
     *
     * @validate NotEmpty
     */
    protected $identifier;

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

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

    /**
     * @var string
     *
     * @validate Romm.ConfigurationObject:ClassImplements(interface=CuyZ\Notiz\Core\Event\Event)
     */
    protected $className;

    /**
     * @var \CuyZ\Notiz\Core\Definition\Tree\EventGroup\Event\Configuration\EventConfiguration
     */
    protected $configuration;

    /**
     * @var \CuyZ\Notiz\Core\Definition\Tree\EventGroup\Event\Connection\Connection
     *
     * @validate NotEmpty
     *
     * @mixedTypesResolver \CuyZ\Notiz\Core\Definition\Tree\EventGroup\Event\Connection\ConnectionResolver
     */
    protected $connection;

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

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

    /**
     * Returns a full version of the identifier, containing both the event group
     * identifier and the event identifier, separated by a dot.
     *
     * @return string
     */
    public function getFullIdentifier(): string
    {
        return $this->getGroup()->getIdentifier() . '.' . $this->identifier;
    }

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

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

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

    /**
     * @return EventConfiguration
     */
    public function getConfiguration(): EventConfiguration
    {
        return $this->configuration;
    }

    /**
     * @return Connection
     */
    public function getConnection(): Connection
    {
        return $this->connection;
    }

    /**
     * @return EventGroup
     */
    public function getGroup(): EventGroup
    {
        /** @var EventGroup $eventGroup */
        $eventGroup = $this->getFirstParent(EventGroup::class);

        return $eventGroup;
    }

    /**
     * @param string $propertyClassName
     * @param Notification $notification
     * @return PropertyDefinition
     */
    public function getPropertyDefinition(string $propertyClassName, Notification $notification): PropertyDefinition
    {
        return PropertyFactory::get()->getPropertyDefinition($propertyClassName, $this, $notification);
        return PropertyFactory::get()->/** @scrutinizer ignore-call */ getPropertyDefinition($propertyClassName, $this, $notification);
    }

    /**
     * Counts the number of notifications that are using this event.
     *
     * @return int
     */
    public function getNotificationNumber(): int
    {
        $counter = 0;

        /** @var Definition $definition */
        $definition = $this->getFirstParent(Definition::class);

        foreach ($definition->getListableNotifications() as $notification) {
            $counter += $notification->getProcessor()->countNotificationsFromEventDefinition($this);
        }

        return $counter;
    }

    /**
     * @param DataPreProcessor $processor
     */
    public static function dataPreProcessor(DataPreProcessor $processor)
    {
        $data = $processor->getData();

        // Configuration must always be set.
        if (!is_array($data['configuration'])) {
            $data['configuration'] = [];
        }

        $processor->setData($data);
    }
}


CuyZ / NotiZ

EventDefinition::getIdentifier() A last analyzed 2024-02-23 10:19 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

EventDefinition::getIdentifier() A
last analyzed 2024-02-23 10:19 UTC