typo3/sysext/fluid/Classes/ViewHelpers/Link/ActionViewHelper.php

   1 <?php
   2 namespace TYPO3\CMS\Fluid\ViewHelpers\Link;
   3
   4 /*
   5  * This file is part of the TYPO3 CMS project.
   6  *
   7  * It is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU General Public License, either version 2
   9  * of the License, or any later version.
  10  *
  11  * For the full copyright and license information, please read the
  12  * LICENSE.txt file that was distributed with this source code.
  13  *
  14  * The TYPO3 project - inspiring people to share!
  15  */
  16
  17 /**
  18  * A view helper for creating links to extbase actions.
  19  *
  20  * = Examples =
  21  *
  22  * <code title="link to the show-action of the current controller">
  23  * <f:link.action action="show">action link</f:link.action>
  24  * </code>
  25  * <output>
  26  * <a href="index.php?id=123&tx_myextension_plugin[action]=show&tx_myextension_plugin[controller]=Standard&cHash=xyz">action link</f:link.action>
  27  * (depending on the current page and your TS configuration)
  28  * </output>
  29  */
  30 class ActionViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper {
  31
  32         /**
  33          * @var string
  34          */
  35         protected $tagName = 'a';
  36
  37         /**
  38          * Arguments initialization
  39          *
  40          * @return void
  41          */
  42         public function initializeArguments() {
  43                 $this->registerUniversalTagAttributes();
  44                 $this->registerTagAttribute('name', 'string', 'Specifies the name of an anchor');
  45                 $this->registerTagAttribute('rel', 'string', 'Specifies the relationship between the current document and the linked document');
  46                 $this->registerTagAttribute('rev', 'string', 'Specifies the relationship between the linked document and the current document');
  47                 $this->registerTagAttribute('target', 'string', 'Specifies where to open the linked document');
  48         }
  49
  50         /**
  51          * @param string $action Target action
  52          * @param array $arguments Arguments
  53          * @param string $controller Target controller. If NULL current controllerName is used
  54          * @param string $extensionName Target Extension Name (without "tx_" prefix and no underscores). If NULL the current extension name is used
  55          * @param string $pluginName Target plugin. If empty, the current plugin name is used
  56          * @param integer $pageUid target page. See TypoLink destination
  57          * @param integer $pageType type of the target page. See typolink.parameter
  58          * @param boolean $noCache set this to disable caching for the target page. You should not need this.
  59          * @param boolean $noCacheHash set this to supress the cHash query parameter created by TypoLink. You should not need this.
  60          * @param string $section the anchor to be added to the URI
  61          * @param string $format The requested format, e.g. ".html
  62          * @param boolean $linkAccessRestrictedPages If set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed.
  63          * @param array $additionalParams additional query parameters that won't be prefixed like $arguments (overrule $arguments)
  64          * @param boolean $absolute If set, the URI of the rendered link is absolute
  65          * @param boolean $addQueryString If set, the current query parameters will be kept in the URI
  66          * @param array $argumentsToBeExcludedFromQueryString arguments to be removed from the URI. Only active if $addQueryString = TRUE
  67          * @param string $addQueryStringMethod Set which parameters will be kept. Only active if $addQueryString = TRUE
  68          * @return string Rendered link
  69          */
  70         public function render($action = NULL, array $arguments = array(), $controller = NULL, $extensionName = NULL, $pluginName = NULL, $pageUid = NULL, $pageType = 0, $noCache = FALSE, $noCacheHash = FALSE, $section = '', $format = '', $linkAccessRestrictedPages = FALSE, array $additionalParams = array(), $absolute = FALSE, $addQueryString = FALSE, array $argumentsToBeExcludedFromQueryString = array(), $addQueryStringMethod = NULL) {
  71                 $uriBuilder = $this->controllerContext->getUriBuilder();
  72                 $uri = $uriBuilder->reset()->setTargetPageUid($pageUid)->setTargetPageType($pageType)->setNoCache($noCache)->setUseCacheHash(!$noCacheHash)->setSection($section)->setFormat($format)->setLinkAccessRestrictedPages($linkAccessRestrictedPages)->setArguments($additionalParams)->setCreateAbsoluteUri($absolute)->setAddQueryString($addQueryString)->setArgumentsToBeExcludedFromQueryString($argumentsToBeExcludedFromQueryString)->setAddQueryStringMethod($addQueryStringMethod)->uriFor($action, $arguments, $controller, $extensionName, $pluginName);
  73                 $this->tag->addAttribute('href', $uri);
  74                 $this->tag->setContent($this->renderChildren());
  75                 $this->tag->forceClosingTag(TRUE);
  76                 return $this->tag->render();
  77         }
  78 }