9.5/_language_menu_processor_8php_source.html

<?php

declare(strict_types = 1);


namespace ‪TYPO3\CMS\Frontend\DataProcessing;


/*

 * This file is part of the TYPO3 CMS project.

 *

 * It is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License, either version 2

 * of the License, or any later version.

 *

 * For the full copyright and license information, please read the

 * LICENSE.txt file that was distributed with this source code.

 *

 * The TYPO3 project - inspiring people to share!

 */


use ‪TYPO3\CMS\Core\Routing\SiteMatcher;

use ‪TYPO3\CMS\Core\Site\Entity\SiteInterface;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use ‪TYPO3\CMS\Frontend\ContentObject\ContentDataProcessor;

use ‪TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;

use ‪TYPO3\CMS\Frontend\ContentObject\DataProcessorInterface;

use ‪TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;

use ‪TYPO3\CMS\Frontend\Utility\CanonicalizationUtility;


class ‪LanguageMenuProcessor implements ‪DataProcessorInterface

{

    protected const ‪LINK_PLACEHOLDER = '###LINKPLACEHOLDER###';


    public ‪$cObj;


    protected ‪$processorConfiguration;


    protected ‪$allowedConfigurationKeys = [

        'if',

        'if.',

        'languages',

        'languages.',

        'as',

        'addQueryString',

        'addQueryString.'

    ];


    protected ‪$removeConfigurationKeysForHmenu = [

        'languages',

        'languages.',

        'as'

    ];


    protected ‪$menuConfig = [

        'special' => 'language',

        'addQueryString' => 1,

        'addQueryString.' => [

            'method' => 'GET'

        ],

        'wrap' => '[|]'

    ];


    protected ‪$menuLevelConfig = [

        'doNotLinkIt' => '1',

        'wrapItemAndSub' => '{|}, |*| {|}, |*| {|}',

        'stdWrap.' => [

            'cObject' => 'COA',

            'cObject.' => [

                '1' => 'LOAD_REGISTER',

                '1.' => [

                    'languageId.' => [

                        'cObject' => 'TEXT',

                        'cObject.' => [

                            'value.' => [

                                'data' => 'register:languages_HMENU'

                            ],

                            'listNum.' => [

                                'stdWrap.' => [

                                    'data' => 'register:count_HMENU_MENUOBJ',

                                    'wrap' => '|-1'

                                ],

                                'splitChar' => ','

                            ]

                        ]

                    ]

                ],

                '10' => 'TEXT',

                '10.' => [

                    'stdWrap.' => [

                        'data' => 'register:languageId'

                    ],

                    'wrap' => '"languageId":|'

                ],

                '11' => 'USER',

                '11.' => [

                    'userFunc' => 'TYPO3\CMS\Frontend\DataProcessing\LanguageMenuProcessor->getFieldAsJson',

                    'language.' => [

                        'data' => 'register:languageId'

                    ],

                    'field' => 'locale',

                    'stdWrap.' => [

                        'wrap' => ',"locale":|'

                    ]

                ],

                '20' => 'USER',

                '20.' => [

                    'userFunc' => 'TYPO3\CMS\Frontend\DataProcessing\LanguageMenuProcessor->getFieldAsJson',

                    'language.' => [

                        'data' => 'register:languageId'

                    ],

                    'field' => 'title',

                    'stdWrap.' => [

                        'wrap' => ',"title":|'

                    ]

                ],

                '21' => 'USER',

                '21.' => [

                    'userFunc' => 'TYPO3\CMS\Frontend\DataProcessing\LanguageMenuProcessor->getFieldAsJson',

                    'language.' => [

                        'data' => 'register:languageId'

                    ],

                    'field' => 'navigationTitle',

                    'stdWrap.' => [

                        'wrap' => ',"navigationTitle":|'

                    ]

                ],

                '22' => 'USER',

                '22.' => [

                    'userFunc' => 'TYPO3\CMS\Frontend\DataProcessing\LanguageMenuProcessor->getFieldAsJson',

                    'language.' => [

                        'data' => 'register:languageId'

                    ],

                    'field' => 'twoLetterIsoCode',

                    'stdWrap.' => [

                        'wrap' => ',"twoLetterIsoCode":|'

                    ]

                ],

                '23' => 'USER',

                '23.' => [

                    'userFunc' => 'TYPO3\CMS\Frontend\DataProcessing\LanguageMenuProcessor->getFieldAsJson',

                    'language.' => [

                        'data' => 'register:languageId'

                    ],

                    'field' => 'hreflang',

                    'stdWrap.' => [

                        'wrap' => ',"hreflang":|'

                    ]

                ],

                '24' => 'USER',

                '24.' => [

                    'userFunc' => 'TYPO3\CMS\Frontend\DataProcessing\LanguageMenuProcessor->getFieldAsJson',

                    'language.' => [

                        'data' => 'register:languageId'

                    ],

                    'field' => 'direction',

                    'stdWrap.' => [

                        'wrap' => ',"direction":|'

                    ]

                ],

                '90' => 'TEXT',

                '90.' => [

                    'value' => ‪self::LINK_PLACEHOLDER,

                    'wrap' => ',"link":|',

                ],

                '91' => 'TEXT',

                '91.' => [

                    'value' => '0',

                    'wrap' => ',"active":|'

                ],

                '92' => 'TEXT',

                '92.' => [

                    'value' => '0',

                    'wrap' => ',"current":|'

                ],

                '93' => 'TEXT',

                '93.' => [

                    'value' => '1',

                    'wrap' => ',"available":|'

                ],

                '99' => 'RESTORE_REGISTER'

            ]

        ]

    ];


