ListViewHelper.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\FluidStyledContent\ViewHelpers\Menu;

/*
 * 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\Fluid\Core\ViewHelper\AbstractViewHelper;

class ListViewHelper extends AbstractViewHelper
{
    use MenuViewHelperTrait;

    public function initializeArguments()
    {
        $this->registerArgument('as', 'string', 'Name of template variable which will contain selected pages', true);
        $this->registerArgument('levelAs', 'string', 'Name of template variable which will contain current level', false, null);
        $this->registerArgument('pageUids', 'array', 'Page UIDs of parent pages', false, []);
        $this->registerArgument('entryLevel', 'integer', 'The entry level', false, null);
        $this->registerArgument('maximumLevel', 'integer', 'Maximum level for rendering of nested menus', false, 10);
        $this->registerArgument('includeNotInMenu', 'boolean', 'Include pages that are marked "hide in menu"?', false, false);
        $this->registerArgument('includeMenuSeparator', 'boolean', 'Include pages of the type "Menu separator"?', false, false);
    }

    public function render()
    {
        $typoScriptFrontendController = $this->getTypoScriptFrontendController();
        $as = $this->arguments['as'];
        $pageUids = (array)$this->arguments['pageUids'];
        $entryLevel = $this->arguments['entryLevel'];
        $levelAs = $this->arguments['levelAs'];
        $maximumLevel = $this->arguments['maximumLevel'];
        $includeNotInMenu = (bool)$this->arguments['includeNotInMenu'];
        $includeMenuSeparator = (bool)$this->arguments['includeMenuSeparator'];

        $pageUids = $this->getPageUids($pageUids, $entryLevel);
        if (empty($pageUids)) {
            return '';
        }

        $pages = $typoScriptFrontendController->sys_page->getMenuForPages(
            $pageUids,
            '*',
            '',
            $this->getPageConstraints($includeNotInMenu, $includeMenuSeparator)
        );

        $tempPagesForSort = [];
        foreach ($pageUids as $pageUid) {
            if ($pages[$pageUid]) {
                $tempPagesForSort[$pageUid] = $pages[$pageUid];
            }
        }
        $pages = $tempPagesForSort;

        $output = '';

        if (!empty($pages)) {
            if (!$typoScriptFrontendController->register['ceMenuLevel_list']) {
                $typoScriptFrontendController->register['ceMenuLevel_list'] = 1;
                $typoScriptFrontendController->register['ceMenuMaximumLevel_list'] = $maximumLevel;
            } else {
                $typoScriptFrontendController->register['ceMenuLevel_list']++;
            }

            if ($typoScriptFrontendController->register['ceMenuLevel_list'] > $typoScriptFrontendController->register['ceMenuMaximumLevel_list']) {
                return '';
            }

            $variables = [
                $as => $pages
            ];
            if (!empty($levelAs)) {
                $variables[$levelAs] = $typoScriptFrontendController->register['ceMenuLevel_list'];
            }
            $output = $this->renderChildrenWithVariables($variables);

            $typoScriptFrontendController->register['ceMenuLevel_list']--;

            if ($typoScriptFrontendController->register['ceMenuLevel_list'] === 0) {
                unset($typoScriptFrontendController->register['ceMenuLevel_list']);
                unset($typoScriptFrontendController->register['ceMenuMaximumLevel_list']);
            }
        }

        return $output;
    }
}