Adds method to check order by direction

Author: Adam Hutchison

src/Exceptions/InvalidOrderDirectionParameter.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Netsells\GeoScope\Exceptions;
+
+class InvalidOrderDirectionParameter extends \Exception
+{
+
+}

src/Interfaces/ScopeDriverInterface.php

@@ -21,4 +21,13 @@ public function withinDistanceOf(float $lat, float $long, float $distance);
      * Should return query instance
      */
     public function orWithinDistanceOf(float $lat, float $long, float $distance);
+
+    /**
+     * @param float $lat
+     * @param float $long
+     * @param string $orderDirection - asc or desc
+     * @return mixed
+     * Should return query instance
+     */
+    public function orderByDistanceFrom(float $lat, float $long, string $orderDirection = 'asc');
 }

src/ScopeDrivers/AbstractScopeDriver.php

@@ -2,10 +2,13 @@
 
 namespace Netsells\GeoScope\ScopeDrivers;
 
+use Netsells\GeoScope\Exceptions\InvalidOrderDirectionParameter;
 use Netsells\GeoScope\Interfaces\ScopeDriverInterface;
 
 abstract class AbstractScopeDriver implements ScopeDriverInterface
 {
+    protected const ALLOWED_ORDER_DIRECTION_IDENTIFIERS = ['asc', 'desc'];
+
     protected $config;
     protected $query;
     protected $conversion;
@@ -38,4 +41,15 @@ public function setQuery($query): AbstractScopeDriver
         $this->query = $query;
         return $this;
     }
+
+    /**
+     * @throws InvalidOrderDirectionParameter
+     * @return void
+     */
+    protected function checkOrderDirectionIdentifier(string $orderDirection): void
+    {
+        if (!in_array($orderDirection, $this->ALLOWED_ORDER_DIRECTION_IDENTIFIERS)) {
+            throw new InvalidOrderDirectionParameter("{$orderDirection} is not a valid order direction");
+        }
+    }
 }

src/ScopeDrivers/MySQLScopeDriver.php

@@ -32,6 +32,16 @@ public function orWithinDistanceOf(float $lat, float $long, float $distance)
         ]);
     }
 
+    /**
+     * @param float $lat
+     * @param float $long
+     * @param float $orderDirection
+     */
+    public function orderByDistanceFrom(float $lat, float $long, string $orderDirection = 'asc')
+    {
+        return $this->query;
+    }
+
     /**
      * @return string
      */