TYPO3  7.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PaginateController Class Reference
Inheritance diagram for PaginateController:
AbstractWidgetController ActionController SingletonInterface AbstractController ControllerInterface

Public Member Functions

 initializeAction ()
 
 indexAction ($currentPage=1)
 
- Public Member Functions inherited from AbstractWidgetController
 processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request,\TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
 
- Public Member Functions inherited from 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 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 AbstractWidgetController
 setViewConfiguration (\TYPO3\CMS\Extbase\Mvc\View\ViewInterface $view)
 
- Protected Member Functions inherited from 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 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 AbstractWidgetController
 $supportedRequestTypes = array(\TYPO3\CMS\Fluid\Core\Widget\WidgetRequest::class)
 
 $widgetConfiguration
 
- Protected Attributes inherited from ActionController
 $reflectionService
 
 $cacheService
 
 $view = null
 
 $namespacesViewObjectNamePattern = '@vendor\@extension\View\@controller\@action@format'
 
 $viewFormatToObjectNameMap = array()
 
 $defaultViewObjectName = \TYPO3\CMS\Fluid\View\TemplateView::class
 
 $actionMethodName = 'indexAction'
 
 $errorMethodName = 'errorAction'
 
 $mvcPropertyMappingConfigurationService
 
 $request
 
 $response
 
- Protected Attributes inherited from AbstractController
 $signalSlotDispatcher
 
 $objectManager
 
 $uriBuilder
 
 $extensionName
 
 $settings
 
 $request
 
 $response
 
 $validatorResolver
 
 $arguments
 
 $supportedRequestTypes = array(\TYPO3\CMS\Extbase\Mvc\Request::class)
 
 $controllerContext
 
 $configurationManager
 

Additional Inherited Members

- Static Public Member Functions inherited from ActionController
static getActionMethodParameters ($objectManager)
 

Detailed Description

Class PaginateController

Definition at line 31 of file Widget/Controller/PaginateController.php.

Member Function Documentation

buildPagination ( )
protected

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

Returns
array

Definition at line 147 of file Widget/Controller/PaginateController.php.

References PaginateController\$displayRangeEnd, and PaginateController\calculateDisplayRange().

Referenced by PaginateController\indexAction().

calculateDisplayRange ( )
protected

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

Returns
void

Definition at line 122 of file Widget/Controller/PaginateController.php.

References PaginateController\$maximumNumberOfLinks, and PaginateController\$numberOfPages.

Referenced by PaginateController\buildPagination().

indexAction (   $currentPage = 1)
initializeAction ( )
Returns
void

Definition at line 78 of file Widget/Controller/PaginateController.php.

References ArrayUtility\mergeRecursiveWithOverrule().

prepareObjectsSlice (   $itemsPerPage,
  $offset 
)
protected
Parameters
int$itemsPerPage
int$offset
Returns
array|QueryResultInterface
Exceptions
\InvalidArgumentException

Definition at line 179 of file Widget/Controller/PaginateController.php.

References elseif.

Referenced by PaginateController\indexAction().

Member Data Documentation

$configuration
protected
Initial value:
= array(
'itemsPerPage' => 10,
'insertAbove' => false,
'insertBelow' => true,
'maximumNumberOfLinks' => 99,
'addQueryStringMethod' => '',
'section' => ''
)

Definition at line 36 of file Widget/Controller/PaginateController.php.

$currentPage = 1
protected
$displayRangeEnd = null
protected
$displayRangeStart = null
protected

Definition at line 68 of file Widget/Controller/PaginateController.php.

$maximumNumberOfLinks = 99
protected
$numberOfPages = 1
protected
$objects
protected

Definition at line 48 of file Widget/Controller/PaginateController.php.