EntityEmailTcaService::getDefinitionIdentifier() - Code Metrics - Inspection of "[!!!][TASK] Make notification aware of its definit..." - CuyZ/NotiZ - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Branch — tmp/scrutinizer-notification-d... (24bdcd)

by Romain
created 2018-05-18 14:39 UTC
EntityEmailTcaService::getDefinitionIdentifier() A

↳ Parent: EntityEmailTcaService
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

/*
 * Copyright (C) 2018
 * 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\Domain\Notification\Email\Application\EntityEmail\TCA;

use CuyZ\Notiz\Core\Definition\Tree\EventGroup\Event\EventDefinition;
use CuyZ\Notiz\Core\Notification\Service\NotificationTcaService;
use CuyZ\Notiz\Core\Notification\Settings\NotificationSettings;
use CuyZ\Notiz\Domain\Notification\Email\Application\EntityEmail\EntityEmailNotification;
use CuyZ\Notiz\Domain\Notification\Email\Application\EntityEmail\Settings\EntityEmailSettings;
use CuyZ\Notiz\Domain\Notification\Email\Application\EntityEmail\Settings\GlobalRecipients\Recipient;
use CuyZ\Notiz\Domain\Property\Email;
use CuyZ\Notiz\Service\Container;
use CuyZ\Notiz\Service\LocalizationService;
use CuyZ\Notiz\View\Slot\Service\SlotFlexFormService;
use CuyZ\Notiz\View\Slot\Service\SlotViewService;

class EntityEmailTcaService extends NotificationTcaService
{
    /**
     * @var SlotViewService
     */
    protected $slotViewService;

    /**
     * @var SlotFlexFormService
     */
    protected $slotFlexFormService;

    /**
     * Manual dependency injection.
     */
    public function __construct()
    {
        parent::__construct();

        $this->slotViewService = Container::get(SlotViewService::class);
        $this->slotFlexFormService = Container::get(SlotFlexFormService::class);
    }

    /**
     * Loads all recipients provided by the selected event and stores them as an
     * array to be used in the TCA.
     *
     * @param array $parameters
     */
    public function getRecipientsList(array &$parameters)
    {
        if ($this->definitionHasErrors()) {
            return;
        }

        $row = $parameters['row'];
        $eventDefinition = $this->getSelectedEvent($row);
        $notification = $this->getNotification($row);

        $eventRecipients = array_map(
            function (Email $recipient) {
                return [
                    'label' => $recipient->getLabel(),
                    'value' => $recipient->getName(),
                ];
            },
            $eventDefinition->getPropertyDefinition(Email::class, $notification)->getEntries()
        );

        $globalRecipients = array_map(
            function (Recipient $recipient) {
                return [
                    'label' => $recipient->getName(),
                    'value' => $recipient->getIdentifier(),
                ];
            },
            $this->getNotificationSettings()->getGlobalRecipients()->getRecipients()
            $this->getNotificationSettings()->/** @scrutinizer ignore-call */ getGlobalRecipients()->getRecipients()
        );

        if (!empty($eventRecipients)) {
            $this->appendOptionGroup($eventRecipients, LocalizationService::localize('Notification/Email/Entity:field.recipients.event_recipients'));
        }

        if (!empty($globalRecipients)) {
            $this->appendOptionGroup($globalRecipients, LocalizationService::localize('Notification/Email/Entity:field.recipients.global_recipients'));
        }

        $recipients = array_merge_recursive($eventRecipients, $globalRecipients);

        foreach ($recipients as $recipient) {
            $parameters['items'][] = [
                $recipient['label'],
                $recipient['value'],
            ];
        }
    }

    /**
     * List all available layouts and stores them as an array
     * to be used in the TCA.
     *
     * @param array $parameters
     */
    public function getLayoutList(array &$parameters)
    {
        if ($this->definitionHasErrors()) {
            return;
        }

        $layouts = $this->getNotificationSettings()->getView()->getLayouts();
        $layouts = $this->getNotificationSettings()->/** @scrutinizer ignore-call */ getView()->getLayouts();

        foreach ($layouts as $key => $layout) {
            $label = $layout->hasLabel()
                ? $layout->getLabel()
                : LocalizationService::localize('Notification/Email/Entity:field.layout.undefined_label', [$key]);

            $parameters['items'][] = [
                $label,
                $layout->getIdentifier(),
            ];
        }
    }

    /**
     * Builds a condition allowing the mail body to be shown only if the
     * selected events does provide slots for the Fluid template.
     *
     * By default, an event with no custom Fluid template does have a single
     * slot.
     *
     * @return array
     */
    public function getMailBodyDisplayCond()
    {
        $eventsWithSlots = [];
        $events = $this->slotViewService->getEventsWithoutSlots($this->getNotificationSettings()->getView());

        foreach ($events as $event => $view) {
            /** @var EventDefinition $event */
            $eventsWithSlots[] = $event->getFullIdentifier();
        }

        return [
            'AND' => [
                'FIELD:event:!IN:' . implode(',', $eventsWithSlots),
                'FIELD:event:!=:' // Hide the body when no event is selected.
            ]
        ];
    }

    /**
     * @return array
     */
    public function getMailBodyFlexFormList()
    {
        $viewSettings = $this->getNotificationSettings()->getView();

        return $this->slotFlexFormService->getNotificationFlexFormList($viewSettings);
    }

    /**
     * @return string
     */
    public function getDefaultSender()
    {
        if ($this->definitionHasErrors()) {
            return '';
        }

        return $this->getNotificationSettings()->getDefaultSender();
        return $this->getNotificationSettings()->/** @scrutinizer ignore-call */ getDefaultSender();
    }

    /**
     * This methods returns true if the current selected event has one provided
     * email address. This is used as a displayCond in the TCA.
     *
     * @param array $parameters
     * @return bool
     */
    public function shouldShowProvidedRecipientsSelect(array $parameters)
    {
        if ($this->definitionHasErrors()) {
            return false;
        }

        $row = $parameters['record'];
        $eventDefinition = $this->getSelectedEvent($row);
        $notification = $this->getNotification($row);

        /** @var Email[] $recipients */
        $recipients = $eventDefinition->getPropertyDefinition(Email::class, $notification)->getEntries();

        $globalRecipients = $this->getNotificationSettings()
            ->getGlobalRecipients()
            ->getRecipients();

        return count($recipients) > 0 || count($globalRecipients) > 0;
    }

    /**
     * @return EntityEmailSettings|NotificationSettings
     */
    protected function getNotificationSettings()
    {
        return $this->getNotificationDefinition()->getSettings();
    }

    /**
     * @return string
     */
    protected function getDefinitionIdentifier()
    {
        return EntityEmailNotification::getDefinitionIdentifier();
    }
}

CuyZ / NotiZ

Branch — tmp/scrutinizer-notification-d... (24bdcd)

EntityEmailTcaService::getDefinitionIdentifier() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
