Minor formatting changes to code

Author: Adam Hutchison

src/BuilderScopes/AbstractBuilderScope.php

@@ -4,6 +4,7 @@
 
 use Netsells\GeoScope\ScopeDriverFactory;
 use Netsells\GeoScope\Exceptions\InvalidOrderDirectionParameter;
+use Netsells\GeoScope\Exceptions\InvalidDistanceFieldNameException;
 
 abstract class AbstractBuilderScope
 {
@@ -62,7 +63,7 @@ public function orderByDistanceFrom(float $lat, float $long, string $orderDirect
     }
 
      /**
-     * @throws InvalidOrderDirectionParameter
+     * @throws InvalidDistanceFieldNameException
      * @return mixed
      */
     public function addDistanceFromField(float $lat, float $long, string $fieldName = null)

src/Config/ConfigSanitizer.php

@@ -30,7 +30,7 @@ public function getSanitizedConfig(array $config, string $table)
         $this->validateLatLongFields($config, $table);
         $this->validateDistanceUnitsField($config);
         $this->validateScopeDriverField($config);
-
+        
         foreach ($config as $configField => $configItem) {
             if (!in_array($configField, self::VALID_CONFIG_FIELDS)) {
                 unset($config[$configField]);

src/Config/ConfigStateMachine.php

@@ -4,13 +4,13 @@
 
 class ConfigStateMachine
 {
-    const CONFIG_FIELD_LATITUDE_COLUMN = 'lat-column';
-    const CONFIG_FIELD_LONGITUDE_COLUMN = 'long-column';
-    const CONFIG_FIELD_DISTANCE_UNITS = 'units';
-    const CONFIG_FIELD_SCOPE_DRIVER = 'scope-driver';
-    const CONFIG_FIELD_VALID_DISTANCE_FILED_NAMES = 'whitelisted-distance-from-field-names';
+    protected const CONFIG_FIELD_LATITUDE_COLUMN = 'lat-column';
+    protected const CONFIG_FIELD_LONGITUDE_COLUMN = 'long-column';
+    protected const CONFIG_FIELD_DISTANCE_UNITS = 'units';
+    protected const CONFIG_FIELD_SCOPE_DRIVER = 'scope-driver';
+    protected const CONFIG_FIELD_VALID_DISTANCE_FILED_NAMES = 'whitelisted-distance-from-field-names';
 
-    const VALID_CONFIG_FIELDS = [
+    protected const VALID_CONFIG_FIELDS = [
         self::CONFIG_FIELD_LATITUDE_COLUMN,
         self::CONFIG_FIELD_LONGITUDE_COLUMN,
         self::CONFIG_FIELD_DISTANCE_UNITS,

src/Config/Managers/AbstractConfigManager.php

@@ -7,13 +7,13 @@
 
 abstract class AbstractConfigManager implements ConfigManagerInterface
 {
-    const CONFIG_FIELD_LATITUDE_COLUMN = 'lat-column';
-    const CONFIG_FIELD_LONGITUDE_COLUMN = 'long-column';
-    const CONFIG_FIELD_DISTANCE_UNITS = 'units';
-    const CONFIG_FIELD_SCOPE_DRIVER = 'scope-driver';
-    const CONFIG_FIELD_WHITELISTED_DISTANCE_FIELD_NAMES = 'whitelisted-distance-from-field-names';
+    public const CONFIG_FIELD_LATITUDE_COLUMN = 'lat-column';
+    public const CONFIG_FIELD_LONGITUDE_COLUMN = 'long-column';
+    public const CONFIG_FIELD_DISTANCE_UNITS = 'units';
+    public const CONFIG_FIELD_SCOPE_DRIVER = 'scope-driver';
+    public const CONFIG_FIELD_WHITELISTED_DISTANCE_FIELD_NAMES = 'whitelisted-distance-from-field-names';
 
-    const OPTIONAL_CONFIG_FIELDS = [
+    public const OPTIONAL_CONFIG_FIELDS = [
         'scope-driver'
     ];
 
@@ -24,7 +24,9 @@ public function __construct(string $table)
     {
         $this->table = $table;
         $this->config = config('geoscope.defaults');
-        $this->config[self::CONFIG_FIELD_WHITELISTED_DISTANCE_FIELD_NAMES] = config('geoscope.' . self::CONFIG_FIELD_WHITELISTED_DISTANCE_FIELD_NAMES);
+        $this->config[self::CONFIG_FIELD_WHITELISTED_DISTANCE_FIELD_NAMES] = config(
+            'geoscope.' . self::CONFIG_FIELD_WHITELISTED_DISTANCE_FIELD_NAMES
+        );
     }
 
     /**

src/ScopeDrivers/MySQLScopeDriver.php

@@ -2,7 +2,6 @@
 
 namespace Netsells\GeoScope\ScopeDrivers;
 
-use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Support\Facades\DB;
 
 final class MySQLScopeDriver extends AbstractScopeDriver
@@ -11,6 +10,7 @@ final class MySQLScopeDriver extends AbstractScopeDriver
      * @param float $lat
      * @param float $long
      * @param float $distance
+     * @return mixed
      */
     public function withinDistanceOf(float $lat, float $long, float $distance)
     {
@@ -25,6 +25,7 @@ public function withinDistanceOf(float $lat, float $long, float $distance)
      * @param float $lat
      * @param float $long
      * @param float $distance
+     * @return mixed
      */
     public function orWithinDistanceOf(float $lat, float $long, float $distance)
     {
@@ -40,6 +41,7 @@ public function orWithinDistanceOf(float $lat, float $long, float $distance)
      * @param float $lat
      * @param float $long
      * @param float $orderDirection
+     * @return mixed
      */
     public function orderByDistanceFrom(float $lat, float $long, string $orderDirection = 'asc')
     {
@@ -55,6 +57,7 @@ public function orderByDistanceFrom(float $lat, float $long, string $orderDirect
      * @param float $lat
      * @param float $long
      * @param float $orderDirection
+     * @return mixed
      */
     public function addDistanceFromField(float $lat, float $long, ?string $fieldName = null)
     {

src/ScopeDrivers/PostgreSQLScopeDriver.php

@@ -2,14 +2,13 @@
 
 namespace Netsells\GeoScope\ScopeDrivers;
 
-use Illuminate\Database\Eloquent\Builder;
-
 final class PostgreSQLScopeDriver extends AbstractScopeDriver
 {
     /**
      * @param float $lat
      * @param float $long
      * @param float $distance
+     * @return mixed
      */
     public function withinDistanceOf(float $lat, float $long, float $distance)
     {
@@ -24,6 +23,7 @@ public function withinDistanceOf(float $lat, float $long, float $distance)
      * @param float $lat
      * @param float $long
      * @param float $distance
+     * @return mixed
      */
     public function orWithinDistanceOf(float $lat, float $long, float $distance)
     {
@@ -39,6 +39,7 @@ public function orWithinDistanceOf(float $lat, float $long, float $distance)
      * @param float $lat
      * @param float $long
      * @param float $orderDirection
+     * @return mixed
      */
     public function orderByDistanceFrom(float $lat, float $long, string $orderDirection = 'asc')
     {
@@ -54,6 +55,7 @@ public function orderByDistanceFrom(float $lat, float $long, string $orderDirect
      * @param float $lat
      * @param float $long
      * @param string $fieldName
+     * @return mixed
      */
     public function addDistanceFromField(float $lat, float $long, ?string $fieldName = null)
     {

src/ScopeDrivers/SQLServerScopeDriver.php

@@ -2,14 +2,13 @@
 
 namespace Netsells\GeoScope\ScopeDrivers;
 
-use Illuminate\Database\Eloquent\Builder;
-
 final class SQLServerScopeDriver extends AbstractScopeDriver
 {
     /**
      * @param float $lat
      * @param float $long
      * @param float $distance
+     * @return mixed
      */
     public function withinDistanceOf(float $lat, float $long, float $distance)
     {
@@ -24,6 +23,7 @@ public function withinDistanceOf(float $lat, float $long, float $distance)
      * @param float $lat
      * @param float $long
      * @param float $distance
+     * @return mixed
      */
     public function orWithinDistanceOf(float $lat, float $long, float $distance)
     {
@@ -39,6 +39,7 @@ public function orWithinDistanceOf(float $lat, float $long, float $distance)
      * @param float $lat
      * @param float $long
      * @param float $orderDirection
+     * @return mixed
      */
     public function orderByDistanceFrom(float $lat, float $long, string $orderDirection = 'asc')
     {
@@ -54,6 +55,7 @@ public function orderByDistanceFrom(float $lat, float $long, string $orderDirect
      * @param float $lat
      * @param float $long
      * @param string $fieldName
+     * @return mixed
      */
     public function addDistanceFromField(float $lat, float $long, ?string $fieldName = null)
     {

src/Traits/GeoScopeTrait.php

@@ -3,8 +3,9 @@
 namespace Netsells\GeoScope\Traits;
 
 use Illuminate\Database\Eloquent\Builder;
-use Netsells\GeoScope\BuilderScopes\EloquentBuilderScope;
 use Netsells\GeoScope\Exceptions\InvalidConfigException;
+use Netsells\GeoScope\BuilderScopes\EloquentBuilderScope;
+use Netsells\GeoScope\Exceptions\InvalidDistanceFieldNameException;
 
 trait GeoScopeTrait
 {
@@ -53,12 +54,12 @@ public function scopeOrWithinDistanceOf(
     }
 
     /**
+     * @throws InvalidOrderDirectionParameter
      * @param Builder $query
      * @param float $lat
      * @param float $long
      * @param float $orderDirection
      * @return mixed
-     * @throws InvalidOrderDirectionParameter
      */
     public function scopeOrderByDistanceFrom(
         Builder $query,
@@ -72,6 +73,7 @@ public function scopeOrderByDistanceFrom(
     }
 
     /**
+     * @throws InvalidDistanceFieldNameException
      * @param Builder $query
      * @param float $lat
      * @param float $long

src/Validators/UnitsFieldValidator.php

@@ -15,7 +15,7 @@ public function validate(string $field): void
     {
         $validUnitKeys = array_keys(AbstractBuilderScope::DISTANCE_CONVERSION_FROM_METERS);
 
-        if(!in_array($field, $validUnitKeys)){
+        if (!in_array($field, $validUnitKeys)) {
             throw new InvalidConfigException("{$field} is not a valid distance unit key");
         }
     }