Fixes API sorting and filtering. Closes #1489

app/Models/Component.php

@@ -12,6 +12,7 @@
 namespace CachetHQ\Cachet\Models;
 
 use AltThree\Validator\ValidatingTrait;
+use CachetHQ\Cachet\Models\Traits\SortableTrait;
 use CachetHQ\Cachet\Presenters\ComponentPresenter;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
@@ -20,7 +21,7 @@ use McCool\LaravelAutoPresenter\HasPresenter;
 
 class Component extends Model implements HasPresenter
 {
-    use SoftDeletes, ValidatingTrait;
+    use SoftDeletes, SortableTrait, ValidatingTrait;
 
     /**
      * List of attributes that have default values.
@@ -76,6 +77,20 @@ class Component extends Model implements HasPresenter
         'link'   => 'url',
     ];
 
+    /**
+     * The sortable fields.
+     *
+     * @var string[]
+     */
+    protected $sortable = [
+        'id',
+        'name',
+        'status',
+        'order',
+        'group_id',
+        'enabled',
+    ];
+
     /**
      * Components can belong to a group.
      *

app/Models/ComponentGroup.php

@@ -12,13 +12,14 @@
 namespace CachetHQ\Cachet\Models;
 
 use AltThree\Validator\ValidatingTrait;
+use CachetHQ\Cachet\Models\Traits\SortableTrait;
 use CachetHQ\Cachet\Presenters\ComponentGroupPresenter;
 use Illuminate\Database\Eloquent\Model;
 use McCool\LaravelAutoPresenter\HasPresenter;
 
 class ComponentGroup extends Model implements HasPresenter
 {
-    use ValidatingTrait;
+    use SortableTrait, ValidatingTrait;
 
     /**
      * The attributes that should be casted to native types.
@@ -49,6 +50,18 @@ class ComponentGroup extends Model implements HasPresenter
         'collapsed' => 'bool',
     ];
 
+    /**
+     * The sortable fields.
+     *
+     * @var string[]
+     */
+    protected $sortable = [
+        'id',
+        'name',
+        'order',
+        'collapsed',
+    ];
+
     /**
      * The relations to eager load on every query.
      *

app/Models/Incident.php

@@ -12,6 +12,7 @@
 namespace CachetHQ\Cachet\Models;
 
 use AltThree\Validator\ValidatingTrait;
+use CachetHQ\Cachet\Models\Traits\SortableTrait;
 use CachetHQ\Cachet\Presenters\IncidentPresenter;
 use Carbon\Carbon;
 use Illuminate\Database\Eloquent\Model;
@@ -20,7 +21,7 @@ use McCool\LaravelAutoPresenter\HasPresenter;
 
 class Incident extends Model implements HasPresenter
 {
-    use SoftDeletes, ValidatingTrait;
+    use SoftDeletes, SortableTrait, ValidatingTrait;
 
     /**
      * The attributes that should be casted to native types.
@@ -62,6 +63,19 @@ class Incident extends Model implements HasPresenter
         'message'      => 'required',
     ];
 
+    /**
+     * The sortable fields.
+     *
+     * @var string[]
+     */
+    protected $sortable = [
+        'id',
+        'name',
+        'status',
+        'visible',
+        'message',
+    ];
+
     /**
      * Finds all visible incidents.
      *

app/Models/Metric.php

@@ -12,13 +12,14 @@
 namespace CachetHQ\Cachet\Models;
 
 use AltThree\Validator\ValidatingTrait;
+use CachetHQ\Cachet\Models\Traits\SortableTrait;
 use CachetHQ\Cachet\Presenters\MetricPresenter;
 use Illuminate\Database\Eloquent\Model;
 use McCool\LaravelAutoPresenter\HasPresenter;
 
 class Metric extends Model implements HasPresenter
 {
-    use ValidatingTrait;
+    use SortableTrait, ValidatingTrait;
 
     /**
      * The calculation type of sum.
@@ -92,6 +93,19 @@ class Metric extends Model implements HasPresenter
         'default_view'  => 'numeric|between:0,3',
     ];
 
+    /**
+     * The sortable fields.
+     *
+     * @var string[]
+     */
+    protected $sortable = [
+        'id',
+        'name',
+        'display_chart',
+        'default_value',
+        'calc_type',
+    ];
+
     /**
      * Metrics contain many metric points.
      *

app/Models/Traits/SortableTrait.php

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of Cachet.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CachetHQ\Cachet\Models\Traits;
+
+use Illuminate\Database\Eloquent\Builder;
+
+/**
+ * This is the sortable trait.
+ *
+ * @author James Brooks <james@alt-three.com>
+ */
+trait SortableTrait
+{
+    /**
+     * Adds a sort scope.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $query
+     * @param string                                $column
+     * @param string                                $direction
+     *
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function scopeSort(Builder $query, $column, $direction)
+    {
+        if (!in_array($column, $this->sortable)) {
+            return $query;
+        }
+
+        return $query->orderBy($column, $direction);
+    }
+}