Ver.30 Release: toArray() bug fixed.

Author: msyk

README.md

@@ -65,7 +65,7 @@ FMDataAPI has "composer.json," so you can add your composer.json file in your pr
 ...
 "require": {
   ...
-  "inter-mediator/fmdataapi":"29"
+  "inter-mediator/fmdataapi":"30"
 } ...
 ```
 
@@ -173,6 +173,8 @@ MIT License
 - 2022-12-28: [Ver.29]
   Fixed the 'HTTP/2 stream 0 was not closed cleanly' problem with the new FileMaker (Thanks to @thijsmeijer)
   Also fixed the getPortalNames issue for single record relation (Thanks to @PGMMattias).
+- 2023-06-20: [Ver.30]
+  The toArray() method bug fixed. In same cases, it returned []. (Thanks to @PGMMattias).
 
 ## API Differences between ver.8 and 7.
 ### FMDataAPI class

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "inter-mediator/fmdataapi",
-  "version": "29",
-  "time": "2022-12-28",
+  "version": "30",
+  "time": "2023-06-20",
   "repositories": [
     {
       "type": "git",

samples/FMDataAPI_Sample.php

@@ -19,7 +19,7 @@
     // Instantiate the class FMDataAPI with database name, user name, password and host.
     // Although the port number and protocol can be set in parameters of constructor,
     // these parameters can be omitted with default values.
-    $fmdb = new FMDataAPI("TestDB", "web", "password", "localhost");
+    $fmdb = new FMDataAPI("TestDB", "web", "password", "10.211.56.2");
 
     //==============================
     //$fmdb = new FMDataAPI("TestDB", "web", "password", "localserver");
@@ -72,18 +72,18 @@
     echo htmlspecialchars("Error Code: {$fmdb->errorCode()}", ENT_QUOTES, "UTF-8") . "<hr>";
     echo htmlspecialchars("Error Message: {$fmdb->errorMessage()}", ENT_QUOTES, "UTF-8") . "<hr>";
 
-    // If the query is succeed, the following information can be detected.
+    // If the query is succeeded, the following information can be detected.
     echo htmlspecialchars("Target Table: {$fmdb->getTargetTable()}", ENT_QUOTES, "UTF-8") . "<hr>";
     echo htmlspecialchars("Total Count: {$fmdb->getTotalCount()}", ENT_QUOTES, "UTF-8") . "<hr>";
     echo htmlspecialchars("Found Count: {$fmdb->getFoundCount()}", ENT_QUOTES, "UTF-8") . "<hr>";
     echo htmlspecialchars("Returned Count: {$fmdb->getReturnedCount()}", ENT_QUOTES, "UTF-8") . "<hr>";
 
     // The FileMakerRelation class implements the Iterator interface and it can repeat with 'foreach.'
     // The $record also refers a FileMakerRelation object but it is for single record.
-    // This layout has fields as like 'id', 'name', 'mail' and so on, and the field name can be handle
-    // as a property name of the the record referring with $record.
+    // This layout has fields as like 'id', 'name', 'mail' and so on, and the field name can be handled
+    // as a property name of the record referring with $record.
     if (!is_null($result)) {
-        // If the query is succeed, the following information can be detected.
+        // If the query is succeeded, the following information can be detected.
         echo htmlspecialchars("Target Table: {$result->getTargetTable()}", ENT_QUOTES, "UTF-8") . "<hr>";
         echo htmlspecialchars("Total Count: {$result->getTotalCount()}", ENT_QUOTES, "UTF-8") . "<hr>";
         echo htmlspecialchars("Found Count: {$result->getFoundCount()}", ENT_QUOTES, "UTF-8") . "<hr>";
@@ -101,7 +101,7 @@
             // A portal name property returns records of portal as FileMakerRelation object.
             $contacts = $record->Contact;
 
-            // If the query is succeed, the following information can be detected.
+            // If the query is succeeded, the following information can be detected.
             echo htmlspecialchars("Target Table: {$contacts->getTargetTable()}", ENT_QUOTES, "UTF-8") . "<hr>";
             echo htmlspecialchars("Total Count: {$contacts->getTotalCount()}", ENT_QUOTES, "UTF-8") . "<hr>";
             echo htmlspecialchars("Found Count: {$contacts->getFoundCount()}", ENT_QUOTES, "UTF-8") . "<hr>";
@@ -122,6 +122,25 @@
             echo "<hr>";
         }
 
+
+        echo "<h3>toArray() results</h3>";
+        echo "<h4>[query_result]->toArray()</h4>";
+        var_export($result->toArray());
+
+        foreach ($result as $record) {
+            echo "<hr>";
+            echo "<h4>[each_record]->toArray()</h4>";
+            var_export($record->toArray());
+            foreach ($result->getPortalNames() as $portalName) {
+                echo "<h4>[portal]->toArray()</h4>";
+                var_export($record->$portalName->toArray());
+                foreach ($record->$portalName as $portalRecord) {
+                    echo "<h4>[each_portal_record]->toArray()</h4>";
+                    var_export($portalRecord->toArray());
+                }
+            }
+        }
+
         // Move to pointer to the first record.
         $result->rewind();
 

src/FMDataAPI.php

@@ -13,7 +13,7 @@
  * @link https://github.com/msyk/FMDataAPI GitHub Repository
  * @property-read FileMakerLayout $<<layout_name>> Returns the FileMakerLayout object from the layout named with the property.
  *    If the layout doesn't exist, no error arises here. Any errors might arise on methods of FileMakerLayout class.
- * @version 29
+ * @version 30
  * @author Masayuki Nii <nii@msyk.net>
  * @copyright 2017-2023 Masayuki Nii (Claris FileMaker is registered trademarks of Claris International Inc. in the U.S. and other countries.)
  * @source 1 100000 The source code.

src/Supporting/CommunicationProvider.php

@@ -7,7 +7,7 @@
  *
  * @package INTER-Mediator\FileMakerServer\RESTAPI
  * @link https://github.com/msyk/FMDataAPI GitHub Repository
- * @version 29
+ * @version 30
  * @author Masayuki Nii <nii@msyk.net>
  * @copyright 2017-2023 Masayuki Nii (Claris FileMaker is registered trademarks of Claris International Inc. in the U.S. and other countries.)
  */

src/Supporting/FileMakerLayout.php

@@ -10,7 +10,7 @@
  *
  * @package INTER-Mediator\FileMakerServer\RESTAPI
  * @link https://github.com/msyk/FMDataAPI GitHub Repository
- * @version 29
+ * @version 30
  * @author Masayuki Nii <nii@msyk.net>
  * @copyright 2017-2023 Masayuki Nii (Claris FileMaker is registered trademarks of Claris International Inc. in the U.S. and other countries.)
  */

src/Supporting/FileMakerRelation.php

@@ -14,7 +14,7 @@
  * @property string $<<field_name>> The field value named as the property name.
  * @property FileMakerRelation $<<portal_name>> FileMakerRelation object associated with the property name.
  *    The table occurrence name of the portal can be the 'portal_name,' and also the object name of the portal.
- * @version 29
+Ver * @version 30
  * @author Masayuki Nii <nii@msyk.net>
  * @copyright 2017-2023 Masayuki Nii (Claris FileMaker is registered trademarks of Claris International Inc. in the U.S. and other countries.)
  */
@@ -312,27 +312,26 @@ public function getRecords()
      */
     public function toArray(): array
     {
-        if (isset($this->data)) {
-            switch ($this->result) {
-                case 'OK':
-                    if (isset($this->data[$this->pointer])
-                        && isset($this->data[$this->pointer]->fieldData)) {
-                        return json_decode(json_encode($this->data[$this->pointer]->fieldData), true);
-                    }
-                    break;
-                case 'PORTAL':
-                    if (isset($this->data[$this->pointer])) {
-                        return json_decode(json_encode($this->data[$this->pointer]), true);
-                    }
-                    break;
-                case 'RECORD':
-                    if (isset($this->data->fieldData)) {
-                        return json_decode(json_encode($this->data->fieldData), true);
-                    }
-                    break;
-            }
+        switch ($this->result) {
+            case 'OK':
+            case 'PORTAL':
+                $resultArray = [];
+                foreach ($this as $record) {
+                    $resultArray[] = $record->toArray();
+                }
+                return json_decode(json_encode($resultArray), true);
+                break;
+            case 'PORTALRECORD':
+                if (isset($this->data)) {
+                    return json_decode(json_encode($this->data), true);
+                }
+                break;
+            case 'RECORD':
+                if (isset($this->data) && isset($this->data->fieldData)) {
+                    return json_decode(json_encode($this->data->fieldData), true);
+                }
+                break;
         }
-
         return [];
     }