Pagerfanta::getCurrentPageResultsFromAdapter() - Code Metrics - Inspection of "[RFC] Lazy adapters implementation" - whiteoctober/Pagerfanta - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#183)

by Konstantin

created 2017-11-20 01:52 UTC

Pagerfanta::getCurrentPageResultsFromAdapter() A

↳ Parent: Pagerfanta

Complexity

Conditions	3
Paths	3

Size

Total Lines	18
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3.4326

Importance

Changes

Metric	Value
dl	0
loc	18
c	0
b	0
f	0
ccs	7
cts	11
cp	0.6364
rs	9.4285
cc	3
eloc	10
nc	3
nop	0
crap	3.4326

<?php

/*
 * This file is part of the Pagerfanta package.
 *
 * (c) Pablo Díez <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Pagerfanta;

use OutOfBoundsException;
use Pagerfanta\Adapter\AdapterInterface;
use Pagerfanta\Adapter\LazyAdapterInterface;
use Pagerfanta\Exception\LogicException;
use Pagerfanta\Exception\NotBooleanException;
use Pagerfanta\Exception\NotIntegerException;
use Pagerfanta\Exception\NotIntegerMaxPerPageException;
use Pagerfanta\Exception\LessThan1MaxPerPageException;
use Pagerfanta\Exception\NotIntegerCurrentPageException;
use Pagerfanta\Exception\LessThan1CurrentPageException;
use Pagerfanta\Exception\OutOfRangeCurrentPageException;

/**
 * Represents a paginator.
 *
 * @author Pablo Díez <[email protected]>
 */
class Pagerfanta implements \Countable, \IteratorAggregate, PagerfantaInterface

{
    private $adapter;
    private $allowOutOfRangePages;
    private $normalizeOutOfRangePages;
    private $maxPerPage;
    private $currentPage;
    private $nbResults;
    private $currentPageResults;

    /**
     * @param AdapterInterface $adapter An adapter.
     */
    public function __construct(AdapterInterface $adapter)
    {
        $this->adapter = $adapter;
        $this->allowOutOfRangePages = false;
        $this->normalizeOutOfRangePages = false;
        $this->maxPerPage = 10;
        $this->currentPage = 1;
    }

    /**
     * Returns the adapter.
     *
     * @return AdapterInterface The adapter.
     */
    public function getAdapter()
    {
        return $this->adapter;
    }

    /**
     * Sets whether or not allow out of range pages.
     *
     * @param Boolean $value
     *
     * @return self
     */
    public function setAllowOutOfRangePages($value)
    {
        $this->allowOutOfRangePages = $this->filterBoolean($value);

        return $this;
    }

    /**
     * Returns whether or not allow out of range pages.
     *
     * @return Boolean
     */
    public function getAllowOutOfRangePages()
    {
        return $this->allowOutOfRangePages;
    }

    /**
     * Sets whether or not normalize out of range pages.
     *
     * @param Boolean $value
     *
     * @return self
     */
    public function setNormalizeOutOfRangePages($value)
    {
        $this->normalizeOutOfRangePages = $this->filterBoolean($value);

        return $this;
    }

    /**
     * Returns whether or not normalize out of range pages.
     *
     * @return Boolean
     */
    public function getNormalizeOutOfRangePages()
    {
        return $this->normalizeOutOfRangePages;
    }

    private function filterBoolean($value)
    {
        if (!is_bool($value)) {
            throw new NotBooleanException();
        }

        return $value;
    }

    /**
     * Sets the max per page.
     *
     * Tries to convert from string and float.
     *
     * @param integer $maxPerPage
     *
     * @return self
     *
     * @throws NotIntegerMaxPerPageException If the max per page is not an integer even converting.
     * @throws LessThan1MaxPerPageException  If the max per page is less than 1.
     */
    public function setMaxPerPage($maxPerPage)
    {
        $this->maxPerPage = $this->filterMaxPerPage($maxPerPage);
        $this->resetForMaxPerPageChange();

        return $this;
    }

    private function filterMaxPerPage($maxPerPage)
    {
        $maxPerPage = $this->toInteger($maxPerPage);
        $this->checkMaxPerPage($maxPerPage);

        return $maxPerPage;
    }

