95e3a82d69a719a1a896fcb7c3bd9871d2538fd2
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / Uri / ActionViewHelper.php
1 <?php
2 namespace TYPO3\CMS\Fluid\ViewHelpers\Uri;
3
4 /* *
5 * This script is part of the TYPO3 project - inspiring people to share! *
6 * *
7 * TYPO3 is free software; you can redistribute it and/or modify it under *
8 * the terms of the GNU General Public License version 2 as published by *
9 * the Free Software Foundation. *
10 * *
11 * This script is distributed in the hope that it will be useful, but *
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN- *
13 * TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General *
14 * Public License for more details. *
15 * */
16 /**
17 * A view helper for creating URIs to extbase actions.
18 *
19 * = Examples =
20 *
21 * <code title="URI to the show-action of the current controller">
22 * <f:uri.action action="show" />
23 * </code>
24 * <output>
25 * index.php?id=123&tx_myextension_plugin[action]=show&tx_myextension_plugin[controller]=Standard&cHash=xyz
26 * (depending on the current page and your TS configuration)
27 * </output>
28 */
29 class ActionViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
30 {
31 /**
32 * @param string $action Target action
33 * @param array $arguments Arguments
34 * @param string $controller Target controller. If NULL current controllerName is used
35 * @param string $extensionName Target Extension Name (without "tx_" prefix and no underscores). If NULL the current extension name is used
36 * @param string $pluginName Target plugin. If empty, the current plugin name is used
37 * @param int $pageUid target page. See TypoLink destination
38 * @param int $pageType type of the target page. See typolink.parameter
39 * @param bool $noCache set this to disable caching for the target page. You should not need this.
40 * @param bool $noCacheHash set this to suppress the cHash query parameter created by TypoLink. You should not need this.
41 * @param string $section the anchor to be added to the URI
42 * @param string $format The requested format, e.g. ".html
43 * @param bool $linkAccessRestrictedPages If set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed.
44 * @param array $additionalParams additional query parameters that won't be prefixed like $arguments (overrule $arguments)
45 * @param bool $absolute If set, an absolute URI is rendered
46 * @param bool $addQueryString If set, the current query parameters will be kept in the URI
47 * @param array $argumentsToBeExcludedFromQueryString arguments to be removed from the URI. Only active if $addQueryString = TRUE
48 * @param string $addQueryStringMethod Set which parameters will be kept. Only active if $addQueryString = TRUE
49 * @return string Rendered link
50 */
51 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)
52 {
53 $uriBuilder = $this->controllerContext->getUriBuilder();
54 $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);
55 return $uri;
56 }
57 }