TYPO3  7.6
Public Member Functions | Protected Attributes | List of all members
PageViewHelper Class Reference
Inheritance diagram for PageViewHelper:
AbstractTagBasedViewHelper AbstractViewHelper

Public Member Functions

 initializeArguments ()
 
 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 AbstractTagBasedViewHelper
 __construct ()
 
 initialize ()
 
- Public Member Functions inherited from 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 ()
 

Protected Attributes

 $tagName = 'a'
 
- Protected Attributes inherited from AbstractTagBasedViewHelper
 $tag = null
 
 $tagName = 'div'
 
- Protected Attributes inherited from AbstractViewHelper
 $arguments
 
 $templateVariableContainer
 
 $controllerContext
 
 $renderingContext
 
 $renderChildrenClosure = null
 
 $viewHelperVariableContainer
 
 $objectManager
 
 $escapingInterceptorEnabled = true
 

Additional Inherited Members

- Static Public Member Functions inherited from AbstractViewHelper
static renderStatic (array $arguments,\Closure $renderChildrenClosure,\TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
 
- Protected Member Functions inherited from AbstractTagBasedViewHelper
 registerTagAttribute ($name, $type, $description, $required=false, $default=null)
 
 registerUniversalTagAttributes ()
 

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 Link/PageViewHelper.php.

Member Function Documentation

initializeArguments ( )
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
int | NULL$pageUidtarget page. See TypoLink destination
array$additionalParamsquery parameters to be attached to the resulting URI
int$pageTypetype of the target page. See typolink.parameter
bool$noCacheset this to disable caching for the target page. You should not need this.
bool$noCacheHashset this to suppress the cHash query parameter created by TypoLink. You should not need this.
string$sectionthe anchor to be added to the URI
bool$linkAccessRestrictedPagesIf set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed.
bool$absoluteIf set, the URI of the rendered link is absolute
bool$addQueryStringIf set, the current query parameters will be kept in the URI
array$argumentsToBeExcludedFromQueryStringarguments to be removed from the URI. Only active if $addQueryString = TRUE
string$addQueryStringMethodSet which parameters will be kept. Only active if $addQueryString = TRUE
Returns
string Rendered page URI

Definition at line 78 of file Link/PageViewHelper.php.

References AbstractViewHelper\renderChildren().

Member Data Documentation

$tagName = 'a'
protected

Definition at line 50 of file Link/PageViewHelper.php.