    private function checkMaxPerPage($maxPerPage)
    {
        if (!is_int($maxPerPage)) {
            throw new NotIntegerMaxPerPageException();
        }

        if ($maxPerPage < 1) {
            throw new LessThan1MaxPerPageException();
        }
    }

    private function resetForMaxPerPageChange()
    {
        $this->currentPageResults = null;
        $this->nbResults = null;
    }

    /**
     * Returns the max per page.
     *
     * @return integer
     */
    public function getMaxPerPage()
    {
        return $this->maxPerPage;
    }

    /**
     * Sets the current page.
     *
     * Tries to convert from string and float.
     *
     * @param integer $currentPage
     *
     * @return self
     *
     * @throws NotIntegerCurrentPageException If the current page is not an integer even converting.
     * @throws LessThan1CurrentPageException  If the current page is less than 1.
     * @throws OutOfRangeCurrentPageException If It is not allowed out of range pages and they are not normalized.
     */
    public function setCurrentPage($currentPage)
    {
        $this->useDeprecatedCurrentPageBooleanArguments(func_get_args());

        $this->currentPage = $this->filterCurrentPage($currentPage);
        $this->resetForCurrentPageChange();

        return $this;
    }

    private function useDeprecatedCurrentPageBooleanArguments($arguments)
    {
        $this->useDeprecatedCurrentPageAllowOutOfRangePagesBooleanArgument($arguments);
        $this->useDeprecatedCurrentPageNormalizeOutOfRangePagesBooleanArgument($arguments);
    }

    private function useDeprecatedCurrentPageAllowOutOfRangePagesBooleanArgument($arguments)
    {
        $index = 1;
        $method = 'setAllowOutOfRangePages';

        $this->useDeprecatedBooleanArgument($arguments, $index, $method);
    }

    private function useDeprecatedCurrentPageNormalizeOutOfRangePagesBooleanArgument($arguments)
    {
        $index = 2;
        $method = 'setNormalizeOutOfRangePages';

        $this->useDeprecatedBooleanArgument($arguments, $index, $method);
    }

    private function useDeprecatedBooleanArgument($arguments, $index, $method)
    {
        if (isset($arguments[$index])) {
            $this->$method($arguments[$index]);
        }
    }

    private function filterCurrentPage($currentPage)
    {
        $currentPage = $this->toInteger($currentPage);
        $this->checkCurrentPage($currentPage);
        if (!$this->adapter instanceof LazyAdapterInterface) {
            $currentPage = $this->filterOutOfRangeCurrentPage($currentPage);
        }

        return $currentPage;
    }

    private function checkCurrentPage($currentPage)
    {
        if (!is_int($currentPage)) {
            throw new NotIntegerCurrentPageException();
        }

        if ($currentPage < 1) {
            throw new LessThan1CurrentPageException();
        }
    }

    private function filterOutOfRangeCurrentPage($currentPage)
    {
        if ($this->notAllowedCurrentPageOutOfRange($currentPage)) {
            return $this->normalizeOutOfRangeCurrentPage($currentPage);
        }

        return $currentPage;
    }

    private function notAllowedCurrentPageOutOfRange($currentPage)
    {
        return !$this->getAllowOutOfRangePages() &&
               $this->currentPageOutOfRange($currentPage);
    }

    private function currentPageOutOfRange($currentPage)
    {
        return $currentPage > 1 && $currentPage > $this->getNbPages();
    }

    /**
     * @param int $currentPage
     *
     * @return int
     *
     * @throws OutOfRangeCurrentPageException If the page should not be normalized
     */
    private function normalizeOutOfRangeCurrentPage($currentPage)
    {
        if ($this->getNormalizeOutOfRangePages()) {
            return $this->getNbPages();
        }

        throw new OutOfRangeCurrentPageException(sprintf('Page "%d" does not exist. The currentPage must be inferior to "%d"', $currentPage, $this->getNbPages()));
    }

    private function resetForCurrentPageChange()
    {
        $this->currentPageResults = null;
    }

