Maintenance – Added order by in search function

src/Resource/AbstractResource.php

@@ -383,11 +383,13 @@ private function allWithoutPagination()
      * @param string  $search_term          Search term.
      * @param integer $page                 Page of objects, optional, if given, $objects_per_page must also be given.
      * @param integer $objects_per_page     Number of objects per page, optional, if given, $page must also be given.
+     * @param string  $sort_by              Sort by field name, optional (e.g. 'created_at', 'title', 'number').
+     * @param string  $order_by             Sort order, optional, must be 'asc' or 'desc'.
      *
      * @return mixed                        Returns array of ZammadAPIClient\Resource\... objects
      *                                          or this object on failure.
      */
-    public function search( $search_term, $page = null, $objects_per_page = null )
+    public function search( $search_term, $page = null, $objects_per_page = null, $sort_by = null, $order_by = null )
     {
         if ( !empty( $this->getValues() ) ) {
             throw new AlreadyFetchedObjectException('Object already contains values, search() not possible, use a new object');
@@ -406,8 +408,12 @@ public function search( $search_term, $page = null, $objects_per_page = null )
             throw new \RuntimeException('Parameters page and objects_per_page must both be given');
         }
 
+        if ( isset($order_by) && !in_array( mb_strtolower($order_by), [ 'asc', 'desc' ] ) ) {
+            throw new \RuntimeException('Parameter order_by must be "asc" or "desc"');
+        }
+
         if ( !isset($page) || !isset($objects_per_page) ) {
-            return $this->searchWithoutPagination($search_term);
+            return $this->searchWithoutPagination($search_term, $sort_by, $order_by);
         }
 
         $url_parameters = [
@@ -420,6 +426,13 @@ public function search( $search_term, $page = null, $objects_per_page = null )
             $url_parameters['per_page'] = $objects_per_page;
         }
 
+        if ( isset($sort_by) ) {
+            $url_parameters['sort_by'] = $sort_by;
+        }
+        if ( isset($order_by) ) {
+            $url_parameters['order_by'] = $order_by;
+        }
+
         $url      = $this->getURL('search');
         $response = $this->getClient()->get(
             $url,
@@ -450,18 +463,22 @@ public function search( $search_term, $page = null, $objects_per_page = null )
      * This method will be used internally and automatically by search() to automate pagination
      * to retrieve all available objects, ignoring the server side limit of fetchable objects.
      *
+     * @param string $search_term          Search term.
+     * @param string $sort_by              Sort by field name, optional.
+     * @param string $order_by             Sort order, optional.
+     *
      * @return mixed                        Returns array of ZammadAPIClient\Resource\... objects
      *                                          or this object on failure.
      */
-    private function searchWithoutPagination($search_term)
+    private function searchWithoutPagination($search_term, $sort_by = null, $order_by = null)
     {
         $page             = 1;
         $objects_per_page = 100;
         $objects          = [];
         $objects_of_page  = [];
 
         do {
-            $objects_of_page = $this->search( $search_term, $page, $objects_per_page );
+            $objects_of_page = $this->search( $search_term, $page, $objects_per_page, $sort_by, $order_by );
             if ( !is_array($objects_of_page) ) {
                 return $this;
             }

src/Resource/Tag.php

@@ -101,7 +101,7 @@ public function add($object_id, $tag, $object_type = 'Ticket')
      * @return mixed                        Returns array of ZammadAPIClient\Resource\... objects
      *                                          or this object on failure.
      */
-    public function search($search_term, $page = null, $objects_per_page = null)
+    public function search($search_term, $page = null, $objects_per_page = null, $sort_by = null, $order_by = null)
     {
         $this->clearError();