Repository cleanup #40 (#41)

* added base classes for repositories and queries #40
* prepared controller and repositories to use fetchByQuery() #40
* removed findAll() which has added pagination to the original doctrine method #40

src/AppBundle/Repository/AbstractRepository.php

@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the Kimai package.
+ *
+ * (c) Kevin Papst <kevin@kevinpapst.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace AppBundle\Repository;
+
+use AppBundle\Entity\User;
+use TimesheetBundle\Entity\Activity;
+use TimesheetBundle\Entity\Timesheet;
+use Doctrine\ORM\EntityRepository;
+use Doctrine\ORM\Query;
+use Pagerfanta\Adapter\DoctrineORMAdapter;
+use Pagerfanta\Pagerfanta;
+use TimesheetBundle\Model\ActivityStatistic;
+
+/**
+ * Class AbstractRepository
+ *
+ * @author Kevin Papst <kevin@kevinpapst.de>
+ */
+abstract class AbstractRepository extends EntityRepository
+{
+
+    /**
+     * @param Query $query
+     * @param int $page
+     * @param int $maxPerPage
+     * @return Pagerfanta
+     */
+    protected function getPager(Query $query, $page = 1, $maxPerPage = 25)
+    {
+        $paginator = new Pagerfanta(new DoctrineORMAdapter($query, false));
+        $paginator->setMaxPerPage($maxPerPage);
+        $paginator->setCurrentPage($page);
+
+        return $paginator;
+    }
+}

src/AppBundle/Repository/Query/BaseQuery.php