    /**
     * Returns the current page.
     *
     * @return integer
     */
    public function getCurrentPage()
    {
        return $this->currentPage;
    }

    /**
     * Returns the results for the current page.
     *
     * @return array|\Traversable
     */
    public function getCurrentPageResults()
    {
        if ($this->notCachedCurrentPageResults()) {
            $this->currentPageResults = $this->getCurrentPageResultsFromAdapter();
        }

        return $this->currentPageResults;
    }

    private function notCachedCurrentPageResults()
    {
        return $this->currentPageResults === null;
    }

    private function getCurrentPageResultsFromAdapter()
    {
        $offset = $this->calculateOffsetForCurrentPageResults();
        $length = $this->getMaxPerPage();

        $slice = $this->adapter->getSlice($offset, $length);

        if ($this->adapter instanceof LazyAdapterInterface) {
            $page = $this->filterOutOfRangeCurrentPage($this->getCurrentPage());
            if ($page != $this->getCurrentPage()) {
                $this->setCurrentPage($page);

                return $this->getCurrentPageResultsFromAdapter();
            }
        }

        return $slice;
    }

    private function calculateOffsetForCurrentPageResults()
    {
        return ($this->getCurrentPage() - 1) * $this->getMaxPerPage();
    }

    /**
     * Calculates the current page offset start
     *
     * @return int
     */
    public function getCurrentPageOffsetStart()
    {
        return $this->getNbResults() ?
               $this->calculateOffsetForCurrentPageResults() + 1 :
               0;
    }

    /**
     * Calculates the current page offset end
     *
     * @return int
     */
    public function getCurrentPageOffsetEnd()
    {
        return $this->hasNextPage() ?
               $this->getCurrentPage() * $this->getMaxPerPage() :
               $this->getNbResults();
    }

    /**
     * Returns the number of results.
     *
     * @return integer
     */
    public function getNbResults()
    {
        if ($this->notCachedNbResults()) {
            $this->nbResults = $this->getAdapter()->getNbResults();
        }

        return $this->nbResults;
    }

    private function notCachedNbResults()
    {
        return $this->nbResults === null;
    }

    /**
     * Returns the number of pages.
     *
     * @return integer
     */
    public function getNbPages()
    {
        $nbPages = $this->calculateNbPages();

        if ($nbPages == 0) {
            return $this->minimumNbPages();
        }

        return $nbPages;
    }

    private function calculateNbPages()
    {
        return (int) ceil($this->getNbResults() / $this->getMaxPerPage());
    }

    private function minimumNbPages()
    {
        return 1;
    }

    /**
     * Returns if the number of results is higher than the max per page.
     *
     * @return Boolean
     */
    public function haveToPaginate()
    {
        return $this->getNbResults() > $this->maxPerPage;
    }

    /**
     * Returns whether there is previous page or not.
     *
     * @return Boolean
     */
    public function hasPreviousPage()
    {
        return $this->currentPage > 1;
    }

    /**
     * Returns the previous page.
     *
     * @return integer
     *
     * @throws LogicException If there is no previous page.
     */
    public function getPreviousPage()
    {
        if (!$this->hasPreviousPage()) {
            throw new LogicException('There is no previous page.');
        }

        return $this->currentPage - 1;
    }

    /**
     * Returns whether there is next page or not.
     *
     * @return Boolean
     */
    public function hasNextPage()
    {
        return $this->currentPage < $this->getNbPages();
    }

    /**
     * Returns the next page.
     *
     * @return integer
     *
     * @throws LogicException If there is no next page.
     */
    public function getNextPage()
    {
        if (!$this->hasNextPage()) {
            throw new LogicException('There is no next page.');
        }

        return $this->currentPage + 1;
    }

    /**
     * Implements the \Countable interface.
     *
     * Return integer The number of results.
     */
    public function count()
    {
        return $this->getNbResults();
    }

    /**
     * Implements the \IteratorAggregate interface.
     *
     * Returns an \ArrayIterator instance with the current results.
     */
    public function getIterator()
    {
        $results = $this->getCurrentPageResults();

        if ($results instanceof \Iterator) {
            return $results;
        }

        if ($results instanceof \IteratorAggregate) {
            return $results->getIterator();
        }

        return new \ArrayIterator($results);
    }

