CuyZ / NotiZ

Classes/Backend/FormEngine/ButtonBar/ShowNotificationDetailsButton.php

<?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\Backend\FormEngine\ButtonBar;

use CuyZ\Notiz\Core\Definition\DefinitionService;
use CuyZ\Notiz\Core\Definition\Tree\Notification\NotificationDefinition;
use CuyZ\Notiz\Core\Notification\Viewable;
use CuyZ\Notiz\Domain\Notification\EntityNotification;
use CuyZ\Notiz\Service\LocalizationService;
use ReflectionClass;
use TYPO3\CMS\Backend\Controller\EditDocumentController;

The type TYPO3\CMS\Backend\Controller\EditDocumentController was not found. Maybe you did not declare it correctly or list all dependencies?

use TYPO3\CMS\Backend\Template\Components\ButtonBar;

The type TYPO3\CMS\Backend\Template\Components\ButtonBar was not found. Maybe you did not declare it correctly or list all dependencies?

use TYPO3\CMS\Backend\Template\ModuleTemplate;

The type TYPO3\CMS\Backend\Template\ModuleTemplate was not found. Maybe you did not declare it correctly or list all dependencies?

use TYPO3\CMS\Core\Imaging\Icon;
use TYPO3\CMS\Core\Imaging\IconFactory;
use TYPO3\CMS\Core\SingletonInterface;

/**
 * Adds a button "View details" to the button bar at the top of the screen when
 * editing a notification record.
 *
 * Clicking this button loads the NotiZ module showing more information about
 * the current notification.
 */
class ShowNotificationDetailsButton implements SingletonInterface
{
    /**
     * @var DefinitionService
     */
    protected $definitionService;

    /**
     * @var IconFactory
     */
    protected $iconFactory;

    /**
     * @param DefinitionService $definitionService
     * @param IconFactory $iconFactory
     */
    public function __construct(DefinitionService $definitionService, IconFactory $iconFactory)
    {
        $this->definitionService = $definitionService;
        $this->iconFactory = $iconFactory;
    }

    /**
     * @param EditDocumentController $controller
     */
    public function addButton(EditDocumentController $controller)
    {
        if ($this->definitionService->getValidationResult()->hasErrors()) {
            return;
        }

        foreach ($this->definitionService->getDefinition()->getNotifications() as $notificationDefinition) {
            $notification = $this->getNotification($notificationDefinition, $controller);

            if ($notification) {
                $this->addButtonForNotification($controller, $notification);

                break;
            }
        }
    }

    /**
     * @param NotificationDefinition $notificationDefinition
     * @param EditDocumentController $controller
     * @return Viewable|null [PHP 7.1]
     */
    protected function getNotification(NotificationDefinition $notificationDefinition, EditDocumentController $controller)
    {
        /** @var EntityNotification|Viewable $className */
        $className = $notificationDefinition->getClassName();

        if (!in_array(Viewable::class, class_implements($className))
            || !in_array(EntityNotification::class, class_parents($className))
        ) {
            return null;
        }

        $tableName = $className::getTableName();

The method getTableName() does not exist on CuyZ\Notiz\Core\Notification\Viewable. Since it exists in all sub-types, consider adding an abstract or default implementation to CuyZ\Notiz\Core\Notification\Viewable.

        if (!isset($controller->editconf[$tableName])) {
            return null;
        }

        $uid = reset(array_keys($controller->editconf[$tableName]));

        // We show the button only for existing records being edited.
        if ($controller->editconf[$tableName][$uid] !== 'edit') {
            return null;
        }

        /** @var Viewable $notification */
        $notification = $notificationDefinition->getProcessor()->getNotificationFromIdentifier((string)$uid);

        return $notification;
    }

    /**
     * @param EditDocumentController $controller
     * @param Viewable $notification
     */
    protected function addButtonForNotification(EditDocumentController $controller, Viewable $notification)
    {
        $buttonBar = $this->getModuleTemplate($controller)
            ->getDocHeaderComponent()
            ->getButtonBar();

        $button = $buttonBar->makeLinkButton()
            ->setShowLabelText(true)
            ->setHref($notification->getViewUri())
            ->setTitle(LocalizationService::localize('Notification/Entity:button_bar.view_details'))
            ->setIcon($this->iconFactory->getIcon(
                'actions-view',
                Icon::SIZE_SMALL
            ));

        $buttonBar->addButton($button, ButtonBar::BUTTON_POSITION_LEFT, 50);
    }

    /**
     * Unfortunately TYPO3 doesn't provide a public API to access the module
     * template and add an icon to it, so we need to cheat a bit.
     *
     * @param EditDocumentController $controller
     * @return ModuleTemplate
     */
    protected function getModuleTemplate(EditDocumentController $controller): ModuleTemplate
    {
        $reflection = new ReflectionClass($controller);
        $property = $reflection->getProperty('moduleTemplate');
        $property->setAccessible(true);

        /** @var ModuleTemplate $moduleTemplate */
        $moduleTemplate = $property->getValue($controller);

        return $moduleTemplate;
    }
}