9.5/_link_2_page_view_helper_8php_source.html

<?php

namespace ‪TYPO3\CMS\Fluid\ViewHelpers\Link;


/*

 * 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 TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;


class ‪PageViewHelper extends AbstractTagBasedViewHelper

{

    protected ‪$tagName = 'a';


    public function ‪initializeArguments()

    {

        parent::initializeArguments();

        $this->registerUniversalTagAttributes();

        $this->registerTagAttribute('target', 'string', 'Target of link', false);

        $this->registerTagAttribute('rel', 'string', 'Specifies the relationship between the current document and the linked document', false);

        $this->registerArgument('pageUid', 'int', 'Target page. See TypoLink destination');

        $this->registerArgument('pageType', 'int', 'Type of the target page. See typolink.parameter');

        $this->registerArgument('noCache', 'bool', 'Set this to disable caching for the target page. You should not need this.');

        $this->registerArgument('noCacheHash', 'bool', 'Set this to suppress the cHash query parameter created by TypoLink. You should not need this.');

        $this->registerArgument('section', 'string', 'The anchor to be added to the URI');

        $this->registerArgument('linkAccessRestrictedPages', 'bool', 'If set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed.');

        $this->registerArgument('additionalParams', 'array', 'Additional query parameters that won\'t be prefixed like $arguments (overrule $arguments)');

        $this->registerArgument('absolute', 'bool', 'If set, the URI of the rendered link is absolute');

        $this->registerArgument('addQueryString', 'bool', 'If set, the current query parameters will be kept in the URI');

        $this->registerArgument('argumentsToBeExcludedFromQueryString', 'array', 'Arguments to be removed from the URI. Only active if $addQueryString = TRUE');

        $this->registerArgument('addQueryStringMethod', 'string', 'Set which parameters will be kept. Only active if $addQueryString = TRUE');

    }


    public function ‪render()

    {

        $pageUid = isset($this->arguments['pageUid']) ? (int)$this->arguments['pageUid'] : null;

        $pageType = isset($this->arguments['pageType']) ? (int)$this->arguments['pageType'] : 0;

        $noCache = isset($this->arguments['noCache']) ? (bool)$this->arguments['noCache'] : false;

        $noCacheHash = isset($this->arguments['noCacheHash']) ? (bool)$this->arguments['noCacheHash'] : false;

        $section = isset($this->arguments['section']) ? (string)$this->arguments['section'] : '';

        $linkAccessRestrictedPages = isset($this->arguments['linkAccessRestrictedPages']) ? (bool)$this->arguments['linkAccessRestrictedPages'] : false;

        $additionalParams = isset($this->arguments['additionalParams']) ? (array)$this->arguments['additionalParams'] : [];

        $absolute = isset($this->arguments['absolute']) ? (bool)$this->arguments['absolute'] : false;

        $addQueryString = isset($this->arguments['addQueryString']) ? (bool)$this->arguments['addQueryString'] : false;

        $argumentsToBeExcludedFromQueryString = isset($this->arguments['argumentsToBeExcludedFromQueryString']) ? (array)$this->arguments['argumentsToBeExcludedFromQueryString'] : [];

        $addQueryStringMethod = $this->arguments['addQueryStringMethod'] ?? null;

        $uriBuilder = $this->renderingContext->getControllerContext()->getUriBuilder();

        $uri = $uriBuilder->reset()

            ->setTargetPageUid($pageUid)

            ->setTargetPageType($pageType)

            ->setNoCache($noCache)

            ->setUseCacheHash(!$noCacheHash)

            ->setSection($section)

            ->setLinkAccessRestrictedPages($linkAccessRestrictedPages)

            ->setArguments($additionalParams)

            ->setCreateAbsoluteUri($absolute)

            ->setAddQueryString($addQueryString)

            ->setArgumentsToBeExcludedFromQueryString($argumentsToBeExcludedFromQueryString)

            ->setAddQueryStringMethod($addQueryStringMethod)

            ->build();

        if ((string)$uri !== '') {

            $this->tag->addAttribute('href', $uri);

            $this->tag->setContent($this->renderChildren());

            $this->tag->forceClosingTag(true);

            $result = $this->tag->render();

        } else {

            $result = $this->renderChildren();

        }

        return $result;

    }

}