✨ Added Query Class to build query for request

Author: Artem Shteltser

src/PowerLink.php

@@ -127,12 +127,13 @@ private function request(string $method, string $path, array $params)
 
     /**
      * Query request
-     * @param array $params 
+     * @param Query $query_object 
      * 
      * @return object
      */
-    public function query(array $params)
+    public function query(Query $query_object)
     {
+        $params = $query_object->getParams();
         return $this->request("POST", "query", $params);
     }
 

src/Query.php

@@ -2,12 +2,21 @@
 
 namespace PowerLink;
 
+use PowerLink\QuerySyntax\OrderBy;
+use PowerLink\QuerySyntax\Where;
+
 /**
  * Class defining a query request in PowerLink with methods to set
  * query settings
  */
 class Query
 {
+    /**
+     * SQL query for selecting ites 
+     * @var string
+     */
+    protected $query = '';
+
     /**
      * Object Type 
      * @var string
@@ -16,37 +25,120 @@ class Query
 
     /**
      * Number of items returned per page 
-     * @var string
+     * @var int
      */
-    protected $page_size;
+    protected $page_size = 50;
 
     /**
      * Number of requested page 
-     * @var string
+     * @var int
      */
-    protected $page_number;
+    protected $page_number = 1;
 
     /**
      * Array of requested fields 
-     * @var array
+     * @var array|null
      */
-    protected $fields;
+    protected $fields = null;
 
     /**
-     * SQL query for selecting ites 
-     * @var string
+     * Order By object 
+     * @var OrderBy
      */
-    protected $query;
+    protected $order_by;
 
     /**
-     * Name of field to sort by 
-     * @var string
+     * Set object type
+     * @param int $object_type Object Type
      */
-    protected $sort_by;
+    public function setObjectType(int $object_type)
+    {
+        $this->object_type = $object_type;
+    }
 
     /**
-     * Name of field to sort by 
-     * @var ASC|DESC
+     * Set object type
+     * @param string $field Field name
+     * @param OrderBy::ASC|OrderBy::DESC|string $sort_by Field name
      */
-    protected $sort_type;
+    public function setOrderBy(string $field, string $sort_by)
+    {
+        $this->order_by = new OrderBy($field, $sort_by);
+    }
+
+    /**
+     * Set fields to request
+     * @param array|string $field Field name
+     * @throws \InvalidArgumentException Exception if you specified fields in wrong format
+     */
+    public function setFields($fields)
+    {
+        if (is_array($fields)) {
+            if (empty($fields)) {
+                throw new \InvalidArgumentException('You cannot specify empty field names');
+            }
+            $this->fields = $fields;
+        } elseif (is_string($fields) && $fields === '*') {
+            $this->fields = null;
+        } else {
+            throw new \InvalidArgumentException('You can specify fields by passing an array of field names');
+        }
+    }
+
+    /**
+     * Set page size
+     * @param int $page_size Page size
+     */
+    public function setPageSize(int $page_size)
+    {
+        if (is_int($page_size)) {
+            throw new \InvalidArgumentException('Page number should be integer');
+        }
+
+        $this->page_size = $page_size;
+    }
+
+    /**
+     * Set page number
+     * @param int $page_number Page number
+     */
+    public function setPageOffset(int $page_number)
+    {
+        if (is_int($page_number)) {
+            throw new \InvalidArgumentException('Page number should be integer');
+        }
+
+        $this->page_number = $page_number;
+    }
+
+    /**
+     * Set query
+     * @param int $query Query
+     */
+    public function setQuery(array $query)
+    {
+        $queryBuilder = new Where($query);
+        $this->query = $queryBuilder->getQuery();
+    }
+
+    public function getParams()
+    {
+        $params = array(
+            'objecttype'    => $this->object_type,
+            'fields'        => is_array($this->fields) ? implode(',', $this->fields) : '*',
+            'page_number'   => $this->page_number,
+            'page_size'     => $this->page_size,
+        );
+
+        if ($this->order_by instanceof OrderBy) {
+            $params['sort_by'] = $this->order_by->getField();
+            $params['sort_type'] = $this->order_by->getDirection();
+        }
+
+        if (!empty($this->query)) {
+            $params['query'] = $this->query;
+        }
+
+        return $params;
+    }
 }

src/Query/Builder.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace PowerLink\Query;
+namespace PowerLink\QuerySyntax;
 
 /**
  * Class OrderBy.
@@ -11,23 +11,25 @@ class OrderBy
     const DESC = 'desc';
 
     /**
+     * Name of field to sort by 
      * @var string
      */
-    protected $field;
+    protected $sort_by;
 
     /**
-     * @var string
+     * Name of field to sort by 
+     * @var ASC|DESC
      */
-    protected $direction;
+    protected $sort_type;
 
     /**
      * @param string $field
-     * @param ASC|DESC|string $direction
+     * @param string $direction
      */
-    public function __construct(string $field, $direction)
+    public function __construct(string $sort_by, $sort_type = self::ASC)
     {
-        $this->setField($field);
-        $this->setDirection($direction);
+        $this->setField($sort_by);
+        $this->setDirection($sort_type);
     }
 
     /**