Add ability to pass sort options into page and cursor methods

Author: Eugene

src/Contracts/IRepository.php

@@ -112,25 +112,35 @@ 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
      *
      * @return LengthAwarePaginator
      *
      * @throws BadCriteriaException
      * @throws InvalidArgumentException
      */
-    public function getPage(PagingInfo $paging, array $fieldValues = []): LengthAwarePaginator;
+    public function getPage(
+        PagingInfo $paging,
+        array $fieldValues = [],
+        ?SortOptions $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
      *
      * @return CursorResult
      *
      * @throws BadCriteriaException
      */
-    public function getCursorPage(CursorRequest $cursor, array $fieldValues = []): CursorResult;
+    public function getCursorPage(
+        CursorRequest $cursor,
+        array $fieldValues = [],
+        ?SortOptions $sortOptions = null
+    ): CursorResult;
 
     /**
      * Retrieve list of entities that satisfied requested conditions.

src/Repositories/Repository.php

@@ -188,18 +188,32 @@ public function get(): Collection
     }
 
     /** {@inheritdoc} */
-    public function getPage(PagingInfo $paging, array $fieldValues = []): LengthAwarePaginator
-    {
-        $builder = $this->query();
+    public function getPage(
+        PagingInfo $paging,
+        array $fieldValues = [],
+        ?SortOptions $sortOptions = null
+    ): LengthAwarePaginator {
+        $builder = $this
+            ->query()
+            ->when($sortOptions, function (Builder $query) use ($sortOptions) {
+                return $query->orderBy($sortOptions->orderBy, $sortOptions->sortOrder);
+            });
         $builder->addNestedWhereQuery($this->getNestedWhereConditions($builder->getQuery(), $fieldValues));
 
         return $builder->paginate($paging->pageSize, ['*'], 'page', $paging->page);
     }
 
     /** {@inheritdoc} */
-    public function getCursorPage(CursorRequest $cursor, array $fieldValues = []): CursorResult
-    {
-        $builder = $this->query();
+    public function getCursorPage(
+        CursorRequest $cursor,
+        array $fieldValues = [],
+        ?SortOptions $sortOptions = null
+    ): CursorResult {
+        $builder = $this
+            ->query()
+            ->when($sortOptions, function (Builder $query) use ($sortOptions) {
+                return $query->orderBy($sortOptions->orderBy, $sortOptions->sortOrder);
+            });
         $builder->addNestedWhereQuery($this->getNestedWhereConditions($builder->getQuery(), $fieldValues));
 
         return $this->toCursorResult($cursor, $builder);