    protected ‪$menuDefaults = [

        'as' => 'languagemenu'

    ];


    protected ‪$menuTargetVariableName;


    protected ‪$contentDataProcessor;


    public function ‪__construct()

    {

        $this->contentDataProcessor = GeneralUtility::makeInstance(ContentDataProcessor::class);

    }


    protected function ‪getConfigurationValue(string $key): string

    {

        return $this->cObj->stdWrapValue($key, $this->processorConfiguration, $this->menuDefaults[$key]);

    }


    protected function ‪getTypoScriptFrontendController(): TypoScriptFrontendController

    {

        return ‪$GLOBALS['TSFE'];

    }


    protected function ‪getCurrentSite(): ‪SiteInterface

    {

        $matcher = GeneralUtility::makeInstance(SiteMatcher::class);

        return $matcher->matchByPageId((int)$this->‪getTypoScriptFrontendController()->id);

    }


    protected function ‪jsonEncode($value): string

    {

        return json_encode($value, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP | JSON_UNESCAPED_UNICODE);

    }


    protected function ‪validateConfiguration()

    {

        $invalidArguments = [];

        foreach ($this->processorConfiguration as $key => $value) {

            if (!in_array($key, $this->allowedConfigurationKeys)) {

                $invalidArguments[str_replace('.', '', $key)] = $key;

            }

        }

        if (!empty($invalidArguments)) {

            throw new \InvalidArgumentException('LanguageMenuProcessor configuration contains invalid arguments: ' . implode(', ', $invalidArguments), 1522959188);

        }

    }


    protected function ‪prepareConfiguration(): void

    {

        $this->menuConfig = array_merge($this->menuConfig, $this->processorConfiguration);


        // Process languages

        if (empty($this->menuConfig['languages']) && empty($this->menuConfig['languages.'])) {

            $this->menuConfig['special.']['value'] = 'auto';

        } elseif (!empty($this->menuConfig['languages.'])) {

            $this->menuConfig['special.']['value'] = $this->cObj->stdWrap($this->menuConfig['languages'], $this->menuConfig['languages.']);

        } else {

            $this->menuConfig['special.']['value'] = $this->menuConfig['languages'];

        }


        // Filter configuration

        foreach ($this->menuConfig as $key => $value) {

            if (in_array($key, $this->removeConfigurationKeysForHmenu, true)) {

                unset($this->menuConfig[$key]);

            }

        }


        $paramsToExclude = ‪CanonicalizationUtility::getParamsToExcludeForCanonicalizedUrl(

            (int)$this->‪getTypoScriptFrontendController()->id,

            (array)‪$GLOBALS['TYPO3_CONF_VARS']['FE']['additionalCanonicalizedUrlParameters']

        );


        $this->menuConfig['addQueryString.']['exclude'] = implode(

            ',',

            array_merge(

                GeneralUtility::trimExplode(',', $this->menuConfig['addQueryString.']['exclude'] ?? '', true),

                $paramsToExclude

            )

        );

    }


    protected function ‪buildConfiguration(): void

