CuyZ/NotiZ

<?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\Domain\Definition\Builder\Component;

use CuyZ\Notiz\Core\Definition\Builder\Component\DefinitionComponents;
use CuyZ\Notiz\Core\Definition\Builder\Component\Source\DefinitionSource;
use CuyZ\Notiz\Core\Support\NotizConstants;
use CuyZ\Notiz\Domain\Definition\Builder\Component\Source\TypoScriptDefinitionSource;
use CuyZ\Notiz\Service\ExtensionConfigurationService;
use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

/**
 * Service used for registration of default definition components supplied by
 * the extension.
 */
class DefaultDefinitionComponents implements SingletonInterface
{
    const DEFAULT_DEFINITION_FILE_PRIORITY = 1337;

    /**
     * @var bool
     */
    protected $registrationDone = false;

    /**
     * @var ExtensionConfigurationService
     */
    protected $extensionConfigurationService;

    /**
     * @param ExtensionConfigurationService $extensionConfigurationService
     */
    public function __construct(ExtensionConfigurationService $extensionConfigurationService)
    {
        $this->extensionConfigurationService = $extensionConfigurationService;
    }

    /**
     * Default definition comes from TypoScript files, so a definition source
     * must be added to the definition builder and the files must be registered.
     *
     * @param DefinitionComponents $components
     */
    public function register(DefinitionComponents $components)
    {
        if ($this->registrationDone) {
            return;
        }

        $this->registrationDone = true;

        /** @var TypoScriptDefinitionSource $typoScriptDefinitionSource */
        $typoScriptDefinitionSource = $components->addSource(DefinitionSource::SOURCE_TYPOSCRIPT);

        foreach ($this->getDefaultFiles() as $file) {
            $typoScriptDefinitionSource->addFilePath($file, self::DEFAULT_DEFINITION_FILE_PRIORITY);
        }
    }

    /**
     * @return array
     */
    private function getDefaultFiles(): array
    {
        $defaultFiles = [
            NotizConstants::TYPOSCRIPT_PATH . 'Channel/Channels.Default.typoscript',
            NotizConstants::TYPOSCRIPT_PATH . 'Notification/Notifications.typoscript',
        ];

        // TYPO3 events can be enabled/disabled in the extension configuration.
        if ($this->extensionConfigurationService->getConfigurationValue('events.typo3')) {
            $defaultFiles[] = NotizConstants::TYPOSCRIPT_PATH . 'Event/Events.TYPO3.typoscript';

            if (ExtensionManagementUtility::isLoaded('scheduler')) {
                $defaultFiles[] = NotizConstants::TYPOSCRIPT_PATH . 'Event/Events.Scheduler.typoscript';
            }
        }

        // The core extension "form" can dispatch events.
        if (ExtensionManagementUtility::isLoaded('form')) {
            $defaultFiles[] = NotizConstants::TYPOSCRIPT_PATH . 'Event/Events.Form.typoscript';
        }

        if (ExtensionManagementUtility::isLoaded('blog')
            && version_compare(ExtensionManagementUtility::getExtensionVersion('blog'), '9.0.0', '>')
        ) {
            $defaultFiles[] = NotizConstants::TYPOSCRIPT_PATH . 'Event/Events.Blog.typoscript';
        }

        return $defaultFiles;
    }
}