vendor/knplabs/knp-components/src/Knp/Component/Pager/Pagination/AbstractPagination.php line 7

Open in your IDE?
  1. <?php
  3. namespace Knp\Component\Pager\Pagination;
  5. use Iterator;
  7. abstract class AbstractPagination implements Iterator, PaginationInterface
  8. {
  9.     protected $currentPageNumber;
  10.     protected $numItemsPerPage;
  11.     protected $items = [];
  12.     protected $totalCount;
  13.     protected $paginatorOptions;
  14.     protected $customParameters;
  16.     public function rewind(): void
  17.     {
  18.         reset($this->items);
  19.     }
  21.     /**
  22.      * @return mixed
  23.      */
  24.     public function current()
  25.     {
  26.         return current($this->items);
  27.     }
  29.     /**
  30.      * @return bool|float|int|string|null
  31.      */
  32.     public function key()
  33.     {
  34.         return key($this->items);
  35.     }
  37.     public function next(): void
  38.     {
  39.         next($this->items);
  40.     }
  42.     public function valid(): bool
  43.     {
  44.         return key($this->items) !== null;
  45.     }
  47.     public function count(): int
  48.     {
  49.         return count($this->items);
  50.     }
  52.     public function setCustomParameters(array $parameters): void
  53.     {
  54.         $this->customParameters = $parameters;
  55.     }
  57.     /**
  58.      * @return mixed|null
  59.      */
  60.     public function getCustomParameter(string $name)
  61.     {
  62.         return $this->customParameters[$name] ?? null;
  63.     }
  65.     public function setCurrentPageNumber(int $pageNumber): void
  66.     {
  67.         $this->currentPageNumber = $pageNumber;
  68.     }
  70.     public function getCurrentPageNumber(): int
  71.     {
  72.         return $this->currentPageNumber;
  73.     }
  75.     public function setItemNumberPerPage(int $numItemsPerPage): void
  76.     {
  77.         $this->numItemsPerPage = $numItemsPerPage;
  78.     }
  80.     public function getItemNumberPerPage(): int
  81.     {
  82.         return $this->numItemsPerPage;
  83.     }
  85.     public function setTotalItemCount(int $numTotal): void
  86.     {
  87.         $this->totalCount = $numTotal;
  88.     }
  90.     public function getTotalItemCount(): int
  91.     {
  92.         return $this->totalCount;
  93.     }
  95.     public function setPaginatorOptions(array $options): void
  96.     {
  97.         $this->paginatorOptions = $options;
  98.     }
  100.     /**
  101.      * @return mixed|null
  102.      */
  103.     public function getPaginatorOption(string $name)
  104.     {
  105.         return $this->paginatorOptions[$name] ?? null;
  106.     }
  108.     public function setItems(iterable $items): void
  109.     {
  110.         $this->items = $items;
  111.     }
  113.     public function getItems(): iterable
  114.     {
  115.         return $this->items;
  116.     }
  118.     /**
  119.      * @param string|int|float|bool|null $offset
  120.      */
  121.     public function offsetExists($offset): bool
  122.     {
  123.         if ($this->items instanceof \ArrayIterator) {
  124.             return array_key_exists($offset, iterator_to_array($this->items));
  125.         }
  127.         return array_key_exists($offset, $this->items);
  128.     }
  130.     /**
  131.      * @param string|int|float|bool|null $offset
  132.      * @return mixed
  133.      */
  134.     public function offsetGet($offset)
  135.     {
  136.         return $this->items[$offset];
  137.     }
  139.     /**
  140.      * @param string|int|float|bool|null $offset
  141.      * @param mixed $value
  142.      */
  143.     public function offsetSet($offset, $value): void
  144.     {
  145.         if (null === $offset) {
  146.             $this->items[] = $value;
  147.         } else {
  148.             $this->items[$offset] = $value;
  149.         }
  150.     }
  152.     /**
  153.      * @param string|int|float|bool|null $offset
  154.      */
  155.     public function offsetUnset($offset): void
  156.     {
  157.         unset($this->items[$offset]);
  158.     }
  159. }