9.5/_widget_2_controller_2_paginate_controller_8php_source.html

<?php

namespace ‪TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller;


/*

 * This file is part of the TYPO3 CMS project.

 *

 * It is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License, either version 2

 * of the License, or any later version.

 *

 * For the full copyright and license information, please read the

 * LICENSE.txt file that was distributed with this source code.

 *

 * The TYPO3 project - inspiring people to share!

 */

use ‪TYPO3\CMS\Core\Utility\ArrayUtility;

use ‪TYPO3\CMS\Extbase\Persistence\ObjectStorage;

use ‪TYPO3\CMS\Extbase\Persistence\QueryResultInterface;

use ‪TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetController;


class ‪PaginateController extends ‪AbstractWidgetController

{

    protected ‪$configuration = [

        'itemsPerPage' => 10,

        'insertAbove' => false,

        'insertBelow' => true,

        'maximumNumberOfLinks' => 99,

        'addQueryStringMethod' => '',

        'section' => ''

    ];


    protected ‪$objects;


    protected ‪$currentPage = 1;


    protected ‪$maximumNumberOfLinks = 99;


    protected ‪$numberOfPages = 1;


    protected ‪$displayRangeStart;


    protected ‪$displayRangeEnd;


    public function ‪initializeAction()

    {

        $this->objects = $this->widgetConfiguration['objects'];

        ‪ArrayUtility::mergeRecursiveWithOverrule($this->configuration, $this->widgetConfiguration['configuration'], false);

        $itemsPerPage = (int)$this->configuration['itemsPerPage'];

        $this->numberOfPages = $itemsPerPage > 0 ? ceil(count($this->objects) / $itemsPerPage) : 0;

        $this->maximumNumberOfLinks = (int)$this->configuration['maximumNumberOfLinks'];

    }


    public function ‪indexAction(‪$currentPage = 1)

    {

        // set current page

        $this->currentPage = (int)‪$currentPage;

        if ($this->currentPage < 1) {

            $this->currentPage = 1;

        }

        if ($this->currentPage > $this->numberOfPages) {

            // set $modifiedObjects to NULL if the page does not exist

            $modifiedObjects = null;

        } else {

            // modify query

            $itemsPerPage = (int)$this->configuration['itemsPerPage'];

            $offset = 0;

            if ($this->objects instanceof QueryResultInterface) {

                $offset = (int)$this->objects->getQuery()->getOffset();

            }

            if ($this->currentPage > 1) {

                $offset = $offset + ((int)($itemsPerPage * ($this->currentPage - 1)));

            }

            $modifiedObjects = $this->‪prepareObjectsSlice($itemsPerPage, $offset);

        }

        $this->view->assign('contentArguments', [

            $this->widgetConfiguration['as'] => $modifiedObjects

        ]);

        $this->view->assign('configuration', $this->configuration);

        $this->view->assign('pagination', $this->‪buildPagination());

    }


    protected function ‪calculateDisplayRange()

    {

        ‪$maximumNumberOfLinks = ‪$this->maximumNumberOfLinks;

        if (‪$maximumNumberOfLinks > $this->numberOfPages) {

            ‪$maximumNumberOfLinks = ‪$this->numberOfPages;

        }

        $delta = floor(‪$maximumNumberOfLinks / 2);

        $this->displayRangeStart = $this->currentPage - $delta;

        $this->displayRangeEnd = $this->currentPage + $delta - (‪$maximumNumberOfLinks % 2 === 0 ? 1 : 0);

        if ($this->displayRangeStart < 1) {

            $this->displayRangeEnd -= $this->displayRangeStart - 1;

        }

        if ($this->displayRangeEnd > $this->numberOfPages) {

            $this->displayRangeStart -= $this->displayRangeEnd - ‪$this->numberOfPages;

        }

        $this->displayRangeStart = (int)max($this->displayRangeStart, 1);

        $this->displayRangeEnd = (int)min($this->displayRangeEnd, $this->numberOfPages);

    }


    protected function ‪buildPagination()

    {

        $this->‪calculateDisplayRange();

        $pages = [];

        for ($i = $this->displayRangeStart; $i <= ‪$this->displayRangeEnd; $i++) {

            $pages[] = ['number' => $i, 'isCurrent' => $i === ‪$this->currentPage];

        }

        $pagination = [

            'pages' => $pages,

            'current' => ‪$this->currentPage,

            'numberOfPages' => ‪$this->numberOfPages,

            'displayRangeStart' => ‪$this->displayRangeStart,

            'displayRangeEnd' => ‪$this->displayRangeEnd,

            'hasLessPages' => $this->displayRangeStart > 2,

            'hasMorePages' => $this->displayRangeEnd + 1 < ‪$this->numberOfPages

        ];

        if ($this->currentPage < $this->numberOfPages) {

            $pagination['nextPage'] = $this->currentPage + 1;

        }

        if ($this->currentPage > 1) {

            $pagination['previousPage'] = $this->currentPage - 1;

        }

        return $pagination;

    }


    protected function ‪prepareObjectsSlice($itemsPerPage, $offset)

    {

        if ($this->objects instanceof ‪QueryResultInterface) {

            $currentRange = $offset + $itemsPerPage;

            $endOfRange = min($currentRange, count($this->objects));

            $query = $this->objects->getQuery();

            $query->setLimit($itemsPerPage);

            if ($offset > 0) {

                $query->setOffset($offset);

                if ($currentRange > $endOfRange) {

                    $newLimit = $endOfRange - $offset;

                    $query->setLimit($newLimit);

                }

            }

            $modifiedObjects = $query->execute();

            return $modifiedObjects;

        }

        if ($this->objects instanceof ObjectStorage) {

            $modifiedObjects = [];

            $objectArray = $this->objects->toArray();

            $endOfRange = min($offset + $itemsPerPage, count($objectArray));

            for ($i = $offset; $i < $endOfRange; $i++) {

                $modifiedObjects[] = $objectArray[$i];

            }

            return $modifiedObjects;

        }

        if (is_array($this->objects)) {

            $modifiedObjects = array_slice($this->objects, $offset, $itemsPerPage);

            return $modifiedObjects;

        }

        throw new \InvalidArgumentException(

            'The ViewHelper "' . static::class

                . '" accepts as argument "QueryResultInterface", "\SplObjectStorage", "ObjectStorage" or an array. '

                . 'given: ' . get_class($this->objects),

            1385547291

        );

    }

}