EntityNotification::isActive() - Code Metrics - Inspection of "[FEATURE] Handle disabled notifications in the man..." - CuyZ/NotiZ - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( c2c83c...eb4088 )

by Nathan
created 2018-11-26 20:33 UTC
EntityNotification::isActive() A

↳ Parent: EntityNotification
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;

use CuyZ\Notiz\Backend\Module\ManagerModuleHandler;
use CuyZ\Notiz\Core\Definition\DefinitionService;
use CuyZ\Notiz\Core\Definition\Tree\Definition;
use CuyZ\Notiz\Core\Definition\Tree\EventGroup\Event\EventDefinition;
use CuyZ\Notiz\Core\Definition\Tree\Notification\Channel\ChannelDefinition;
use CuyZ\Notiz\Core\Definition\Tree\Notification\NotificationDefinition;
use CuyZ\Notiz\Core\Notification\MultipleChannelsNotification;
use CuyZ\Notiz\Core\Notification\Notification;
use CuyZ\Notiz\Service\Container;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Type\Bitmask\Permission;
use TYPO3\CMS\Core\Utility\ArrayUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
use TYPO3\CMS\Extbase\Domain\Model\BackendUser;
use TYPO3\CMS\Extbase\DomainObject\AbstractEntity;
use TYPO3\CMS\Extbase\Service\FlexFormService;

abstract class EntityNotification extends AbstractEntity implements Notification, MultipleChannelsNotification
{
    /**
     * @var string
     */
    protected $title;

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

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

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

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

    /**
     * @var array
     */
    protected $eventConfiguration;

    /**
     * @var \TYPO3\CMS\Extbase\Domain\Model\BackendUser
     * @lazy
     */
    protected $backendUser;

    /**
     * @var bool
     */
    protected $hidden;

    /**
     * @return string|null
     */
    public function getTitle()
    {
        return $this->title;
    }

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

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

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

    /**
     * @return string
     */
    public function getEvent()
    {
        return $this->event;
    }

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

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

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

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

    /**
     * @return bool
     */
    public function isActive()
    {
        return !$this->hidden;
    }

    /**
     * @param bool $active
     * @return void
     */
    public function setActive($active)
    {
        $this->hidden = !$active;
    }

    /**
     * @param EventDefinition|null $eventDefinition
     * @return string
     */
    public function getSwitchActivationUri(EventDefinition $eventDefinition = null)
    {
        $managerModuleHandler = Container::get(ManagerModuleHandler::class);

        return $managerModuleHandler
            ->getUriBuilder()
            ->forController('Backend\\Manager\\NotificationActivation')
            ->forAction('process')
            ->withArguments([
                'notificationType' => $this->getNotificationDefinition()->getIdentifier(),
                'notificationIdentifier' => $this->getUid(),
                'filterEvent' => $eventDefinition->getFullIdentifier(),
                'filterEvent' => $eventDefinition->/** @scrutinizer ignore-call */ getFullIdentifier(),
            ]);
    }

    /**
     * @return NotificationDefinition
     */
    public function getNotificationDefinition()
    {
        return self::getDefinition()->getNotification(static::getDefinitionIdentifier());
    }

    /**
     * @return bool
     */
    public function hasEventDefinition()
    {
        return self::getDefinition()->hasEventFromFullIdentifier($this->getEvent());
    }

    /**
     * @return EventDefinition
     */
    public function getEventDefinition()
    {
        return self::getDefinition()->getEventFromFullIdentifier($this->getEvent());
    }

    /**
     * Returns the event configuration stored as a FlexForm string.
     *
     * @return array
     */
    public function getEventConfiguration()
    {
        if (null === $this->eventConfiguration) {
            /** @var FlexFormService $flexFormService */
            $flexFormService = GeneralUtility::makeInstance(FlexFormService::class);

            $this->eventConfiguration = $flexFormService->convertFlexFormContentToArray($this->eventConfigurationFlex);
        }

        return $this->eventConfiguration;
    }

    /**
     * @return BackendUser
     */
    public function getBackendUser()
    {
        return $this->backendUser;
    }

    /**
     * @return bool
     */
    public static function isCreatable()
    {
        return Container::getBackendUser()
            && Container::getBackendUser()->check('tables_modify', self::getTableName());
    }

    /**
     * @param string $selectedEvent
     * @return string
     */
    public static function getCreationUri($selectedEvent = null)
    {
        $tableName = static::getTableName();

        $href = BackendUtility::getModuleUrl(
            'record_edit',
            [
                "edit[$tableName][0]" => 'new',
                'returnUrl' => GeneralUtility::getIndpEnv('TYPO3_REQUEST_URL'),
            ]
        );

        if ($selectedEvent) {
            $href .= "&selectedEvent=$selectedEvent";
        }

        return $href;
    }

    /**
     * @return bool
     */
    public function isEditable()
    {
        $backendUser = Container::getBackendUser();
        $page = Container::getPageRepository()->getPage($this->pid);
        $userPermissionOnPage = $backendUser->calcPerms($page);

        return $backendUser->recordEditAccessInternals(self::getTableName(), $this->uid)
            && ($this->pid === 0
                || (bool)($userPermissionOnPage & Permission::CONTENT_EDIT)
            );
    }

    /**
     * @return string
     */
    public function getEditionUri()
    {
        $identifier = $this->getNotificationDefinition()->getIdentifier();
        $tableName = static::getTableName();
        $uid = $this->getUid();

        return BackendUtility::getModuleUrl(
            'record_edit',
            [
                "edit[$tableName][$uid]" => 'edit',
                'returnUrl' => GeneralUtility::getIndpEnv('TYPO3_REQUEST_URL') . "#$identifier-$uid",
            ]
        );
    }

    /**
     * @return bool
     */
    public static function isListable()
    {
        return Container::getBackendUser()
            && Container::getBackendUser()->check('tables_select', self::getTableName());
    }

    /**
     * @return bool
     */
    public function isViewable()
    {
        return self::isListable();
    }

    /**
     * @return string
     */
    public function getViewUri()
    {
        $notificationDefinition = $this->getNotificationDefinition();

        $controller = 'Backend\\Manager\\Notification\\Show' . ucfirst($notificationDefinition->getIdentifier());

        $managerModuleHandler = Container::get(ManagerModuleHandler::class);

        return $managerModuleHandler
            ->getUriBuilder()
            ->forController($controller)
            ->forAction('show')
            ->withArguments(['notificationIdentifier' => $this->getUid()])
            ->build();
    }

    /**
     * The selected channel is stored in the `$channel` property.
     *
     * @inheritdoc
     */
    public function shouldDispatch(ChannelDefinition $definition)
    {
        return $definition->getClassName() === $this->getChannel();
    }

    /**
     * Returns the name of the table for this notification. It is fetched in the
     * global TypoScript configuration.
     *
     * @return string
     */
    public static function getTableName()
    {
        /** @var ConfigurationManagerInterface $configurationManager */
        $configurationManager = Container::get(ConfigurationManagerInterface::class);
        $configuration = $configurationManager->getConfiguration(ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);

        $className = self::getDefinition()
            ->getNotification(static::getDefinitionIdentifier())
            ->getClassName();

        return ArrayUtility::getValueByPath($configuration, "persistence/classes/$className/mapping/tableName");
    }

    /**
     * @return string
     */
    abstract public static function getDefinitionIdentifier();

    /**
     * @return Definition
     */
    protected static function getDefinition()
    {
        return DefinitionService::get()->getDefinition();
    }
}

CuyZ / NotiZ

Push — master ( c2c83c...eb4088 )

EntityNotification::isActive() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
