Checking some methods (as like getFirstRecord) to work for all methods.

msyk · msyk · commit eed61d5c1e85 · 2022-12-27T11:22:13.000+09:00
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# FMDataAPI Ver.28 [![Build Status](https://github.com/msyk/FMDataAPI/actions/workflows/php.yml/badge.svg)](https://github.com/msyk/FMDataAPI/actions/workflows/php.yml)
+# FMDataAPI Ver.29 [![Build Status](https://github.com/msyk/FMDataAPI/actions/workflows/php.yml/badge.svg)](https://github.com/msyk/FMDataAPI/actions/workflows/php.yml)
 
 by Masayuki Nii (nii@msyk.net)
 
@@ -65,7 +65,7 @@ FMDataAPI has "composer.json," so you can add your composer.json file in your pr
 ...
 "require": {
   ...
-  "inter-mediator/fmdataapi":"28"
+  "inter-mediator/fmdataapi":"29"
 } ...
 ```
 
@@ -170,8 +170,9 @@ MIT License
 - 2022-08-04: [Ver.28]
   Added the getContainerData(URL) method to the FMDataAPI class for accessing container data from the url containing /Streaming/MainDB.
   [BUG FIX] The FileMakerRelation class's toArray method didn't return array (Thanks to Talwinder Singh).
-- 2022-xx-xx: [Ver.29]
+- 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).
 
 ## API Differences between ver.8 and 7.
 ### FMDataAPI class
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
   "name": "inter-mediator/fmdataapi",
-  "version": "28",
-  "time": "2022-08-04",
+  "version": "29",
+  "time": "2022-12-28",
   "repositories": [
     {
       "type": "git",
diff --git a/src/FMDataAPI.php b/src/FMDataAPI.php
@@ -13,9 +13,9 @@
  * @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 28
+ * @version 29
  * @author Masayuki Nii <nii@msyk.net>
- * @copyright 2017-2022 Masayuki Nii (Claris FileMaker is registered trademarks of Claris International Inc. in the U.S. and other countries.)
+ * @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.
  */
 class FMDataAPI
@@ -37,8 +37,8 @@ class FMDataAPI
     private $provider = null;
 
     /**
-     * FMDataAPI constructor. If you want to activate OAuth authentication, $user and $pasword are set as
-     * oAuthRequestId and oAuthIdentifier. Moreover call useOAuth method before accessing layouts.
+     * FMDataAPI constructor. If you want to activate OAuth authentication, $user and $password are set as
+     * oAuthRequestId and oAuthIdentifier. Moreover, call useOAuth method before accessing layouts.
      * @param String $solution The database file name which is just hosting.
      * Every database must have the access privillege 'fmrest' including external data sources.
      * @param String $user The fmrest privilege accessible user to the database.
diff --git a/src/Supporting/CommunicationProvider.php b/src/Supporting/CommunicationProvider.php
@@ -7,9 +7,9 @@
  *
  * @package INTER-Mediator\FileMakerServer\RESTAPI
  * @link https://github.com/msyk/FMDataAPI GitHub Repository
- * @version 28
+ * @version 29
  * @author Masayuki Nii <nii@msyk.net>
- * @copyright 2017-2022 Masayuki Nii (Claris FileMaker is registered trademarks of Claris International Inc. in the U.S. and other countries.)
+ * @copyright 2017-2023 Masayuki Nii (Claris FileMaker is registered trademarks of Claris International Inc. in the U.S. and other countries.)
  */
 class CommunicationProvider
 {
diff --git a/src/Supporting/FileMakerLayout.php b/src/Supporting/FileMakerLayout.php
@@ -10,9 +10,9 @@
  *
  * @package INTER-Mediator\FileMakerServer\RESTAPI
  * @link https://github.com/msyk/FMDataAPI GitHub Repository
- * @version 28
+ * @version 29
  * @author Masayuki Nii <nii@msyk.net>
- * @copyright 2017-2022 Masayuki Nii (Claris FileMaker is registered trademarks of Claris International Inc. in the U.S. and other countries.)
+ * @copyright 2017-2023 Masayuki Nii (Claris FileMaker is registered trademarks of Claris International Inc. in the U.S. and other countries.)
  */
 class FileMakerLayout
 {
diff --git a/src/Supporting/FileMakerRelation.php b/src/Supporting/FileMakerRelation.php
@@ -14,9 +14,9 @@
  * @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 28
+ * @version 29
  * @author Masayuki Nii <nii@msyk.net>
- * @copyright 2017-2022 Masayuki Nii (Claris FileMaker is registered trademarks of Claris International Inc. in the U.S. and other countries.)
+ * @copyright 2017-2023 Masayuki Nii (Claris FileMaker is registered trademarks of Claris International Inc. in the U.S. and other countries.)
  */
 class FileMakerRelation implements Iterator
 {
@@ -46,7 +46,7 @@ class FileMakerRelation implements Iterator
      */
     private $pointer = 0;
     /**
-     * @var null
+     * @var string|null
      * @ignore
      */
     private $portalName = null;
@@ -190,7 +190,17 @@ public function moveTo($position): void
      */
     public function count(): int
     {
-        return count($this->data);
+        switch ($this->result) {
+            case "OK":
+            case "PORTAL":
+                return count($this->data);
+                break;
+            case "RECORD":
+            case "PORTALRECORD":
+                return 1;
+                break;
+        }
+        return 0;
     }
 
     /**
@@ -342,6 +352,7 @@ public function getPortalNames()
                             foreach ($key->portalData as $name => $val) {
                                 array_push($list, $name);
                             }
+                            break 2;
                         }
                     }
                     break;
@@ -384,10 +395,10 @@ public function field($name, $toName = null)
                         } else if (isset($this->data[$this->pointer]->portalData) &&
                             isset($this->data[$this->pointer]->portalData->$name)
                         ) {
-                            $value = new FileMakerRelation(
-                                $this->data[$this->pointer]->portalData->$name,
-                                property_exists($this->data[$this->pointer], 'portalDataInfo') ? $this->data[$this->pointer]->portalDataInfo : null,
-                                "PORTAL", 0, null, $this->restAPI);
+                            $infoData = property_exists($this->data[$this->pointer], 'portalDataInfo') ?
+                                $this->data[$this->pointer]->portalDataInfo : null;
+                            $value = new FileMakerRelation($this->data[$this->pointer]->portalData->$name,
+                                $infoData, "PORTAL", 0, $name, $this->restAPI);
                         }
                     }
                     break;
@@ -402,9 +413,8 @@ public function field($name, $toName = null)
                     if (isset($this->data->fieldData) && isset($this->data->fieldData->$name)) {
                         $value = $this->data->fieldData->$name;
                     } else if (isset($this->data->portalData) && isset($this->data->portalData->$name)) {
-                        $value = new FileMakerRelation(
-                            $this->data->portalData->$name,
-                            property_exists($this->data, 'portalDataInfo') ? $this->data->portalDataInfo : null,
+                        $infoData = property_exists($this->data, 'portalDataInfo') ? $this->data->portalDataInfo : null;
+                        $value = new FileMakerRelation($this->data->portalData->$name, $infoData,
                             "PORTAL", 0, $name, $this->restAPI);
                     } else if (isset($this->data->fieldData->$fieldName)) {
                         $value = $this->data->fieldData->$fieldName;
@@ -534,21 +544,29 @@ public function getContainerData($name, $toName = null)
     public function current(): ?FileMakerRelation
     {
         $value = null;
-        if (isset($this->data) &&
-            isset($this->data[$this->pointer])
-        ) {
-            $tmpInfo = $this->getDataInfo();
-            $dataInfo = null;
-            if ($tmpInfo !== null && is_object($tmpInfo)) {
-                $dataInfo = clone $tmpInfo;
-                $dataInfo->returnedCount = 1;
-            }
-            $value = new FileMakerRelation(
-                $this->data[$this->pointer], $dataInfo,
-                ($this->result == "PORTAL") ? "PORTALRECORD" : "RECORD",
-                $this->errorCode, $this->portalName, $this->restAPI);
+        switch ($this->result) {
+            case "OK":
+            case "PORTAL":
+                if (isset($this->data) &&
+                    isset($this->data[$this->pointer])
+                ) {
+                    $tmpInfo = $this->getDataInfo();
+                    $dataInfo = null;
+                    if ($tmpInfo !== null && is_object($tmpInfo)) {
+                        $dataInfo = clone $tmpInfo;
+                        $dataInfo->returnedCount = 1;
+                    }
+                    $result = ($this->result == "PORTAL") ? "PORTALRECORD" : "RECORD";
+                    $portalName = $this->portalName;
+                    $value = new FileMakerRelation($this->data[$this->pointer], $dataInfo, $result,
+                        $this->errorCode, $portalName, $this->restAPI);
+                }
+                break;
+            case "RECORD":
+            case "PORTALRECORD":
+                $value = $this;
+                break;
         }
-
         return $value;
     }
 
@@ -569,12 +587,19 @@ public function key(): int
      */
     public function valid(): bool
     {
-        if (isset($this->data) &&
-            isset($this->data[$this->pointer])
-        ) {
-            return true;
+        switch ($this->result) {
+            case "OK":
+            case "PORTAL":
+                if (isset($this->data) && isset($this->data[$this->pointer])
+                ) {
+                    return true;
+                }
+                break;
+            case "RECORD":
+            case "PORTALRECORD":
+                return $this->pointer == 0;
+                break;
         }
-
         return false;
     }
 
diff --git a/test/.phpunit.result.cache b/test/.phpunit.result.cache
@@ -1 +1 @@
-{"version":1,"defects":[],"times":{"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_initializeObjects":0.005,"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_Query":0.019,"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_ErrorQuery":0.001}}
+{"version":1,"defects":{"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_SingleRecord":3,"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_Query":4},"times":{"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_initializeObjects":0.004,"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_Query":0.001,"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_ErrorQuery":0,"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_SingleRecord":0}}
diff --git a/test/FMDataAPIUnitTest.php b/test/FMDataAPIUnitTest.php
@@ -36,6 +36,7 @@ public function test_Query()
         $this->assertEquals($result->getTotalCount(), 3, 'Checking the total record number.');
         $this->assertEquals($result->getFoundCount(), 3, 'Checking the found record number.');
         $this->assertEquals($result->getReturnedCount(), 3, 'Checking the returned record number.');
+        $this->assertEquals($result->getPortalNames(), ['Contact', 'History'], 'The query result returns portal names.');
 
         $counter = 0;
         foreach ($result as $record) {
@@ -44,6 +45,9 @@ public function test_Query()
                 $this->assertEquals($record->id, 1, 'Field value has to match with defined value.');
                 $this->assertEquals($record->name, 'Masayuki Nii', 'Field value has to match with defined value.');
                 $this->assertEquals($record->mail, 'msyk@msyk.net', 'Field value has to match with defined value.');
+
+                $this->assertEquals($record->getModId(), 6, 'It has ModID.');
+                $this->assertEquals($record->getRecordId(), 1, 'It has RecordID.');
                 $pcounter = 0;
                 $this->assertEquals($contacts->count(), 3, 'Checking the record number.');
                 $this->assertEquals($contacts->getTargetTable(), 'contact_to', 'Checking the table occurrence name.');
@@ -52,12 +56,13 @@ public function test_Query()
                 $this->assertEquals($contacts->getReturnedCount(), 3, 'Checking the returned record number.');
 
                 foreach ($contacts as $item) {
+                    $item->setPortalName("contact_to");
                     if ($pcounter === 0) {
-                        $this->assertEquals($item->field("datetime", "contact_to"), '12/01/2009 15:23:00', 'Portal field value has to match with defined value.');
+                        $this->assertEquals($item->field("datetime"), '12/01/2009 15:23:00', 'Portal field value has to match with defined value.');
                     } else if ($pcounter === 1) {
-                        $this->assertEquals($item->field("datetime", "contact_to"), '12/02/2009 15:23:00', 'Portal field value has to match with defined value.');
+                        $this->assertEquals($item->field("datetime"), '12/02/2009 15:23:00', 'Portal field value has to match with defined value.');
                     } else if ($pcounter === 2) {
-                        $this->assertEquals($item->field("datetime", "contact_to"), '12/03/2009 15:23:00', 'Portal field value has to match with defined value.');
+                        $this->assertEquals($item->field("datetime"), '12/03/2009 15:23:00', 'Portal field value has to match with defined value.');
                     }
                     $pcounter += 1;
                 }
@@ -110,6 +115,53 @@ public function test_ErrorQuery()
         $this->assertEquals($fm->curlErrorCode(), 6, 'The error code has to be 6.');
     }
 
+    public function test_SingleRecord()
+    {
+        $result = $this->fmdataapi->person_layout->query();
+        $record = $result->getFirstRecord();
+        $this->assertEquals($record->id, 1, 'Field value has to match with defined value.');
+        $this->assertEquals($record->name, 'Masayuki Nii', 'Field value has to match with defined value.');
+        $this->assertEquals($record->mail, 'msyk@msyk.net', 'Field value has to match with defined value.');
+        $pcounter = 0;
+        $contacts = $record->Contact;
+        $this->assertEquals($contacts->count(), 3, 'Checking the record number.');
+        $this->assertEquals($contacts->getTargetTable(), 'contact_to', 'Checking the table occurrence name.');
+        $this->assertNull($contacts->getTotalCount(), 'Checking NULL as the total record number.');
+        $this->assertEquals($contacts->getFoundCount(), 3, 'Checking the found record number.');
+        $this->assertEquals($contacts->getReturnedCount(), 3, 'Checking the returned record number.');
+
+        foreach ($contacts as $item) {
+            if ($pcounter === 0) {
+                $this->assertEquals($item->field("datetime", "contact_to"), '12/01/2009 15:23:00', 'Portal field value has to match with defined value.');
+            } else if ($pcounter === 1) {
+                $this->assertEquals($item->field("datetime", "contact_to"), '12/02/2009 15:23:00', 'Portal field value has to match with defined value.');
+            } else if ($pcounter === 2) {
+                $this->assertEquals($item->field("datetime", "contact_to"), '12/03/2009 15:23:00', 'Portal field value has to match with defined value.');
+            }
+            $pcounter += 1;
+        }
+        $this->assertEquals($pcounter, 3, 'Cheking the record number in portal.');
+
+        $this->assertEquals($record->count(), 1, 'The single record is just one record.');
+        $currentRecord = $record->current();
+        $this->assertEquals($currentRecord->id, 1, 'The single record can call current and return a Relation.');
+        $this->assertEquals($record->getPortalNames(), ['Contact', 'History'], 'The single record returns portal names.');
+        $this->assertEquals($record->getModId(), 6, 'The single record returns ModID.');
+        $this->assertEquals($record->getRecordId(), 1, 'The single record returns RecordID.');
+        $this->assertEquals($record->getTargetTable(),  'person_to', 'The single record returns the target table.');
+
+        $pcount = 0;
+        foreach ($record as $item) {
+            $this->assertEquals($item->id, 1, 'The single record can iterate.');
+            $pcount++;
+        }
+        $this->assertEquals($pcount, 1, 'The single record has to repeat just once.');
+        $this->assertEquals($record->getTotalCount(), 3,'Checking the total record number for queried data.');
+        $this->assertEquals($record->getFoundCount(), 3, 'Checking the found record number for queried data.');
+        $this->assertEquals($record->getReturnedCount(), 1, 'Checking the returned record number.');
+
+    }
+
 //    public function test_OldVersionFMS()
 //    {
 //        $fm = new FMDataAPI("TestDB", "web", "password", "10.0.1.21", "443", "https", false, true);

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "inter-mediator/fmdataapi",`
`3`		`- "version": "28",`
`4`		`- "time": "2022-08-04",`
	`3`	`+ "version": "29",`
	`4`	`+ "time": "2022-12-28",`
