Add ability to sort by multiple fields (#21)

* Add ability to sort by multiple fields

Author: maxermolenko

src/Contracts/IRepository.php

@@ -112,7 +112,7 @@ public function getWhere(array $fieldValues): Collection;
      *
      * @param PagingInfo $paging Paging information
      * @param array $fieldValues Filters collection
-     * @param SortOptions|null $sortOptions How list of items should be sorted
+     * @param SortOptions|SortOptions[]|null $sortOptions How list of items should be sorted
      *
      * @return LengthAwarePaginator
      *
@@ -122,15 +122,15 @@ public function getWhere(array $fieldValues): Collection;
     public function getPage(
         PagingInfo $paging,
         array $fieldValues = [],
-        ?SortOptions $sortOptions = null
+        $sortOptions = null
     ): LengthAwarePaginator;
 
     /**
      * Get models collection as cursor.
      *
      * @param CursorRequest $cursor Request with cursor data
      * @param array $fieldValues Filters collection
-     * @param SortOptions|null $sortOptions How list of items should be sorted
+     * @param SortOptions|SortOptions[]|null $sortOptions How list of items should be sorted
      *
      * @return CursorResult
      *
@@ -139,7 +139,7 @@ public function getPage(
     public function getCursorPage(
         CursorRequest $cursor,
         array $fieldValues = [],
-        ?SortOptions $sortOptions = null
+        $sortOptions = null
     ): CursorResult;
 
     /**
@@ -148,7 +148,7 @@ public function getCursorPage(
      * @param array $with Which relations should be preloaded
      * @param array $withCounts Which related entities should be counted
      * @param array $fieldValues Conditions that retrieved entities should satisfy
-     * @param SortOptions|null $sortOptions How list of items should be sorted
+     * @param SortOptions|SortOptions[]|null $sortOptions How list of items should be sorted
      *
      * @return Collection|Model[]
      *
@@ -158,7 +158,7 @@ public function getWith(
         array $with,
         array $withCounts = [],
         array $fieldValues = [],
-        ?SortOptions $sortOptions = null
+        $sortOptions = null
     ): Collection;
 
     /**

src/Repositories/Repository.php

@@ -188,17 +188,37 @@ public function get(): Collection
     {
         return $this->query()->get();
     }
+    
+    /**
+     * Apply order to query by sort options.
+     *
+     * @param Builder $query Query builder
+     * @param SortOptions|SortOptions[] $sortOptions How list of items should be sorted
+     *
+     * @return Builder
+     */
+    private function applyOrderBy(Builder $query, $sortOptions): Builder
+    {
+        if ($sortOptions instanceof SortOptions) {
+            $query->orderBy($sortOptions->orderBy, $sortOptions->sortOrder);
+        } elseif (is_array($sortOptions)) {
+            foreach ($sortOptions as $sortOption) {
+                $query->orderBy($sortOption->orderBy, $sortOption->sortOrder);
+            }
+        }
+        return $query;
+    }
 
     /** {@inheritdoc} */
     public function getPage(
         PagingInfo $paging,
         array $fieldValues = [],
-        ?SortOptions $sortOptions = null
+        $sortOptions = null
     ): LengthAwarePaginator {
         $builder = $this
             ->query()
             ->when($sortOptions, function (Builder $query) use ($sortOptions) {
-                return $query->orderBy($sortOptions->orderBy, $sortOptions->sortOrder);
+                return $this->applyOrderBy($query, $sortOptions);
             });
         $builder->addNestedWhereQuery($this->getNestedWhereConditions($builder->getQuery(), $fieldValues));
 
@@ -209,12 +229,12 @@ public function getPage(
     public function getCursorPage(
         CursorRequest $cursor,
         array $fieldValues = [],
-        ?SortOptions $sortOptions = null
+        $sortOptions = null
     ): CursorResult {
         $builder = $this
             ->query()
             ->when($sortOptions, function (Builder $query) use ($sortOptions) {
-                return $query->orderBy($sortOptions->orderBy, $sortOptions->sortOrder);
+                return $this->applyOrderBy($query, $sortOptions);
             });
         $builder->addNestedWhereQuery($this->getNestedWhereConditions($builder->getQuery(), $fieldValues));
 
@@ -337,7 +357,7 @@ private function performJoin($query, string $table, string $foreign, string $oth
      * @param array $with Which relations should be preloaded
      * @param array|null $withCounts Which related entities should be counted
      * @param array|null $where Conditions that retrieved entities should satisfy
-     * @param SortOptions|null $sortOptions How list of item should be sorted
+     * @param SortOptions|SortOptions[]|null $sortOptions How list of item should be sorted
      *
      * @return Builder
      *
@@ -347,7 +367,7 @@ protected function getWithBuilder(
         array $with,
         ?array $withCounts = null,
         ?array $where = null,
-        ?SortOptions $sortOptions = null
+        $sortOptions = null
     ): Builder {
         return $this->query()
             ->when($with, function (Builder $query) use ($with) {
@@ -360,7 +380,7 @@ protected function getWithBuilder(
                 return $query->where($where);
             })
             ->when($sortOptions, function (Builder $query) use ($sortOptions) {
-                return $query->orderBy($sortOptions->orderBy, $sortOptions->sortOrder);
+                return $this->applyOrderBy($query, $sortOptions);
             });
     }
 
@@ -390,15 +410,15 @@ public function getWith(
         array $with,
         ?array $withCounts = null,
         ?array $where = null,
-        ?SortOptions $sortOptions = null
+        $sortOptions = null
     ): Collection {
         $builder = $this->query()
             ->with($with)
             ->when($withCounts, function (Builder $query) use ($withCounts) {
                 return $query->withCount($withCounts);
             })
             ->when($sortOptions, function (Builder $query) use ($sortOptions) {
-                return $query->orderBy($sortOptions->orderBy, $sortOptions->sortOrder);
+                return $this->applyOrderBy($query, $sortOptions);
             });
 
         if ($where) {