Added trait to help with checking allowed values

rikbruil · Mar 17, 2017 · ebaa30f · ebaa30f
1 parent 5404c39
commit ebaa30f
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 48 deletions.
diff --git a/src/Helper/TypeCheckerTrait.php b/src/Helper/TypeCheckerTrait.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace Rb\Specification\Doctrine\Helper;
+
+use Rb\Specification\Doctrine\Exception\InvalidArgumentException;
+
+trait TypeCheckerTrait
+{
+    /**
+     * @var string[]
+     */
+    protected $validTypes;
+
+    /**
+     * @var string
+     */
+    private $type;
+
+    /**
+     * @param string $type
+     *
+     * @throws InvalidArgumentException
+     */
+    public function setType($type)
+    {
+        if (! in_array($type, $this->validTypes, true)) {
+            throw new InvalidArgumentException(sprintf(
+                '"%s" is not a valid type! Valid types: %s',
+                $type,
+                implode(', ', $this->validTypes)
+            ));
+        }
+
+        $this->type = $type;
+    }
+}
diff --git a/src/Query/GroupBy.php b/src/Query/GroupBy.php
@@ -4,21 +4,20 @@
 
 use Doctrine\ORM\QueryBuilder;
 use Rb\Specification\Doctrine\AbstractSpecification;
-use Rb\Specification\Doctrine\Exception\InvalidArgumentException;
+use Rb\Specification\Doctrine\Helper\TypeCheckerTrait;
 
 /**
  * @author  Kyle Tucker <kyleatucker@gmail.com>
  */
 class GroupBy extends AbstractSpecification
 {
+    use TypeCheckerTrait;
+
     const GROUP_BY     = 'groupBy';
     const ADD_GROUP_BY = 'addGroupBy';
 
     /** @var string[] */
-    protected static $types = [self::GROUP_BY, self::ADD_GROUP_BY];
-
-    /** @var string */
-    protected $type;
+    protected $validTypes = [self::GROUP_BY, self::ADD_GROUP_BY];
 
     /**
      * Constructor.
@@ -45,22 +44,4 @@ public function modify(QueryBuilder $queryBuilder, $dqlAlias)
             ]
         );
     }
-
-    /**
-     * @param string $type
-     *
-     * @throws InvalidArgumentException
-     */
-    public function setType($type)
-    {
-        if (! in_array($type, self::$types, true)) {
-            throw new InvalidArgumentException(sprintf(
-                '"%s" is not a valid type! Valid types: %s',
-                $type,
-                implode(', ', self::$types)
-            ));
-        }
-
-        $this->type = $type;
-    }
 }
diff --git a/src/Query/Select.php b/src/Query/Select.php
@@ -3,29 +3,26 @@
 namespace Rb\Specification\Doctrine\Query;
 
 use Doctrine\ORM\QueryBuilder;
-use Rb\Specification\Doctrine\Exception\InvalidArgumentException;
+use Rb\Specification\Doctrine\Helper\TypeCheckerTrait;
 use Rb\Specification\Doctrine\SpecificationInterface;
 
 /**
  * Select will modify the query-builder so you can specify SELECT-statements.
  */
 class Select implements SpecificationInterface
 {
+    use TypeCheckerTrait;
+
     const SELECT     = 'select';
     const ADD_SELECT = 'addSelect';
 
-    protected static $types = [self::SELECT, self::ADD_SELECT];
+    protected $validTypes = [self::SELECT, self::ADD_SELECT];
 
     /**
      * @var string|array
      */
     protected $select;
 
-    /**
-     * @var string
-     */
-    protected $type;
-
     /**
      * @param string|array $select
      * @param string       $type
@@ -44,24 +41,6 @@ public function modify(QueryBuilder $queryBuilder, $dqlAlias)
         call_user_func_array([$queryBuilder, $this->type], [$this->select]);
     }
 
-    /**
-     * @param string $type
-     *
-     * @throws InvalidArgumentException
-     */
-    public function setType($type)
-    {
-        if (! in_array($type, self::$types, true)) {
-            throw new InvalidArgumentException(sprintf(
-                '"%s" is not a valid type! Valid types: %s',
-                $type,
-                implode(', ', self::$types)
-            ));
-        }
-
-        $this->type = $type;
-    }
-
     /**
      * {@inheritdoc}
      */