[CLEANUP] Rework/simplify copyright header and remove @package
[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 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 URIs to extbase actions.
19 *
20 * = Examples =
21 *
22 * <code title="URI to the show-action of the current controller">
23 * <f:uri.action action="show" />
24 * </code>
25 * <output>
26 * index.php?id=123&tx_myextension_plugin[action]=show&tx_myextension_plugin[controller]=Standard&cHash=xyz
27 * (depending on the current page and your TS configuration)
28 * </output>
29 */
30 class ActionViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper {
31
32 /**
33 * @param string $action Target action
34 * @param array $arguments Arguments
35 * @param string $controller Target controller. If NULL current controllerName is used
36 * @param string $extensionName Target Extension Name (without "tx_" prefix and no underscores). If NULL the current extension name is used
37 * @param string $pluginName Target plugin. If empty, the current plugin name is used
38 * @param integer $pageUid target page. See TypoLink destination
39 * @param integer $pageType type of the target page. See typolink.parameter
40 * @param boolean $noCache set this to disable caching for the target page. You should not need this.
41 * @param boolean $noCacheHash set this to supress the cHash query parameter created by TypoLink. You should not need this.
42 * @param string $section the anchor to be added to the URI
43 * @param string $format The requested format, e.g. ".html
44 * @param boolean $linkAccessRestrictedPages If set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed.
45 * @param array $additionalParams additional query parameters that won't be prefixed like $arguments (overrule $arguments)
46 * @param boolean $absolute If set, an absolute URI is rendered
47 * @param boolean $addQueryString If set, the current query parameters will be kept in the URI
48 * @param array $argumentsToBeExcludedFromQueryString arguments to be removed from the URI. Only active if $addQueryString = TRUE
49 * @param string $addQueryStringMethod Set which parameters will be kept. Only active if $addQueryString = TRUE
50 * @return string Rendered link
51 */
52 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) {
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 }