added offsetPortal, type hinting, updated documentation

Author: Smef

README.md

@@ -247,20 +247,22 @@ FM::setGlobalFields() // not chainable
 #### Chainable
 ```php
 // standard query-builder stuff like where, orderBy, etc.
-->limit()
-->offset()
-->script()
-->scriptParam()
-->scriptPresort()
-->scriptPresortParam()
-->scriptPrerequest()
-->scriptPrerequestParam()
-->layoutResponse()
-->portal()
+->limit( $value )
+->offset( $value )
+->script( $scriptName, $param)
+->scriptParam( $param )
+->scriptPresort( $scriptName, $param
+->scriptPresortParam( $param )
+->scriptPrerequest( $scriptName, $param )
+->scriptPrerequestParam( $param )
+->layoutResponse( $layoutName )
+->portal( $portalName )
+->portalLimit( $portalName, $limit )
+->portalOffset( $portalName, $startingRecord  )
 ->sort() // alias for the native orderBy()
 ->omit()
-->fieldData()
-->portalData()
+->fieldData( $array )
+->portalData( $array )
 ```
 
 #### Final-chain-link methods

src/Database/Query/FMBaseBuilder.php

@@ -96,6 +96,12 @@ class FMBaseBuilder extends Builder
      */
     public array $limitPortals = [];
 
+    /**
+     * An array of portals which should have the offset set it the response.
+     * This is actually the "starting record", and so the default value is 1.
+     */
+    public array $offsetPortals = [];
+
     public const ASCEND = 'ascend';
 
     public const DESCEND = 'descend';
@@ -112,7 +118,7 @@ class FMBaseBuilder extends Builder
      *
      * @var array
      */
-    public $portal;
+    public $portal = [];
 
     /**
      * @var int
@@ -334,23 +340,34 @@ public function limit($value): FMBaseBuilder
         return $this;
     }
 
-    public function limitPortal($portalName, $limit): FMBaseBuilder
+    public function limitPortal(string $portalName, int $limit): FMBaseBuilder
     {
         $this->limitPortals[] = ['portalName' => $portalName, 'limit' => $limit];
 
         return $this;
     }
 
+    /**
+     * Set an offset for a given portal.
+     * This is actually the "starting record", and so the default value is 1.
+     */
+    public function offsetPortal(string $portalName, int $startingRecord): FMBaseBuilder
+    {
+        $this->offsetPortals[] = ['portalName' => $portalName, 'offset' => $startingRecord];
+
+        return $this;
+    }
+
     public function offset($value): FMBaseBuilder
     {
         $this->offset = $value;
 
         return $this;
     }
 
-    public function script($name, $param = null): FMBaseBuilder
+    public function script($scriptName, $param = null): FMBaseBuilder
     {
-        $this->script = $name;
+        $this->script = $scriptName;
 
         // set the script parameter if one was passed in
         if ($param) {
@@ -360,16 +377,16 @@ public function script($name, $param = null): FMBaseBuilder
         return $this;
     }
 
-    public function scriptParam($param): FMBaseBuilder
+    public function scriptParam(string $param): FMBaseBuilder
     {
         $this->scriptParam = $param;
 
         return $this;
     }
 
-    public function scriptPresort($name, $param = null): FMBaseBuilder
+    public function scriptPresort(string $scriptName, $param = null): FMBaseBuilder
     {
-        $this->scriptPresort = $name;
+        $this->scriptPresort = $scriptName;
 
         // set the script parameter if one was passed in
         if ($param) {
@@ -379,16 +396,16 @@ public function scriptPresort($name, $param = null): FMBaseBuilder
         return $this;
     }
 
-    public function scriptPresortParam($param): FMBaseBuilder
+    public function scriptPresortParam(string $param): FMBaseBuilder
     {
         $this->scriptPresortParam = $param;
 
         return $this;
     }
 
-    public function scriptPrerequest($name, $param = null): FMBaseBuilder
+    public function scriptPrerequest(string $scriptName, string $param = null): FMBaseBuilder
     {
-        $this->scriptPrerequest = $name;
+        $this->scriptPrerequest = $scriptName;
 
         // set the script parameter if one was passed in
         if ($param) {
@@ -398,16 +415,16 @@ public function scriptPrerequest($name, $param = null): FMBaseBuilder
         return $this;
     }
 
-    public function scriptPrerequestParam($param): FMBaseBuilder
+    public function scriptPrerequestParam(string $param): FMBaseBuilder
     {
         $this->scriptPrerequestParam = $param;
 
         return $this;
     }
 
-    public function layoutResponse($name): FMBaseBuilder
+    public function layoutResponse(string $layoutName): FMBaseBuilder
     {
-        $this->layoutResponse = $name;
+        $this->layoutResponse = $layoutName;
 
         return $this;
     }
@@ -640,7 +657,7 @@ public function createRecord()
      * @param $array array
      * @return $this
      */
-    public function fieldData($array)
+    public function fieldData(array $array)
     {
         $this->fieldData = $this->mapFieldNamesForArray($array);
 
@@ -653,7 +670,7 @@ public function fieldData($array)
      * @param $array array
      * @return $this
      */
-    public function portalData($array)
+    public function portalData(array $array)
     {
         $this->portalData = $array;
 
@@ -797,7 +814,6 @@ public function portal($portalName)
             // It's a single value, so append it on the array
             array_push($this->portal, $portalName);
         }
-        $this->portal = $portalName;
 
         return $this;
     }

src/Services/FileMakerConnection.php

@@ -490,13 +490,20 @@ protected function buildPostDataFromQuery(FMBaseBuilder $query)
             }
         }
 
-        // Special handling for _limit.portal
+        // Special handling for _limit.{portal}
         if (isset($query->limitPortals) && count($query->limitPortals) > 0) {
             foreach ($query->limitPortals as $portalArray) {
                 $postData['limit.' . urlencode($portalArray['portalName'])] = $portalArray['limit'];
             }
         }
 
+        // handle _offset.{portal}
+        if (isset($query->offsetPortals) && count($query->offsetPortals) > 0) {
+            foreach ($query->offsetPortals as $portalArray) {
+                $postData['offset.' . urlencode($portalArray['portalName'])] = $portalArray['offset'];
+            }
+        }
+
         // Special handling for offset
         if (isset($postData['offset'])) {
             if ($postData['offset'] > 0) {