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

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

Public Member Functions
	initializeArguments ()
	render ($pageUid=null, array $additionalParams=[], $pageType=0, $noCache=false, $noCacheHash=false, $section='', $linkAccessRestrictedPages=false, $absolute=false, $addQueryString=false, array $argumentsToBeExcludedFromQueryString=[], $addQueryStringMethod=null)
Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper
	__construct ()
	initialize ()
Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	setArguments (array $arguments)
	setRenderingContext (\TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
	injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
	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 ()

Protected Attributes
	$tagName = 'a'
Protected Attributes inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper
	$tag = null
	$tagName = 'div'
Protected Attributes inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	$arguments
	$templateVariableContainer
	$controllerContext
	$renderingContext
	$renderChildrenClosure = null
	$viewHelperVariableContainer
	$objectManager
	$escapingInterceptorEnabled = true

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\AbstractTagBasedViewHelper
	registerTagAttribute ($name, $type, $description, $required=false, $default=null)
	registerUniversalTagAttributes ()
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 ()
	getLogger ()
	buildRenderChildrenClosure ()
	hasArgument ($argumentName)

Detailed Description

A view helper for creating links to TYPO3 pages.

= Examples =

<f:link.page>page link</f:link.page> <output> page link</f:link.action> (depending on the current page and your TS configuration) <f:link.page pageUid="1" additionalParams="{foo: 'bar'}">page link</f:link.page> page link</f:link.action> (depending on your TS configuration) <f:link.page pageUid="1" additionalParams="{extension_key: {foo: 'bar'}}">page link</f:link.page> page link</f:link.action> (depending on your TS configuration)

Definition at line 45 of file PageViewHelper.php.

Member Function Documentation

initializeArguments()

TYPO3\CMS\Fluid\ViewHelpers\Link\PageViewHelper::initializeArguments

(

)

Arguments initialization

Returns

void

Definition at line 57 of file PageViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper\registerTagAttribute(), and TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper\registerUniversalTagAttributes().

render()

TYPO3\CMS\Fluid\ViewHelpers\Link\PageViewHelper::render	(		$pageUid = null,
		array	$additionalParams = [],
			$pageType = 0,
			$noCache = false,
			$noCacheHash = false,
			$section = '',
			$linkAccessRestrictedPages = false,
			$absolute = false,
			$addQueryString = false,
		array	$argumentsToBeExcludedFromQueryString = [],
			$addQueryStringMethod = null
	)

Parameters

int | NULL	$pageUid	target page. See TypoLink destination
array	$additionalParams	query parameters to be attached to the resulting URI
int	$pageType	type of the target page. See typolink.parameter
bool	$noCache	set this to disable caching for the target page. You should not need this.
bool	$noCacheHash	set this to suppress the cHash query parameter created by TypoLink. You should not need this.
string	$section	the anchor to be added to the URI
bool	$linkAccessRestrictedPages	If set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed.
bool	$absolute	If set, the URI of the rendered link is absolute
bool	$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 78 of file PageViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\renderChildren().

Member Data Documentation

$tagName

TYPO3\CMS\Fluid\ViewHelpers\Link\PageViewHelper::$tagName = 'a'

protected

Definition at line 50 of file PageViewHelper.php.