From 35f1a4b6722f076f7d60d4a30caf6890a0230da4 Mon Sep 17 00:00:00 2001
From: Alejandro Celaya <alejandro@alejandrocelaya.com>
Date: Mon, 4 Jul 2016 08:57:37 +0200
Subject: [PATCH] Created stuff to handle pagination on list results

---
 composer.json                                 |  1 +
 src/Repository/PaginableRepository.php        | 14 +++++++
 src/Repository/ShortUrlRepository.php         | 42 +++++++++++++++++++
 .../ShortUrlRepositoryInterface.php           |  8 ++++
 src/Service/ShortUrlService.php               |  3 +-
 src/Service/ShortUrlServiceInterface.php      |  3 +-
 src/Service/VisitsTracker.php                 |  3 +-
 src/Service/VisitsTrackerInterface.php        |  3 +-
 8 files changed, 73 insertions(+), 4 deletions(-)
 create mode 100644 src/Repository/PaginableRepository.php
 create mode 100644 src/Repository/ShortUrlRepository.php
 create mode 100644 src/Repository/ShortUrlRepositoryInterface.php

diff --git a/composer.json b/composer.json
index 15f92bee..374fed26 100644
--- a/composer.json
+++ b/composer.json
@@ -18,6 +18,7 @@
         "zendframework/zend-expressive-twigrenderer": "^1.0",
         "zendframework/zend-stdlib": "^2.7",
         "zendframework/zend-servicemanager": "^3.0",
+        "zendframework/zend-paginator": "^2.6",
         "doctrine/orm": "^2.5",
         "guzzlehttp/guzzle": "^6.2",
         "acelaya/zsm-annotated-services": "^0.2.0",
diff --git a/src/Repository/PaginableRepository.php b/src/Repository/PaginableRepository.php
new file mode 100644
index 00000000..ad993961
--- /dev/null
+++ b/src/Repository/PaginableRepository.php
@@ -0,0 +1,14 @@
+<?php
+namespace Acelaya\UrlShortener\Repository;
+
+interface PaginableRepository
+{
+    /**
+     * @param int|null $limit
+     * @param int|null $offset
+     * @param string|null $searchTerm
+     * @param string|array|null $orderBy
+     * @return array
+     */
+    public function findList($limit = null, $offset = null, $searchTerm = null, $orderBy = null);
+}
diff --git a/src/Repository/ShortUrlRepository.php b/src/Repository/ShortUrlRepository.php
new file mode 100644
index 00000000..cfc23d58
--- /dev/null
+++ b/src/Repository/ShortUrlRepository.php
@@ -0,0 +1,42 @@
+<?php
+namespace Acelaya\UrlShortener\Repository;
+
+use Acelaya\UrlShortener\Entity\ShortUrl;
+use Doctrine\ORM\EntityRepository;
+
+class ShortUrlRepository extends EntityRepository implements ShortUrlRepositoryInterface
+{
+    /**
+     * @param int|null $limit
+     * @param int|null $offset
+     * @param string|null $searchTerm
+     * @param string|array|null $orderBy
+     * @return ShortUrl[]
+     */
+    public function findList($limit = null, $offset = null, $searchTerm = null, $orderBy = null)
+    {
+        $qb = $this->createQueryBuilder('s');
+
+        if (isset($limit)) {
+            $qb->setMaxResults($limit);
+        }
+        if (isset($offset)) {
+            $qb->setFirstResult($offset);
+        }
+        if (isset($searchTerm)) {
+            // TODO
+        }
+        if (isset($orderBy)) {
+            if (is_string($orderBy)) {
+                $qb->orderBy($orderBy);
+            } elseif (is_array($orderBy)) {
+                $key = key($orderBy);
+                $qb->orderBy($key, $orderBy[$key]);
+            }
+        } else {
+            $qb->orderBy('s.dateCreated');
+        }
+
+        return $qb->getQuery()->getResult();
+    }
+}
diff --git a/src/Repository/ShortUrlRepositoryInterface.php b/src/Repository/ShortUrlRepositoryInterface.php
new file mode 100644
index 00000000..37b013d9
--- /dev/null
+++ b/src/Repository/ShortUrlRepositoryInterface.php
@@ -0,0 +1,8 @@
+<?php
+namespace Acelaya\UrlShortener\Repository;
+
+use Doctrine\Common\Persistence\ObjectRepository;
+
+interface ShortUrlRepositoryInterface extends ObjectRepository, PaginableRepository
+{
+}
diff --git a/src/Service/ShortUrlService.php b/src/Service/ShortUrlService.php
index f6dc57fa..2ffc640c 100644
--- a/src/Service/ShortUrlService.php
+++ b/src/Service/ShortUrlService.php
@@ -4,6 +4,7 @@ namespace Acelaya\UrlShortener\Service;
 use Acelaya\UrlShortener\Entity\ShortUrl;
 use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
 use Doctrine\ORM\EntityManagerInterface;
+use Zend\Paginator\Paginator;
 
 class ShortUrlService implements ShortUrlServiceInterface
 {
@@ -24,7 +25,7 @@ class ShortUrlService implements ShortUrlServiceInterface
     }
 
     /**
-     * @return ShortUrl[]
+     * @return Paginator|ShortUrl[]
      */
     public function listShortUrls()
     {
diff --git a/src/Service/ShortUrlServiceInterface.php b/src/Service/ShortUrlServiceInterface.php
index 5a943ba0..9f0a219c 100644
--- a/src/Service/ShortUrlServiceInterface.php
+++ b/src/Service/ShortUrlServiceInterface.php
@@ -2,11 +2,12 @@
 namespace Acelaya\UrlShortener\Service;
 
 use Acelaya\UrlShortener\Entity\ShortUrl;
+use Zend\Paginator\Paginator;
 
 interface ShortUrlServiceInterface
 {
     /**
-     * @return ShortUrl[]
+     * @return Paginator|ShortUrl[]
      */
     public function listShortUrls();
 }
diff --git a/src/Service/VisitsTracker.php b/src/Service/VisitsTracker.php
index 4d091288..7fcdf5e6 100644
--- a/src/Service/VisitsTracker.php
+++ b/src/Service/VisitsTracker.php
@@ -7,6 +7,7 @@ use Acelaya\UrlShortener\Exception\InvalidArgumentException;
 use Acelaya\UrlShortener\Exception\InvalidShortCodeException;
 use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
 use Doctrine\ORM\EntityManagerInterface;
+use Zend\Paginator\Paginator;
 
 class VisitsTracker implements VisitsTrackerInterface
 {
@@ -65,7 +66,7 @@ class VisitsTracker implements VisitsTrackerInterface
      * Returns the visits on certain shortcode
      *
      * @param $shortCode
-     * @return Visit[]
+     * @return Paginator|Visit[]
      */
     public function info($shortCode)
     {
diff --git a/src/Service/VisitsTrackerInterface.php b/src/Service/VisitsTrackerInterface.php
index 0d524223..ce0a61cf 100644
--- a/src/Service/VisitsTrackerInterface.php
+++ b/src/Service/VisitsTrackerInterface.php
@@ -2,6 +2,7 @@
 namespace Acelaya\UrlShortener\Service;
 
 use Acelaya\UrlShortener\Entity\Visit;
+use Zend\Paginator\Paginator;
 
 interface VisitsTrackerInterface
 {
@@ -17,7 +18,7 @@ interface VisitsTrackerInterface
      * Returns the visits on certain shortcode
      *
      * @param $shortCode
-     * @return Visit[]
+     * @return Paginator|Visit[]
      */
     public function info($shortCode);
 }