PaginateViewHelper Class Reference

Inheritance diagram for PaginateViewHelper:

Public Member Functions
	render (\TYPO3\CMS\Extbase\Persistence\QueryResultInterface $objects, $as, array $configuration=array('itemsPerPage'=> 10, 'insertAbove'=> false, 'insertBelow'=> true, 'recordsLabel'=> ''))
Public Member Functions inherited from AbstractWidgetViewHelper
	injectAjaxWidgetContextHolder (\TYPO3\CMS\Fluid\Core\Widget\AjaxWidgetContextHolder $ajaxWidgetContextHolder)
	injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
	initializeArgumentsAndRender ()
	setChildNodes (array $childNodes)
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
	$controller
Protected Attributes inherited from AbstractWidgetViewHelper
	$controller
	$ajaxWidget = false
	$objectManager
	$extensionService
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 AbstractWidgetViewHelper
	getWidgetConfiguration ()
	initiateSubRequest ()

Detailed Description

This ViewHelper renders a Pagination of objects for the TYPO3 Backend.

= Examples =

<f:be.widget.paginate objects="{blogs}" as="paginatedBlogs"> use {paginatedBlogs} as you used {blogs} before, most certainly inside a <f:for> loop. </f:be.widget.paginate>

<f:be.widget.paginate objects="{blogs}" as="paginatedBlogs" configuration="{itemsPerPage: 5, insertAbove: 1, insertBelow: 0, recordsLabel: 'MyRecords'}"> use {paginatedBlogs} as you used {blogs} before, most certainly inside a <f:for> loop. </f:be.widget.paginate> The recordsLabel can be used to replace the text in "Records 1 - 99" with a label of your own choice

= Performance characteristics =

In the above examples, it looks like {blogs} contains all Blog objects, thus you might wonder if all objects were fetched from the database. However, the blogs are NOT fetched from the database until you actually use them, so the paginate ViewHelper will adjust the query sent to the database and receive only the small subset of objects. So, there is no negative performance overhead in using the Be Paginate Widget.

Definition at line 52 of file Be/Widget/PaginateViewHelper.php.

Member Function Documentation

render	(	\TYPO3\CMS\Extbase\Persistence\QueryResultInterface	$objects,
			$as,
		array	$configuration = array('itemsPerPage' => 10, 'insertAbove' => false, 'insertBelow' => true, 'recordsLabel' => '')
	)

Parameters

\TYPO3\CMS\Extbase\Persistence\QueryResultInterface	$objects
string	$as
array	$configuration

Returns

string

Definition at line 66 of file Be/Widget/PaginateViewHelper.php.

References AbstractWidgetViewHelper\initiateSubRequest().

Member Data Documentation

$controller

protected

Definition at line 58 of file Be/Widget/PaginateViewHelper.php.