Ver.26 FileMaker API for PHP compatible mode.

Author: msyk

README.md

@@ -1,4 +1,4 @@
-# FMDataAPI Ver.25 [![Build Status](https://github.com/msyk/FMDataAPI/actions/workflows/php.yml/badge.svg)](https://github.com/msyk/FMDataAPI/actions/workflows/php.yml)
+# FMDataAPI Ver.26 [![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)
 
@@ -64,7 +64,7 @@ FMDataAPI has "composer.json," so you can add your composer.json file in your pr
 ...
 "require": {
   ...
-  "inter-mediator/fmdataapi":"25"
+  "inter-mediator/fmdataapi":"26"
 } ...
 ```
 
@@ -162,6 +162,8 @@ MIT License
   Bug fix for portal limit parameter. Thanks to tkuijer.
 - 2022-03-24: [Ver.25]
   Add methods(getFirstRecord, getLastRecord, getRecords) to the FileMakerRelation class.
+- 2022-03-26: [Ver.26]
+  Add methods(setFieldHTMLEncoding, getFieldHTMLEncoding) to the FMDataAPI class. These is going to use for comatibility mode of FileMaker API for PHP.
 
 ## API Differences between ver.8 and 7.
 ### FMDataAPI class

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "inter-mediator/fmdataapi",
-  "version": "25",
+  "version": "26",
   "time": "2022-03-24",
   "repositories": [
     {

composer.lock

@@ -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 25
+ * @version 26
  * @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.)
  * @source 1 100000 The source code.
@@ -113,7 +113,8 @@ public function setDebug($value)
      * Set the cURL communication timeout in seconds
      * @param int $timeout
      */
-    public function setTimeout($timeout) {
+    public function setTimeout($timeout)
+    {
         $this->provider->timeout = $timeout;
     }
 
@@ -144,6 +145,29 @@ public function setCertValidating($value)
         $this->provider->isCertVaridating = $value;
     }
 
+    /**
+     * Set to true if the return value of the field() method uses htmlspecialchars function.
+     * The default value is FALSE. The nostalgic FileMaker API for PHP was returning htmlspecialchars value of the field.
+     * If we want to get the row field data, we had to call getFieldUnencoded method. If this property set to true,
+     * FileMakerRelation class's field method (including describing field name directly) returns the value processed
+     * with htmlspecialchars. This means kind of compatible mode of FileMaker API for PHP.
+     * This feature works whole the FMDataAPI library.
+     * @param bool $value Turn on to verify the certificate if the value is true.
+     */
+    public function setFieldHTMLEncoding($value)
+    {
+        $this->provider->fieldHTMLEncoding = $value;
+    }
+
+    /**
+     * Detect the return value of the field() method uses htmlspecialchars function or not.
+     * @return bool The result.
+     */
+    public function getFieldHTMLEncoding($value)
+    {
+        return $this->provider->fieldHTMLEncoding;
+    }
+
     /**
      * Set session token
      * @param string $value The session token.

src/FMDataAPI.php

@@ -7,7 +7,7 @@
  *
  * @package INTER-Mediator\FileMakerServer\RESTAPI
  * @link https://github.com/msyk/FMDataAPI GitHub Repository
- * @version 25
+ * @version 26
  * @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.)
  */
@@ -205,6 +205,11 @@ class CommunicationProvider
      * @ignore
      */
     public $timeout;
+    /**
+     * @var
+     * @ignore
+     */
+    public $fieldHTMLEncoding = false;
 
     /**
      * CommunicationProvider constructor.
@@ -542,7 +547,7 @@ private function getOAuthIdentifier($provider)
     {
         try {
             $this->callRestAPI([], [
-                "trackingID" => rand(10000000,99999999),
+                "trackingID" => rand(10000000, 99999999),
                 "provider" => $provider,
                 "address" => "127.0.0.1",
                 "X-FMS-OAuth-AuthType" => 2

src/Supporting/CommunicationProvider.php

@@ -10,7 +10,7 @@
  *
  * @package INTER-Mediator\FileMakerServer\RESTAPI
  * @link https://github.com/msyk/FMDataAPI GitHub Repository
- * @version 25
+ * @version 26
  * @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.)
  */

src/Supporting/FileMakerLayout.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 25
+ * @version 26
  * @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.)
  */
@@ -59,10 +59,12 @@ class FileMakerRelation implements Iterator
     /**
      * FileMakerRelation constructor.
      *
-     * @param $data
+     * @param array<object> $responseData
+     * @param object $infoData
      * @param string $result
      * @param int $errorCode
-     * @param null $portalName
+     * @param string $portalName
+     * @param CommunicationProvider $provider
      *
      * @ignore
      */
@@ -354,6 +356,8 @@ public function getPortalNames()
      *
      * @return string|FileMakerRelation The field value as string, or the FileMakerRelation object of the portal.
      * @throws Exception The field specified in parameters doesn't exist.
+     * @see FMDataAPI::setFieldHTMLEncoding() Compatible mode for FileMaker API for PHP.
+     *
      */
     public function field($name, $toName = null)
     {
@@ -411,7 +415,9 @@ public function field($name, $toName = null)
         if (is_null($value)) {
             throw new \Exception("Field {$fieldName} doesn't exist.");
         }
-
+        if ($this->restAPI && $this->restAPI->fieldHTMLEncoding && !is_object($value)) {
+            $value = htmlspecialchars($value);
+        }
         return $value;
     }
 

src/Supporting/FileMakerRelation.php

@@ -1 +1 @@
-{"version":1,"defects":[],"times":{"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_initializeObjects":0.005,"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_Query":0.013,"INTERMediator\\FileMakerServer\\RESTAPI\\FMDataAPIUnitTest::test_ErrorQuery":0.002}}
+{"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}}