@@ -0,0 +1,119 @@
+<?php
+
+/*
+ * This file is part of the Kimai package.
+ *
+ * (c) Kevin Papst <kevin@kevinpapst.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace AppBundle\Repository\Query;
+
+/**
+ * Base class for advanced Repository queries.
+ *
+ * @author Kevin Papst <kevin@kevinpapst.de>
+ */
+class BaseQuery
+{
+
+    const DEFAULT_PAGESIZE = 25;
+    const DEFAULT_PAGE = 1;
+
+    /**
+     * @var int
+     */
+    protected $page = self::DEFAULT_PAGE;
+    /**
+     * @var int
+     */
+    protected $pageSize = self::DEFAULT_PAGESIZE;
+    /**
+     * @var string
+     */
+    protected $orderBy = 'id';
+    /**
+     * @var string
+     */
+    protected $order = 'ASC';
+
+    /**
+     * @return int
+     */
+    public function getPage()
+    {
+        return $this->page;
+    }
+
+    /**
+     * @param int $page
+     * @return BaseQuery
+     */
+    public function setPage($page)
+    {
+        $this->page = $page;
+        return $this;
+    }
+
+    /**
+     * @return int
+     */
+    public function getPageSize()
+    {
+        return $this->pageSize;
+    }
+
+    /**
+     * @param int $pageSize
+     * @return BaseQuery
+     */
+    public function setPageSize($pageSize)
+    {
+        if (!empty($pageSize) && (int)$pageSize > 0) {
+            $this->pageSize = (int)$pageSize;
+        }
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getOrderBy()
+    {
+        return $this->orderBy;
+    }
+
+    /**
+     * You need to validate carefully if this value is used from a user-input.
+     *
+     * @param string $orderBy
+     * @return BaseQuery
+     */
+    public function setOrderBy($orderBy)
+    {
+        $this->orderBy = $orderBy;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getOrder()
+    {
+        return $this->order;
+    }
+
+    /**
+     * @param string $order
+     * @return BaseQuery
+     */
+    public function setOrder($order)
+    {
+        if (in_array($order, ['ASC', 'DESC'])) {
+            $this->order = $order;
+        }
+        return $this;
+    }
+}

src/AppBundle/Repository/Query/UserQuery.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Kimai package.
+ *
+ * (c) Kevin Papst <kevin@kevinpapst.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace AppBundle\Repository\Query;
+
+/**
+ * Can be used for advanced queries with the: UserRepository
+ *
+ * @author Kevin Papst <kevin@kevinpapst.de>
+ */
+class UserQuery extends BaseQuery implements VisibilityInterface
+{
+    use VisibilityTrait;
+}

src/AppBundle/Repository/Query/VisibilityInterface.php

@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Kimai package.
+ *
+ * (c) Kevin Papst <kevin@kevinpapst.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace AppBundle\Repository\Query;
+
+/**
+ * Can be used for advanced queries with the: UserRepository
+ *
+ * @author Kevin Papst <kevin@kevinpapst.de>
+ */
+interface VisibilityInterface
+{
+    const SHOW_VISIBLE = 1;
+    const SHOW_HIDDEN = 0;
+    const SHOW_BOTH = 2;
+}

src/AppBundle/Repository/Query/VisibilityTrait.php

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Kimai package.
+ *
+ * (c) Kevin Papst <kevin@kevinpapst.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace AppBundle\Repository\Query;
+
+/**
+ * Can be used for advanced queries with the: UserRepository
+ *
+ * @author Kevin Papst <kevin@kevinpapst.de>
+ */
+trait VisibilityTrait
+{
+    protected $visibility = self::SHOW_VISIBLE;
+
+    /**
+     * @return int
+     */
+    public function getVisibility()
+    {
+        return $this->visibility;
+    }
+
+    /**
+     * @param int $visibility
+     * @return ProjectQuery
+     */
+    public function setVisibility($visibility)
+    {
+        $this->visibility = $visibility;
+        return $this;
+    }
+}

src/AppBundle/Repository/UserRepository.php

@@ -12,17 +12,14 @@
 namespace AppBundle\Repository;
 
 use AppBundle\Model\UserStatistic;
-use Doctrine\ORM\Query;
-use Doctrine\ORM\EntityRepository;
-use Pagerfanta\Adapter\DoctrineORMAdapter;
-use Pagerfanta\Pagerfanta;
+use AppBundle\Repository\Query\UserQuery;
 
 /**
  * Class UserRepository
  *
  * @author Kevin Papst <kevin@kevinpapst.de>
  */
-class UserRepository extends EntityRepository
+class UserRepository extends AbstractRepository
 {
 
     /**
@@ -42,46 +39,30 @@ class UserRepository extends EntityRepository
         return $stats;
     }
 
-    /**
-     * @return Query
-     */
-    protected function queryAll()
-    {
-        $qb = $this->getEntityManager()->createQueryBuilder();
-
-        $qb->select('u')
-            ->from('AppBundle:User', 'u')
-            ->orderBy('u.id', 'ASC');
-
-        return $qb->getQuery();
-    }
-
     public function findByUsername($username)
     {
         return $this->findOneBy(['username' => $username]);
     }
 
     /**
-     * @param int $page
-     *
-     * @return Pagerfanta
+     * @param UserQuery $query
+     * @return \Pagerfanta\Pagerfanta
      */
-    public function findAll($page = 1)
+    public function findByQuery(UserQuery $query)
     {
-        return $this->getPager($this->queryAll(), $page);
-    }
+        $qb = $this->getEntityManager()->createQueryBuilder();
 
-    /**
-     * @param Query $query
-     * @param int $page
-     * @return Pagerfanta
-     */
-    protected function getPager(Query $query, $page = 1)
-    {
-        $paginator = new Pagerfanta(new DoctrineORMAdapter($query, false));
-        $paginator->setMaxPerPage(25);
-        $paginator->setCurrentPage($page);
+        // if we join activities, the maxperpage limit will limit the list to the amount or projects + activties
+        $qb->select('u')
+            ->from('AppBundle:User', 'u')
+            ->orderBy('u.' . $query->getOrderBy(), $query->getOrder());
 
-        return $paginator;
+        if ($query->getVisibility() === UserQuery::SHOW_VISIBLE) {
+            $qb->andWhere('u.visible = 1');
+        } elseif ($query->getVisibility() === UserQuery::SHOW_HIDDEN) {
+            $qb->andWhere('u.visible = 0');
+        }
+
+        return $this->getPager($qb->getQuery(), $query->getPage(), $query->getPageSize());
     }
 }