`5`	`5`	`"repositories": [`
`6`	`6`	`{`
`7`	`7`	`"type": "git",`
Original file line number	Diff line number	Diff line change
`@@ -7,9 +7,9 @@`
`7`	`7`	`*`
`8`	`8`	`* @package INTER-Mediator\FileMakerServer\RESTAPI`
`9`	`9`	`* @link https://github.com/msyk/FMDataAPI GitHub Repository`
`10`		`- * @version 28`
	`10`	`+ * @version 29`
`11`	`11`	`* @author Masayuki Nii <nii@msyk.net>`
`12`		`- * @copyright 2017-2022 Masayuki Nii (Claris FileMaker is registered trademarks of Claris International Inc. in the U.S. and other countries.)`
	`12`	`+ * @copyright 2017-2023 Masayuki Nii (Claris FileMaker is registered trademarks of Claris International Inc. in the U.S. and other countries.)`
`13`	`13`	`*/`
`14`	`14`	`class CommunicationProvider`
`15`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,9 +10,9 @@`
`10`	`10`	`*`
`11`	`11`	`* @package INTER-Mediator\FileMakerServer\RESTAPI`
`12`	`12`	`* @link https://github.com/msyk/FMDataAPI GitHub Repository`
`13`		`- * @version 28`
	`13`	`+ * @version 29`
`14`	`14`	`* @author Masayuki Nii <nii@msyk.net>`
`15`		`- * @copyright 2017-2022 Masayuki Nii (Claris FileMaker is registered trademarks of Claris International Inc. in the U.S. and other countries.)`
	`15`	`+ * @copyright 2017-2023 Masayuki Nii (Claris FileMaker is registered trademarks of Claris International Inc. in the U.S. and other countries.)`
`16`	`16`	`*/`
`17`	`17`	`class FileMakerLayout`
`18`	`18`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{"version":1,"defects":[],"times":{"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_initializeObjects":0.005,"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_Query":0.019,"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_ErrorQuery":0.001}}`
	`1`	+{"version":1,"defects":{"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_SingleRecord":3,"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_Query":4},"times":{"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_initializeObjects":0.004,"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_Query":0.001,"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_ErrorQuery":0,"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_SingleRecord":0}}