TYPO3\CMS\Fluid\ViewHelpers\Uri\PageViewHelper Class Reference

Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\Uri\PageViewHelper:

Public Member Functions
	render ($pageUid=NULL, array $additionalParams=array(), $pageType=0, $noCache=FALSE, $noCacheHash=FALSE, $section='', $linkAccessRestrictedPages=FALSE, $absolute=FALSE, $addQueryString=FALSE, array $argumentsToBeExcludedFromQueryString=array(), $addQueryStringMethod=NULL)
Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	setArguments (array $arguments)
	setRenderingContext (\TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
	injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
	isEscapingInterceptorEnabled ()
	setViewHelperNode (\TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\ViewHelperNode $node)
	setRenderChildrenClosure (\Closure $renderChildrenClosure)
	initializeArgumentsAndRender ()
	initialize ()
	renderChildren ()
	prepareArguments ()
	validateArguments ()
	initializeArguments ()
	compile ($argumentsVariableName, $renderChildrenClosureVariableName, &$initializationPhpCode, \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\AbstractNode $syntaxTreeNode, \TYPO3\CMS\Fluid\Core\Compiler\TemplateCompiler $templateCompiler)
	resetState ()

Additional Inherited Members
Static Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
static	renderStatic (array $arguments, \Closure $renderChildrenClosure, \TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
Protected Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	registerArgument ($name, $type, $description, $required=FALSE, $defaultValue=NULL)
	overrideArgument ($name, $type, $description, $required=FALSE, $defaultValue=NULL)
	callRenderMethod ()
	buildRenderChildrenClosure ()
	hasArgument ($argumentName)
Protected Attributes inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	$arguments
	$templateVariableContainer
	$controllerContext
	$renderingContext
	$renderChildrenClosure = NULL
	$viewHelperVariableContainer
	$objectManager
	$escapingInterceptorEnabled = TRUE

Detailed Description

A view helper for creating URIs to TYPO3 pages.

= Examples =

<f:uri.page>page link</f:uri.page> <output> index.php?id=123 (depending on the current page and your TS configuration) </output>

<f:uri.page pageUid="1" additionalParams="{foo: 'bar'}" /> <output> index.php?id=1&foo=bar (depending on your TS configuration) </output>

<f:uri.page pageUid="1" additionalParams="{extension_key: {foo: 'bar'}}" /> <output> index.php?id=1&extension_key[foo]=bar (depending on your TS configuration) </output>

Definition at line 45 of file PageViewHelper.php.

Member Function Documentation

render()

TYPO3\CMS\Fluid\ViewHelpers\Uri\PageViewHelper::render	(		$pageUid = NULL,
		array	$additionalParams = array(),
			$pageType = 0,
			$noCache = FALSE,
			$noCacheHash = FALSE,
			$section = '',
			$linkAccessRestrictedPages = FALSE,
			$absolute = FALSE,
			$addQueryString = FALSE,
		array	$argumentsToBeExcludedFromQueryString = array(),
			$addQueryStringMethod = NULL
	)

Parameters

integer | NULL	$pageUid	target PID
array	$additionalParams	query parameters to be attached to the resulting URI
integer	$pageType	type of the target page. See typolink.parameter
boolean	$noCache	set this to disable caching for the target page. You should not need this.
boolean	$noCacheHash	set this to supress the cHash query parameter created by TypoLink. You should not need this.
string	$section	the anchor to be added to the URI
boolean	$linkAccessRestrictedPages	If set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed.
boolean	$absolute	If set, the URI of the rendered link is absolute
boolean	$addQueryString	If set, the current query parameters will be kept in the URI
array	$argumentsToBeExcludedFromQueryString	arguments to be removed from the URI. Only active if $addQueryString = TRUE
string	$addQueryStringMethod	Set which parameters will be kept. Only active if $addQueryString = TRUE

Returns

string Rendered page URI

Definition at line 61 of file PageViewHelper.php.