Use pagerfanta/pagerfanta to properly display pagination

.travis.yml

@@ -2,7 +2,6 @@ sudo: required
 
 language: php
 php:
- - 7.1
  - 7.2
  - 7.3
 

composer.json

@@ -10,7 +10,7 @@
  }
  ],
  "require": {
- "php": "~7.1.0|~7.2.0|~7.3.0",
+ "php": "~7.2.0|~7.3.0",
  "ext-pcntl": "*",
  "symfony/dependency-injection": "^3.3",
  "symfony/config": "^3.3",
@@ -32,7 +32,9 @@
  "symfony/property-info": "^4.3",
  "doctrine/annotations": "^1.8",
  "ramsey/uuid": "^3.8",
- "webgriffe/amp-elasticsearch": "^1.1"
+ "webgriffe/amp-elasticsearch": "^1.1",
+ "pagerfanta/pagerfanta": "^2.3",
+ "symfony/deprecation-contracts": "^2.1"
  },
  "autoload": {
  "psr-4": {

phpstan.neon

@@ -4,3 +4,4 @@ parameters:
  - '/Method Webgriffe\\Esb\\FlowExtension::getNamespace\(\) should return string but returns false\./'
  - '/Method Webgriffe\\Esb\\FlowExtension::getXsdValidationBasePath\(\) should return string but returns false\./'
  - '/Call to an undefined method Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition::useAttributeAsKey\(\)\./'
+ - '/Webgriffe\\Esb\\Console\\Pager\\AsyncPager::__construct\(\) does not call parent constructor from Pagerfanta\\Pagerfanta\./'

src/Console/Pager/AmpElasticsearchUriSearchAdapter.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Webgriffe\Esb\Console\Pager;
 
 use Amp\Promise;

src/Console/Pager/AsyncPager.php

@@ -5,12 +5,19 @@
 namespace Webgriffe\Esb\Console\Pager;
 
 use Amp\Promise;
+use Pagerfanta\Exception\LessThan1CurrentPageException;
+use Pagerfanta\Exception\LessThan1MaxPerPageException;
+use Pagerfanta\Exception\NotValidCurrentPageException;
+use Pagerfanta\Exception\NotValidMaxPerPageException;
+use Pagerfanta\Exception\OutOfRangeCurrentPageException;
+use Pagerfanta\Pagerfanta;
+use Webmozart\Assert\Assert;
 use function Amp\call;
 
 /**
  * @internal
  */
-class AsyncPager
+class AsyncPager extends Pagerfanta
 {
  /**
  * @var AsyncPagerAdapterInterface
@@ -45,6 +52,10 @@ class AsyncPager
  */
  private $currentPageResults;
 
+ /**
+ * @noinspection MagicMethodsValidityInspection
+ * @noinspection PhpMissingParentConstructorInspection
+ */
  public function __construct(AsyncPagerAdapterInterface $adapter, int $maxPerPage = 10, int $currentPage = 1)
  {
  $this->adapter = $adapter;
@@ -124,9 +135,7 @@ public function getNormalizeOutOfRangePages()
 
  private function filterBoolean($value)
  {
- if (!is_bool($value)) {
- throw new NotBooleanException();
- }
+ Assert::boolean($value);
 
  return $value;
  }
@@ -140,7 +149,7 @@ private function filterBoolean($value)
  *
  * @return self
  *
- * @throws NotIntegerMaxPerPageException If the max per page is not an integer even converting.
+ * @throws NotValidMaxPerPageException 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)
@@ -162,7 +171,7 @@ private function filterMaxPerPage($maxPerPage)
  private function checkMaxPerPage($maxPerPage)
  {
  if (!is_int($maxPerPage)) {
- throw new NotIntegerMaxPerPageException();
+ throw new NotValidMaxPerPageException();
  }
 
  if ($maxPerPage < 1) {
@@ -195,7 +204,7 @@ public function getMaxPerPage()
  *
  * @return self
  *
- * @throws NotIntegerCurrentPageException If the current page is not an integer even converting.
+ * @throws NotValidCurrentPageException 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.
  */
@@ -250,7 +259,7 @@ private function filterCurrentPage($currentPage)
  private function checkCurrentPage($currentPage)
  {
  if (!is_int($currentPage)) {
- throw new NotIntegerCurrentPageException();
+ throw new NotValidCurrentPageException();
  }
 
  if ($currentPage < 1) {
@@ -534,9 +543,7 @@ private function needsToIntegerConversion($value)
  */
  public function getPageNumberForItemAtPosition($position)
  {
- if (!is_int($position)) {
- throw new NotIntegerException();
- }
+ Assert::integer($position);
 
  if ($this->getNbResults() < $position) {
  throw new \OutOfBoundsException(sprintf(

src/Console/Pager/AsyncPagerAdapterInterface.php

@@ -18,8 +18,8 @@ public function getNbResults(): Promise;
  /**
  * Returns an slice of the results.
  *
- * @param integer $offset The offset.
- * @param integer $length The length.
+ * @param int $offset The offset.
+ * @param int $length The length.
  *
  * @return Promise which resolve array|\Traversable The slice.
  */

src/Console/Pager/LessThan1CurrentPageException.php

@@ -1,7 +1,19 @@
 <?php
+// @codingStandardsIgnoreFile
 
 namespace Webgriffe\Esb\Console\Pager;
 
+trigger_deprecation(
+ 'webgriffe/esb',
+ '2.2',
+ 'The "%s" class is deprecated and will be removed in 3.0. Use the "%s" class instead.',
+ LessThan1CurrentPageException::class,
+ \Pagerfanta\Exception\LessThan1CurrentPageException::class
+);
+
+/**
+ * @deprecated to be removed in 3.0
+ */
 final class LessThan1CurrentPageException extends NotValidCurrentPageException
 {
 }

src/Console/Pager/LessThan1MaxPerPageException.php

@@ -1,7 +1,16 @@
 <?php
+// @codingStandardsIgnoreFile
 
 namespace Webgriffe\Esb\Console\Pager;
 
+trigger_deprecation(
+ 'webgriffe/esb',
+ '2.2',
+ 'The "%s" class is deprecated and will be removed in 3.0. Use the "%s" class instead.',
+ LessThan1MaxPerPageException::class,
+ \Pagerfanta\Exception\LessThan1MaxPerPageException::class
+);
+
 final class LessThan1MaxPerPageException extends NotValidMaxPerPageException
 {
 }

src/Console/Pager/NotBooleanException.php

@@ -1,7 +1,18 @@
 <?php
+// @codingStandardsIgnoreFile
 
 namespace Webgriffe\Esb\Console\Pager;
 
+trigger_deprecation(
+ 'webgriffe/esb',
+ '2.2',
+ 'The "%s" exception is deprecated and will be removed in 3.0.',
+ NotBooleanException::class
+);
+
+/**
+ * @deprecated to be removed in 3.0
+ */
 final class NotBooleanException extends \InvalidArgumentException
 {
 }

src/Console/Pager/NotIntegerCurrentPageException.php

@@ -1,7 +1,18 @@
 <?php
+// @codingStandardsIgnoreFile
 
 namespace Webgriffe\Esb\Console\Pager;
 
+trigger_deprecation(
+ 'webgriffe/esb',
+ '2.2',
+ 'The "%s" exception is deprecated and will be removed in 3.0.',
+ NotIntegerCurrentPageException::class
+);
+
+/**
+ * @deprecated to be removed in 3.0
+ */
 final class NotIntegerCurrentPageException extends NotValidCurrentPageException
 {
 

src/Console/Pager/NotIntegerException.php

@@ -1,7 +1,18 @@
 <?php
+// @codingStandardsIgnoreFile
 
 namespace Webgriffe\Esb\Console\Pager;
 
+trigger_deprecation(
+ 'webgriffe/esb',
+ '2.2',
+ 'The "%s" exception is deprecated and will be removed in 3.0.',
+ NotIntegerException::class
+);
+
+/**
+ * @deprecated to be removed in 3.0
+ */
 final class NotIntegerException extends \InvalidArgumentException
 {
 }

src/Console/Pager/NotIntegerMaxPerPageException.php

@@ -1,7 +1,18 @@
 <?php
+// @codingStandardsIgnoreFile
 
 namespace Webgriffe\Esb\Console\Pager;
 
+trigger_deprecation(
+ 'webgriffe/esb',
+ '2.2',
+ 'The "%s" exception is deprecated and will be removed in 3.0.',
+ NotIntegerMaxPerPageException::class
+);
+
+/**
+ * @deprecated to be removed in 3.0
+ */
 final class NotIntegerMaxPerPageException extends NotValidMaxPerPageException
 {
 }

src/Console/Pager/NotValidCurrentPageException.php

@@ -1,9 +1,18 @@
 <?php
+// @codingStandardsIgnoreFile
 
 namespace Webgriffe\Esb\Console\Pager;
 
+trigger_deprecation(
+ 'webgriffe/esb',
+ '2.2',
+ 'The "%s" exception is deprecated and will be removed in 3.0.',
+ NotValidCurrentPageException::class
+);
+
 /**
  * @internal
+ * @deprecated to be removed in 3.0
  */
 class NotValidCurrentPageException extends \InvalidArgumentException
 {

src/Console/Pager/NotValidMaxPerPageException.php

@@ -1,9 +1,18 @@
 <?php
+// @codingStandardsIgnoreFile
 
 namespace Webgriffe\Esb\Console\Pager;
 
+trigger_deprecation(
+ 'webgriffe/esb',
+ '2.2',
+ 'The "%s" exception is deprecated and will be removed in 3.0.',
+ NotValidMaxPerPageException::class
+);
+
 /**
  * @internal
+ * @deprecated to be removed in 3.0
  */
 class NotValidMaxPerPageException extends \InvalidArgumentException
 {

src/Console/Pager/OutOfRangeCurrentPageException.php

@@ -1,7 +1,19 @@
 <?php
+// @codingStandardsIgnoreFile
 
 namespace Webgriffe\Esb\Console\Pager;
 
+trigger_deprecation(
+ 'webgriffe/esb',
+ '2.2',
+ 'The "%s" class is deprecated and will be removed in 3.0. Use the "%s" class instead.',
+ OutOfRangeCurrentPageException::class,
+ \Pagerfanta\Exception\OutOfRangeCurrentPageException::class
+);
+
+/**
+ * @deprecated to be removed in 3.0
+ */
 final class OutOfRangeCurrentPageException extends NotValidCurrentPageException
 {
 }

src/Console/PagerfantaTwigExtension.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Webgriffe\Esb\Console;
+
+use Pagerfanta\Pagerfanta;
+use Pagerfanta\View\ViewInterface;
+use Twig\Extension\AbstractExtension;
+use Twig\TwigFunction;
+
+final class PagerfantaTwigExtension extends AbstractExtension
+{
+ /**
+ * @var ViewInterface
+ */
+ private $view;
+
+ public function __construct(ViewInterface $view)
+ {
+ $this->view = $view;
+ }
+
+ public function getFunctions()
+ {
+ return [
+ new TwigFunction('pagerfanta', [$this, 'renderPagerfanta'], ['is_safe' => ['html']])
+ ];
+ }
+
+ public function renderPagerfanta(
+ Pagerfanta $pagerfanta,
+ string $route,
+ array $options = []
+ ): string {
+ $routeGenerator = function ($page) use ($route): string {
+ return strtr($route, ['{page}' => $page]);
+ };
+
+ return $this->view->render($pagerfanta, $routeGenerator, $options);
+ }
+}

src/Console/Resources/config/services.yml

@@ -19,12 +19,18 @@ services:
  console.twig.class_extension:
  class: \Webgriffe\Esb\Console\ClassTwigExtension
 
+ console.twig.pagerfanta_extension:
+ class: \Webgriffe\Esb\Console\PagerfantaTwigExtension
+ arguments:
+ - '@console.pagerfanta.view.bootstrap4'
+
  console.twig:
  class: \Twig\Environment
  arguments:
  - '@console.twig.loader'
  calls:
  - ['addExtension', ['@console.twig.class_extension']]
+ - ['addExtension', ['@console.twig.pagerfanta_extension']]
 
  console.server:
  class: \Webgriffe\Esb\Console\Server
@@ -37,3 +43,6 @@ services:
  calls:
  - [ setContainer, [ '@service_container' ]]
  public: true
+
+ console.pagerfanta.view.bootstrap4:
+ class: \Pagerfanta\View\TwitterBootstrap4View