KeywordsViewHelper.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\Core\Database\DatabaseConnection;
use TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper;

class KeywordsViewHelper extends AbstractViewHelper
{
    use MenuViewHelperTrait;

    public function initializeArguments()
    {
        $this->registerArgument('as', 'string', 'Name of template variable which will contain selected pages', true);
        $this->registerArgument('entryLevel', 'integer', 'The entry level', false, 0);
        $this->registerArgument('pageUids', 'array', 'Page UIDs of pages to fetch the keywords from', false, []);
        $this->registerArgument('keywords', 'array', 'Keywords for which to search', false, []);
        $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);
        $this->registerArgument('excludeNoSearchPages', 'boolean', 'Exclude pages that are NOT marked "include in search"?', false, true);
    }

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

        // If no pages have been defined, use the current page
        if (empty($pageUids)) {
            $pageUids = [$typoScriptFrontendController->page['uid']];
        }

        // Transform the keywords list into an array
        if (!is_array($keywords)) {
            $unfilteredKeywords = $this->keywordsToArray($keywords);
        } else {
            $unfilteredKeywords = $keywords;
        }

        // Use the keywords of the page when none has been given
        if (empty($keywords)) {
            foreach ($pageUids as $pageUid) {
                $page = $typoScriptFrontendController->sys_page->getPage($pageUid);
                $unfilteredKeywords = array_merge(
                    $unfilteredKeywords,
                    $this->keywordsToArray($page['keywords'])
                );
            }
        }
        $filteredKeywords = array_unique($unfilteredKeywords);

        $constraints = $this->getPageConstraints($includeNotInMenu, $includeMenuSeparator);
        if ($excludeNoSearchPages) {
            $constraints .= ' AND no_search = 0';
        }

        $keywordConstraints = [];
        if ($filteredKeywords) {
            $db = $this->getDatabaseConnection();
            foreach ($filteredKeywords as $keyword) {
                $keyword = $db->fullQuoteStr('%' . $db->escapeStrForLike($keyword, 'pages') . '%', 'pages');
                $keywordConstraints[] = 'keywords LIKE ' . $keyword;
            }
            $constraints .= ' AND (' . implode(' OR ', $keywordConstraints) . ')';
        }

        // Start point
        if ($entryLevel < 0) {
            $entryLevel = count($typoScriptFrontendController->tmpl->rootLine) - 1 + $entryLevel;
        }
        $startUid = $typoScriptFrontendController->tmpl->rootLine[$entryLevel]['uid'];
        $treePageUids = explode(
            ',',
            $typoScriptFrontendController->cObj->getTreeList($startUid, 20)
        );

        $pages = $typoScriptFrontendController->sys_page->getMenuForPages(
            array_merge([$startUid], $treePageUids),
            '*',
            '',
            $constraints
        );
        return $this->renderChildrenWithVariables([
            $as => $pages
        ]);
    }

    protected function keywordsToArray($keywords)
    {
        $keywordList = preg_split('/[,;' . LF . ']/', $keywords);

        return array_filter(array_map('trim', $keywordList));
    }

    protected function getDatabaseConnection()
    {
        return $GLOBALS['TYPO3_DB'];
    }
}