TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController Class Reference

Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController:

Public Member Functions
	initializeAction ()
	indexAction ($currentPage=1)
Public Member Functions inherited from TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetController
	processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
	injectCacheService (\TYPO3\CMS\Extbase\Service\CacheService $cacheService)
	injectMvcPropertyMappingConfigurationService (\TYPO3\CMS\Extbase\Mvc\Controller\MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService)
	processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
	injectSignalSlotDispatcher (\TYPO3\CMS\Extbase\SignalSlot\Dispatcher $signalSlotDispatcher)
	injectValidatorResolver (\TYPO3\CMS\Extbase\Validation\ValidatorResolver $validatorResolver)
	getControllerContext ()
	__construct ()
	injectConfigurationManager (ConfigurationManagerInterface $configurationManager)
	injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
	addFlashMessage ($messageBody, $messageTitle='', $severity=\TYPO3\CMS\Core\Messaging\AbstractMessage::OK, $storeInSession=true)
	canProcessRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request)
	processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
	forward ($actionName, $controllerName=null, $extensionName=null, array $arguments=null)
	throwStatus ($statusCode, $statusMessage=null, $content=null)

Protected Member Functions
	calculateDisplayRange ()
	buildPagination ()
	prepareObjectsSlice ($itemsPerPage, $offset)
Protected Member Functions inherited from TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetController
	setViewConfiguration (\TYPO3\CMS\Extbase\Mvc\View\ViewInterface $view)
Protected Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	initializeActionMethodArguments ()
	resolveActionMethodName ()
	emitBeforeCallActionMethodSignal (array $preparedArguments)
	setViewConfiguration (ViewInterface $view)
	getViewProperty ($extbaseFrameworkConfiguration, $setting)
	resolveViewObjectName ()
	initializeView (ViewInterface $view)
	initializeAction ()
	errorAction ()
	clearCacheOnError ()
	addErrorFlashMessage ()
	getErrorFlashMessage ()
	forwardToReferringRequest ()
	getFlattenedValidationErrorMessage ()
Protected Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
	redirect ($actionName, $controllerName=null, $extensionName=null, array $arguments=null, $pageUid=null, $delay=0, $statusCode=303)
	redirectToUri ($uri, $delay=0, $statusCode=303)
	addBaseUriIfNecessary ($uri)

Protected Attributes
	$configuration
	$objects
	$currentPage = 1
	$maximumNumberOfLinks = 99
	$numberOfPages = 1
	$displayRangeStart = null
	$displayRangeEnd = null
Protected Attributes inherited from TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetController
	$supportedRequestTypes = [\TYPO3\CMS\Fluid\Core\Widget\WidgetRequest::class]
	$widgetConfiguration
Protected Attributes inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
	$reflectionService
	$cacheService
	$view = null
	$namespacesViewObjectNamePattern = '@vendor\@extension\View\@controller\@action@format'
	$viewFormatToObjectNameMap = []
	$defaultViewObjectName = \TYPO3\CMS\Fluid\View\TemplateView::class
	$actionMethodName = 'indexAction'
	$errorMethodName = 'errorAction'
	$mvcPropertyMappingConfigurationService
	$request
	$response
Protected Attributes inherited from TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
	$signalSlotDispatcher
	$objectManager
	$uriBuilder
	$extensionName
	$settings
	$request
	$response
	$validatorResolver
	$arguments
	$supportedRequestTypes = [\TYPO3\CMS\Extbase\Mvc\Request::class]
	$controllerContext
	$configurationManager

Additional Inherited Members
Static Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\Controller\ActionController
static	getActionMethodParameters ($objectManager)

Detailed Description

Class PaginateController

Definition at line 31 of file PaginateController.php.

Member Function Documentation

buildPagination()

TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController::buildPagination ( )

protected

Returns an array with the keys "pages", "current", "numberOfPages", "nextPage" & "previousPage"

Returns

array

Definition at line 148 of file PaginateController.php.

References TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\$currentPage, TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\$displayRangeEnd, TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\$displayRangeStart, TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\$numberOfPages, and TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\calculateDisplayRange().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\indexAction().

calculateDisplayRange()

TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController::calculateDisplayRange ( )

protected

If a certain number of links should be displayed, adjust before and after amounts accordingly.

Returns

void

Definition at line 123 of file PaginateController.php.

References TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\$maximumNumberOfLinks, and TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\$numberOfPages.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\buildPagination().

indexAction()

TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController::indexAction

(

$currentPage = 1

)

Parameters

int

$currentPage

Returns

void

Definition at line 91 of file PaginateController.php.

References TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\$currentPage, TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\buildPagination(), and TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\prepareObjectsSlice().

initializeAction()

TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController::initializeAction

(

)

Returns

void

Definition at line 78 of file PaginateController.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

prepareObjectsSlice()

TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController::prepareObjectsSlice (   $itemsPerPage,   $offset  )

protected

Parameters

int	$itemsPerPage
int	$offset

Returns

array|QueryResultInterface

Exceptions

Definition at line 180 of file PaginateController.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\indexAction().

Member Data Documentation

$configuration

TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController::$configuration

protected

Initial value:

= [
        'itemsPerPage' => 10

Definition at line 36 of file PaginateController.php.

$currentPage

TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController::$currentPage = 1

protected

Definition at line 53 of file PaginateController.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\buildPagination(), and TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\indexAction().

$displayRangeEnd

TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController::$displayRangeEnd = null

protected

Definition at line 73 of file PaginateController.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\buildPagination().

$displayRangeStart

TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController::$displayRangeStart = null

protected

Definition at line 68 of file PaginateController.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\buildPagination().

$maximumNumberOfLinks

TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController::$maximumNumberOfLinks = 99

protected

Definition at line 58 of file PaginateController.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\calculateDisplayRange().

$numberOfPages

TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController::$numberOfPages = 1

protected

Definition at line 63 of file PaginateController.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\buildPagination(), and TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController\calculateDisplayRange().

$objects

TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController::$objects

protected

Definition at line 48 of file PaginateController.php.