    private function toInteger($value)
    {
        if ($this->needsToIntegerConversion($value)) {
            return (int) $value;
        }

        return $value;
    }

    private function needsToIntegerConversion($value)
    {
        return (is_string($value) || is_float($value)) && (int) $value == $value;
    }

    /**
     * Get page number of the item at specified position (1-based index)
     *
     * @param integer $position
     *
     * @return integer
     */
    public function getPageNumberForItemAtPosition($position)
    {
        if (!is_int($position)) {
            throw new NotIntegerException();
        }

        if ($this->getNbResults() < $position) {
            throw new OutOfBoundsException(sprintf(
                'Item requested at position %d, but there are only %d items.',
                $position,
                $this->getNbResults()
            ));
        }

        return (int) ceil($position/$this->getMaxPerPage());
    }
}


1		<?php
2
3		/*
4		* This file is part of the Pagerfanta package.
5		*
6		* (c) Pablo Díez <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Pagerfanta;
13
14		use OutOfBoundsException;
15		use Pagerfanta\Adapter\AdapterInterface;
16		use Pagerfanta\Adapter\LazyAdapterInterface;
17		use Pagerfanta\Exception\LogicException;
18		use Pagerfanta\Exception\NotBooleanException;
19		use Pagerfanta\Exception\NotIntegerException;
20		use Pagerfanta\Exception\NotIntegerMaxPerPageException;
21		use Pagerfanta\Exception\LessThan1MaxPerPageException;
22		use Pagerfanta\Exception\NotIntegerCurrentPageException;
23		use Pagerfanta\Exception\LessThan1CurrentPageException;
24		use Pagerfanta\Exception\OutOfRangeCurrentPageException;
25
26		/**
27		* Represents a paginator.
28		*
29		* @author Pablo Díez <[email protected]>
30		*/
31		class Pagerfanta implements \Countable, \IteratorAggregate, PagerfantaInterface
		0 ignored issues – show Deprecated Code introduced 2015-12-28 23:11 UTC by Report Bug Copy Issue Report The interface `Pagerfanta\PagerfantaInterface` has been deprecated. This class, trait or interface has been deprecated. Loading history...
