HDNET\Autoloader\Hooks\BackendLayoutProvider

Complexity

Total Complexity

9

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	addBackendLayoutInformation()	0	4	1
A	addBackendLayouts()	0	6	2
A	getBackendLayout()	0	8	3
A	createBackendLayout()	0	10	2
A	getIdentifier()	0	4	1

<?php

/**
 * Add backend layouts.
 */
declare(strict_types = 1);

namespace HDNET\Autoloader\Hooks;

use HDNET\Autoloader\Annotation\Hook;
use TYPO3\CMS\Backend\View\BackendLayout\BackendLayout;
use TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection;
use TYPO3\CMS\Backend\View\BackendLayout\DataProviderContext;
use TYPO3\CMS\Backend\View\BackendLayout\DataProviderInterface;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Add backend layouts.
 *
 * @see  https://github.com/georgringer/TYPO3.base/blob/master/typo3conf/ext/theme/Classes/View/BackendLayout/FileProvider.php
 * @Hook("TYPO3_CONF_VARS|SC_OPTIONS|BackendLayoutDataProvider")
 */
class BackendLayoutProvider implements DataProviderInterface
{
    /**
     * Layout information.
     *
     * @var array
     */
    protected static $backendLayoutInformation = [];

    /**
     * Add one backend layout information.
     */
    public static function addBackendLayoutInformation(array $backendLayout): void
    {
        self::$backendLayoutInformation[] = $backendLayout;
    }

    /**
     * Adds backend layouts to the given backend layout collection.
     */
    public function addBackendLayouts(DataProviderContext $dataProviderContext, BackendLayoutCollection $backendLayoutCollection): void
    {
        foreach (self::$backendLayoutInformation as $info) {
            $backendLayoutCollection->add($this->createBackendLayout($info));
        }
    }

    /**
     * Gets a backend layout by (regular) identifier.
     *
     * @param string $identifier
     * @param int    $pageId
     *
     * @return BackendLayout|null
     */
    public function getBackendLayout($identifier, $pageId)
    {
        foreach (self::$backendLayoutInformation as $info) {
            if ($this->getIdentifier($info) === $identifier) {
                return $this->createBackendLayout($info);
            }
        }
    }

    /**
     * Create a backend layout with the given information.
     *
     * @param $info
     *
     * @return mixed
     */
    protected function createBackendLayout($info)
    {
        $fileName = GeneralUtility::getFileAbsFileName($info['path']);
        $backendLayout = BackendLayout::create($this->getIdentifier($info), $info['label'], GeneralUtility::getUrl($fileName));
        if ($info['icon']) {
            $backendLayout->setIconPath(str_replace(PATH_site, '', $info['icon']));
        }

        return $backendLayout;
    }

    /**
     * Get identifier.
     *
     * @param $info
     *
     * @return string
     */
    protected function getIdentifier($info)
    {
        return $info['extension'] . '/' . $info['filename'];
    }
}