    {

        $this->menuConfig['1'] = 'TMENU';

        $this->menuConfig['1.']['IProcFunc'] = LanguageMenuProcessor::class . '->replacePlaceholderInRenderedMenuItem';

        $this->menuConfig['1.']['NO'] = '1';

        $this->menuConfig['1.']['NO.'] = ‪$this->menuLevelConfig;

        $this->menuConfig['1.']['ACT'] = $this->menuConfig['1.']['NO'];

        $this->menuConfig['1.']['ACT.'] = $this->menuConfig['1.']['NO.'];

        $this->menuConfig['1.']['ACT.']['stdWrap.']['cObject.']['91.']['value'] = '1';

        $this->menuConfig['1.']['CUR'] = $this->menuConfig['1.']['ACT'];

        $this->menuConfig['1.']['CUR.'] = $this->menuConfig['1.']['ACT.'];

        $this->menuConfig['1.']['CUR.']['stdWrap.']['cObject.']['92.']['value'] = '1';

        $this->menuConfig['1.']['USERDEF1'] = $this->menuConfig['1.']['NO'];

        $this->menuConfig['1.']['USERDEF1.'] = $this->menuConfig['1.']['NO.'];

        $this->menuConfig['1.']['USERDEF1.']['stdWrap.']['cObject.']['93.']['value'] = '0';

        $this->menuConfig['1.']['USERDEF2'] = $this->menuConfig['1.']['ACT'];

        $this->menuConfig['1.']['USERDEF2.'] = $this->menuConfig['1.']['ACT.'];

        $this->menuConfig['1.']['USERDEF2.']['stdWrap.']['cObject.']['93.']['value'] = '0';

    }


    protected function ‪validateAndBuildConfiguration(): void

    {

        // Validate Configuration

        $this->‪validateConfiguration();


        // Build Configuration

        $this->‪prepareConfiguration();

        $this->‪buildConfiguration();

    }


    public function ‪process(‪ContentObjectRenderer ‪$cObj, array $contentObjectConfiguration, array ‪$processorConfiguration, array $processedData): array

    {

        $this->cObj = ‪$cObj;

        $this->processorConfiguration = ‪$processorConfiguration;


        // Get Configuration

        $this->menuTargetVariableName = $this->‪getConfigurationValue('as');


        // Validate and Build Configuration

        $this->‪validateAndBuildConfiguration();


        // Process Configuration

        $menuContentObject = ‪$cObj->‪getContentObject('HMENU');

        $renderedMenu = $menuContentObject->‪render($this->menuConfig);

        if ($renderedMenu) {

            // Process menu

            $menu = json_decode($renderedMenu, true);

            $processedMenu = [];


            foreach ($menu as $key => $language) {

                $processedMenu[$key] = $language;

            }


            $processedData[‪$this->menuTargetVariableName] = $processedMenu;

        }


        return $processedData;

    }


    public function ‪replacePlaceholderInRenderedMenuItem(array $menuItem): array

    {

        $link = $this->‪jsonEncode($menuItem['linkHREF']['HREF']);


        $menuItem['parts']['title'] = str_replace(self::LINK_PLACEHOLDER, $link, $menuItem['parts']['title']);


        return $menuItem;

    }


    public function ‪getFieldAsJson(string $content, array $conf): string

    {

        // Support of stdWrap for parameters

        if (isset($conf['language.'])) {

            $conf['language'] = $this->cObj->stdWrap($conf['language'], $conf['language.']);

            unset($conf['language.']);

        }

        if (isset($conf['field.'])) {

            $conf['field'] = $this->cObj->stdWrap($conf['field'], $conf['field.']);

            unset($conf['field.']);

        }


        // Check required fields

        if ($conf['language'] === '') {

            throw new \InvalidArgumentException('Argument \'language\' must be supplied.', 1522959186);

        }

        if ($conf['field'] === '') {

            throw new \InvalidArgumentException('Argument \'field\' must be supplied.', 1522959187);

        }


        // Get and check current site

        $site = $this->‪getCurrentSite();


        // Throws InvalidArgumentException in case language is not found which is fine

        $language = $site->getLanguageById((int)$conf['language']);

        if ($language->enabled()) {

            $language = $language->toArray();

        } else {

            $language = null;

        }


        // Check field for return exists

        if ($language !== null && !isset($language[$conf['field']])) {

            throw new \InvalidArgumentException('Invalid value \'' . $conf['field'] . '\' for argument \'field\' supplied.', 1524063160);

        }


        return $this->‪jsonEncode($language[$conf['field']]);

    }

}