32		{
33		private $adapter;
34		private $allowOutOfRangePages;
35		private $normalizeOutOfRangePages;
36		private $maxPerPage;
37		private $currentPage;
38		private $nbResults;
39		private $currentPageResults;
40
41		/**
42		* @param AdapterInterface $adapter An adapter.
43		*/
44	138	public function __construct(AdapterInterface $adapter)
45		{
46	138	$this->adapter = $adapter;
47	138	$this->allowOutOfRangePages = false;
48	138	$this->normalizeOutOfRangePages = false;
49	138	$this->maxPerPage = 10;
50	138	$this->currentPage = 1;
51	138	}
52
53		/**
54		* Returns the adapter.
55		*
56		* @return AdapterInterface The adapter.
57		*/
58	86	public function getAdapter()
59		{
60	86	return $this->adapter;
61		}
62
63		/**
64		* Sets whether or not allow out of range pages.
65		*
66		* @param Boolean $value
67		*
68		* @return self
69		*/
70	10	public function setAllowOutOfRangePages($value)
71		{
72	10	$this->allowOutOfRangePages = $this->filterBoolean($value);
73
74	7	return $this;
75		}
76
77		/**
78		* Returns whether or not allow out of range pages.
79		*
80		* @return Boolean
81		*/
82	85	public function getAllowOutOfRangePages()
83		{
84	85	return $this->allowOutOfRangePages;
85		}
86
87		/**
88		* Sets whether or not normalize out of range pages.
89		*
90		* @param Boolean $value
91		*
92		* @return self
93		*/
94	8	public function setNormalizeOutOfRangePages($value)
95		{
96	8	$this->normalizeOutOfRangePages = $this->filterBoolean($value);
97
98	5	return $this;
99		}
100
101		/**
102		* Returns whether or not normalize out of range pages.
103		*
104		* @return Boolean
105		*/
106	7	public function getNormalizeOutOfRangePages()
107		{
108	7	return $this->normalizeOutOfRangePages;
109		}
110
111	16	private function filterBoolean($value)
112		{
113	16	if (!is_bool($value)) {
114	6	throw new NotBooleanException();
115		}
116
117	10	return $value;
118		}
119
120		/**
121		* Sets the max per page.
122		*
123		* Tries to convert from string and float.
124		*
125		* @param integer $maxPerPage
126		*
127		* @return self
128		*
129		* @throws NotIntegerMaxPerPageException If the max per page is not an integer even converting.
130		* @throws LessThan1MaxPerPageException If the max per page is less than 1.
131		*/
132	51	public function setMaxPerPage($maxPerPage)
133		{
134	51	$this->maxPerPage = $this->filterMaxPerPage($maxPerPage);
135	45	$this->resetForMaxPerPageChange();
136
137	45	return $this;
138		}
139
140	51	private function filterMaxPerPage($maxPerPage)
141		{
142	51	$maxPerPage = $this->toInteger($maxPerPage);
143	51	$this->checkMaxPerPage($maxPerPage);
144
145	45	return $maxPerPage;
146		}
147
148	51	private function checkMaxPerPage($maxPerPage)
149		{
150	51	if (!is_int($maxPerPage)) {
151	4	throw new NotIntegerMaxPerPageException();
152		}
153
154	47	if ($maxPerPage < 1) {
155	2	throw new LessThan1MaxPerPageException();
156		}
157	45	}
158
159	45	private function resetForMaxPerPageChange()
160		{
161	45	$this->currentPageResults = null;
162	45	$this->nbResults = null;
163	45	}
164
165		/**
166		* Returns the max per page.
167		*
168		* @return integer
169		*/
170	89	public function getMaxPerPage()
171		{
172	89	return $this->maxPerPage;
173		}
174
175		/**
176		* Sets the current page.
177		*
178		* Tries to convert from string and float.
179		*
180		* @param integer $currentPage
181		*
182		* @return self
183		*
184		* @throws NotIntegerCurrentPageException If the current page is not an integer even converting.
185		* @throws LessThan1CurrentPageException If the current page is less than 1.
186		* @throws OutOfRangeCurrentPageException If It is not allowed out of range pages and they are not normalized.
187		*/
188	89	public function setCurrentPage($currentPage)
189		{
190	89	$this->useDeprecatedCurrentPageBooleanArguments(func_get_args());
191
192	89	$this->currentPage = $this->filterCurrentPage($currentPage);
193	82	$this->resetForCurrentPageChange();
194
195	82	return $this;
196		}
197
198	89	private function useDeprecatedCurrentPageBooleanArguments($arguments)
199		{
200	89	$this->useDeprecatedCurrentPageAllowOutOfRangePagesBooleanArgument($arguments);
201	89	$this->useDeprecatedCurrentPageNormalizeOutOfRangePagesBooleanArgument($arguments);
202	89	}
203
204	89	private function useDeprecatedCurrentPageAllowOutOfRangePagesBooleanArgument($arguments)
205		{
206	89	$index = 1;
207	89	$method = 'setAllowOutOfRangePages';
208
209	89	$this->useDeprecatedBooleanArgument($arguments, $index, $method);
210	89	}
211
212	89	private function useDeprecatedCurrentPageNormalizeOutOfRangePagesBooleanArgument($arguments)
213		{
214	89	$index = 2;
215	89	$method = 'setNormalizeOutOfRangePages';
216
217	89	$this->useDeprecatedBooleanArgument($arguments, $index, $method);
218	89	}
219
220	89	private function useDeprecatedBooleanArgument($arguments, $index, $method)
221		{
222	89	if (isset($arguments[$index])) {
223	2	$this->$method($arguments[$index]);
224	2	}
225	89	}
226
227	89	private function filterCurrentPage($currentPage)
228		{
229	89	$currentPage = $this->toInteger($currentPage);
230	89	$this->checkCurrentPage($currentPage);
231	83	if (!$this->adapter instanceof LazyAdapterInterface) {
232	81	$currentPage = $this->filterOutOfRangeCurrentPage($currentPage);
233	80	}
234
235	82	return $currentPage;
236		}
237
238	89	private function checkCurrentPage($currentPage)
239		{
240	89	if (!is_int($currentPage)) {
241	4	throw new NotIntegerCurrentPageException();
242		}
243
244	85	if ($currentPage < 1) {
245	2	throw new LessThan1CurrentPageException();
246		}
247	83	}
248
249	82	private function filterOutOfRangeCurrentPage($currentPage)
250		{
251	82	if ($this->notAllowedCurrentPageOutOfRange($currentPage)) {
252	4	return $this->normalizeOutOfRangeCurrentPage($currentPage);
253		}
254
255	78	return $currentPage;
256		}
257
258	82	private function notAllowedCurrentPageOutOfRange($currentPage)
259		{
260	82	return !$this->getAllowOutOfRangePages() &&
261	82	$this->currentPageOutOfRange($currentPage);
262		}
263
264	80	private function currentPageOutOfRange($currentPage)
265		{
266	80	return $currentPage > 1 && $currentPage > $this->getNbPages();
267		}
268
269		/**
270		* @param int $currentPage
271		*
272		* @return int
273		*
274		* @throws OutOfRangeCurrentPageException If the page should not be normalized
275		*/
276	4	private function normalizeOutOfRangeCurrentPage($currentPage)
277		{
278	4	if ($this->getNormalizeOutOfRangePages()) {
279	2	return $this->getNbPages();
280		}
281
282	2	throw new OutOfRangeCurrentPageException(sprintf('Page "%d" does not exist. The currentPage must be inferior to "%d"', $currentPage, $this->getNbPages()));
283		}
284
285	82	private function resetForCurrentPageChange()
286		{
287	82	$this->currentPageResults = null;
288	82	}
289
290		/**
291		* Returns the current page.
292		*
293		* @return integer
294		*/
295	74	public function getCurrentPage()
296		{
297	74	return $this->currentPage;
298		}
299
300		/**
301		* Returns the results for the current page.
302		*
303		* @return array\|\Traversable
304		*/
305	10	public function getCurrentPageResults()
306		{
307	10	if ($this->notCachedCurrentPageResults()) {
308	10	$this->currentPageResults = $this->getCurrentPageResultsFromAdapter();
309	9	}
310
311	9	return $this->currentPageResults;
312		}
313
314	10	private function notCachedCurrentPageResults()
315		{
316	10	return $this->currentPageResults === null;
317		}
318
319	10	private function getCurrentPageResultsFromAdapter()
320		{
321	10	$offset = $this->calculateOffsetForCurrentPageResults();
322	10	$length = $this->getMaxPerPage();
323
324	10	$slice = $this->adapter->getSlice($offset, $length);
325
326	10	if ($this->adapter instanceof LazyAdapterInterface) {
327	1	$page = $this->filterOutOfRangeCurrentPage($this->getCurrentPage());
328		if ($page != $this->getCurrentPage()) {
329		$this->setCurrentPage($page);
330
331		return $this->getCurrentPageResultsFromAdapter();
332		}
333		}
334
335	9	return $slice;
336		}
337
338	11	private function calculateOffsetForCurrentPageResults()
339		{
340	11	return ($this->getCurrentPage() - 1) * $this->getMaxPerPage();
341		}
342
343		/**
344		* Calculates the current page offset start
345		*
346		* @return int
347		*/
348	2	public function getCurrentPageOffsetStart()
349		{
350	2	return $this->getNbResults() ?
351	2	$this->calculateOffsetForCurrentPageResults() + 1 :
352	2	0;
353		}
354
355		/**
356		* Calculates the current page offset end
357		*
358		* @return int
359		*/
360	2	public function getCurrentPageOffsetEnd()
361		{
362	2	return $this->hasNextPage() ?
363	2	$this->getCurrentPage() * $this->getMaxPerPage() :
364	2	$this->getNbResults();
365		}
366
367		/**
368		* Returns the number of results.
369		*
370		* @return integer
371		*/
372	85	public function getNbResults()
373		{
374	85	if ($this->notCachedNbResults()) {
375	85	$this->nbResults = $this->getAdapter()->getNbResults();
376	85	}
377
378	85	return $this->nbResults;
379		}
380
381	85	private function notCachedNbResults()
382		{
383	85	return $this->nbResults === null;
384		}
385
386		/**
387		* Returns the number of pages.
388		*
389		* @return integer
390		*/
391	75	public function getNbPages()
392		{
393	75	$nbPages = $this->calculateNbPages();
394
395	75	if ($nbPages == 0) {
396	1	return $this->minimumNbPages();
397		}
398
399	74	return $nbPages;
400		}
401
402	75	private function calculateNbPages()
403		{
404	75	return (int) ceil($this->getNbResults() / $this->getMaxPerPage());
405		}
406
407	1	private function minimumNbPages()
408		{
409	1	return 1;
410		}
411
412		/**
413		* Returns if the number of results is higher than the max per page.
414		*
415		* @return Boolean
416		*/
417	3	public function haveToPaginate()
418		{
419	3	return $this->getNbResults() > $this->maxPerPage;
420		}
421
422		/**
423		* Returns whether there is previous page or not.
424		*
425		* @return Boolean
426		*/
427	56	public function hasPreviousPage()
428		{
429	56	return $this->currentPage > 1;
430		}
431
432		/**
433		* Returns the previous page.
434		*
435		* @return integer
436		*
437		* @throws LogicException If there is no previous page.
438		*/
439	43	public function getPreviousPage()
440		{
441	43	if (!$this->hasPreviousPage()) {
442	1	throw new LogicException('There is no previous page.');
443		}
444
445	42	return $this->currentPage - 1;
446		}
447
448		/**
449		* Returns whether there is next page or not.
450		*
451		* @return Boolean
452		*/
453	58	public function hasNextPage()
454		{
455	58	return $this->currentPage < $this->getNbPages();
456		}
457
458		/**
459		* Returns the next page.
460		*
461		* @return integer
462		*
463		* @throws LogicException If there is no next page.
464		*/
465	49	public function getNextPage()
466		{
467	49	if (!$this->hasNextPage()) {
468	1	throw new LogicException('There is no next page.');
469		}
470
471	48	return $this->currentPage + 1;
472		}
473
474		/**
475		* Implements the \Countable interface.
476		*
477		* Return integer The number of results.
478		*/
479	1	public function count()
480		{
481	1	return $this->getNbResults();
482		}
483
484		/**
485		* Implements the \IteratorAggregate interface.
486		*
487		* Returns an \ArrayIterator instance with the current results.
488		*/
489	3	public function getIterator()
490		{
491	3	$results = $this->getCurrentPageResults();
492
493	3	if ($results instanceof \Iterator) {
494	1	return $results;
495		}
496
497	2	if ($results instanceof \IteratorAggregate) {
498	1	return $results->getIterator();
499		}
500
501	1	return new \ArrayIterator($results);
502		}
503
504	111	private function toInteger($value)
505		{
506	111	if ($this->needsToIntegerConversion($value)) {
507	6	return (int) $value;
508		}
509
510	108	return $value;
511		}
512
513	111	private function needsToIntegerConversion($value)
514		{
515	111	return (is_string($value) \|\| is_float($value)) && (int) $value == $value;
516		}
517
518		/**
519		* Get page number of the item at specified position (1-based index)
520		*
521		* @param integer $position
522		*
523		* @return integer
524		*/
525	3	public function getPageNumberForItemAtPosition($position)
526		{
527	3	if (!is_int($position)) {
528	1	throw new NotIntegerException();
529		}
530
531	2	if ($this->getNbResults() < $position) {
532	1	throw new OutOfBoundsException(sprintf(
533	1	'Item requested at position %d, but there are only %d items.',
534	1	$position,
535	1	$this->getNbResults()
536	1	));
537		}
538
539	1	return (int) ceil($position/$this->getMaxPerPage());
540		}
541		}
542

whiteoctober / Pagerfanta

Pull Request — master (#183)

Pagerfanta::getCurrentPageResultsFromAdapter() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like