Checked types of return values, and modified.

Author: msyk

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.57.4");
 
     //==============================
     //$fmdb = new FMDataAPI("TestDB", "web", "password", "localserver");
@@ -40,7 +40,7 @@
     $fmdb->setDebug(true);
 
     // If you call with true, the certificate from the server is going to verify.
-    // In case of self-signed one (usually default situation), you don't have to call this method.
+    // In the case of self-signed one (usually default situation), you don't have to call this method.
     //$fmdb->setCertValidating(true);
 
     // Metadata API is the new feature of FMS18.

src/FMDataAPI.php

@@ -147,7 +147,7 @@ public function setAPIVersion(int $vNum): void
      */
     public function setCertValidating(bool $value): void
     {
-        $this->provider->isCertVaridating = $value;
+        $this->provider->isCertValidating = $value;
     }
 
     /**
@@ -207,7 +207,7 @@ public function curlErrorCode(): int
      * The error message of curl, text representation of code.
      * @return string The error message of curl.
      */
-    public function curlErrorMessage(): string
+    public function curlErrorMessage(): null|string
     {
         return $this->provider->curlError;
     }
@@ -237,7 +237,7 @@ public function errorCode(): int
      * This error message is associated with FileMaker's error code.
      * @return string The error message.
      */
-    public function errorMessage(): string
+    public function errorMessage(): null|string
     {
         return $this->provider->errorMessage;
     }
@@ -302,58 +302,58 @@ public function setGlobalField(array $fields): void
 
     /**
      * Get the product information, such as the version, etc. This isn't required to authenticate.
-     * @return object The information of this FileMaker product. Ex.:
+     * @return null|object The information of this FileMaker product. Ex.:
      * {'name' => 'FileMaker Data API Engine', 'buildDate' => '03/27/2019', 'version' => '18.0.1.109',
      * 'dateFormat' => 'MM/dd/yyyy', 'timeFormat' => 'HH:mm:ss', 'timeStampFormat' => 'MM/dd/yyyy HH:mm:ss'}.
      * @throws Exception In case of any error, an exception arises.
      */
-    public function getProductInfo(): object
+    public function getProductInfo(): null|object
     {
         return $this->provider->getProductInfo();
     }
 
     /**
      * Get the information about hosting database. It includes the target database and others in FileMaker Server.
      * This is required to authenticate.
-     * @return array The information of hosting databases. Every element is an object and just having 'name'
+     * @return null|array The information of hosting databases. Every element is an object and just having 'name'
      * property.Ex.: [{"name": "TestDB"},{"name": "sample_db"}]
      * @throws Exception In case of any error, an exception arises.
      */
-    public function getDatabaseNames(): array
+    public function getDatabaseNames(): null|array
     {
         return $this->provider->getDatabaseNames();
     }
 
     /**
      * Get the list of layout name in a database.
-     * @return array The information of layouts in the target database. Every element is an object and just having 'name'
+     * @return null|array The information of layouts in the target database. Every element is an object and just having 'name'
      * property.
      * Ex.: [{"name": "person_layout"},{"name": "contact_to"},{"name": "history_to"}...]
      * @throws Exception In case of any error, an exception arises.
      */
-    public function getLayoutNames(): array
+    public function getLayoutNames(): null|array
     {
         return $this->provider->getLayoutNames();
     }
 
     /**
      * Get the list of script name in database.
-     * @return array The information of scripts in the target database. Every element is an object and having 'name' property.
+     * @return null|array The information of scripts in the target database. Every element is an object and having 'name' property.
      * The 'isFolder' property is true if it's a folder item, and it has the 'folderScriptNames' property and includes
      * an object with the same structure.
      * Ex.: [{"name": "TestScript1","isFolder": false},{"name": "TestScript2","isFolder": false},{"name": "Maintenance",
      * "isFolder": true, "folderScriptNames": [{"name": "DataImport","isFolder": false}]}]
      * @throws Exception In case of any error, an exception arises.
      */
-    public function getScriptNames(): array
+    public function getScriptNames(): null|array
     {
         return $this->provider->getScriptNames();
     }
 
     /**
      * Get the table occurrence name of just a previous query.
      * Usually this method returns the information of the FileMakerRelation class.
-     * @return string  The table name.
+     * @return null|string  The table name.
      * @see FileMakerRelation::getTargetTable()
      */
     public function getTargetTable(): null|string
@@ -364,32 +364,32 @@ public function getTargetTable(): null|string
     /**
      * Get the total record count of just a previous query.
      * Usually this method returns the information of the FileMakerRelation class.
-     * @return int  The total record count.
+     * @return null|int  The total record count.
      * @see FileMakerRelation::getTotalCount()
      */
-    public function getTotalCount(): int
+    public function getTotalCount(): null|int
     {
         return $this->provider->totalCount;
     }
 
     /**
      * Get the founded record count of just a previous query.
      * Usually this method returns the information of the FileMakerRelation class.
-     * @return int  The founded record count.
-     * @see FileMakerRelation::getFoundCount()
+     * @return null|int  The founded record count.
+     * @see FileMakerRelation::getFoundCount(): null|int
      */
-    public function getFoundCount(): int
+    public function getFoundCount(): null|int
     {
         return $this->provider->foundCount;
     }
 
     /**
      * Get the returned record count of just a previous query.
      * Usually this method returns the information of the FileMakerRelation class.
-     * @return int  The returned record count.
+     * @return null|int  The returned record count.
      * @see FileMakerRelation::getReturnedCount()
      */
-    public function getReturnedCount(): int
+    public function getReturnedCount(): null|int
     {
         return $this->provider->returnedCount;
     }

src/Supporting/CommunicationProvider.php

@@ -156,7 +156,7 @@ class CommunicationProvider
      * @var bool
      * @ignore
      */
-    public bool $isCertVaridating;
+    public bool $isCertValidating = false;
     /**
      * @var bool
      * @ignore
@@ -206,7 +206,7 @@ class CommunicationProvider
      * @var int
      * @ignore
      */
-    public int $timeout;
+    public null|int $timeout = null;
     /**
      * @var bool
      * @ignore
@@ -376,13 +376,13 @@ public function justifyRequest(?array $request): array
     }
 
     /**
-     * @return array|false
+     * @return object|null
      * @throws Exception In case of any error, an exception arises.
      * @ignore
      */
-    public function getProductInfo(): ?array
+    public function getProductInfo(): object|null
     {
-        $returnValue = false;
+        $returnValue = null;
         $params = ["productInfo" => null];
         $request = [];
         try {
@@ -402,13 +402,13 @@ public function getProductInfo(): ?array
     }
 
     /**
-     * @return array|false
+     * @return array|null
      * @throws Exception In case of any error, an exception arises.
      * @ignore
      */
-    public function getDatabaseNames(): array|false
+    public function getDatabaseNames(): array|null
     {
-        $returnValue = false;
+        $returnValue = null;
         if ($this->useOAuth) {
             $headers = [
                 "Content-Type" => "application/json",
@@ -436,13 +436,13 @@ public function getDatabaseNames(): array|false
     }
 
     /**
-     * @return array|false
+     * @return null|array
      * @throws Exception In case of any error, an exception arises.
      * @ignore
      */
-    public function getLayoutNames(): array|false
+    public function getLayoutNames(): null|array
     {
-        $returnValue = false;
+        $returnValue = null;
         if ($this->login()) {
             $params = ["layouts" => null];
             $request = [];
@@ -466,9 +466,9 @@ public function getLayoutNames(): array|false
      * @throws Exception In case of any error, an exception arises.
      * @ignore
      */
-    public function getScriptNames()
+    public function getScriptNames(): null|array
     {
-        $returnValue = false;
+        $returnValue = null;
         if ($this->login()) {
             $params = ["scripts" => null];
             $request = [];
@@ -617,7 +617,7 @@ public function callRestAPI($params, $isAddToken, $method = 'GET', $request = nu
         } elseif (in_array($methodLower, ['put', 'patch', 'delete', 'get'], true)) {
             curl_setopt($ch, CURLOPT_CUSTOMREQUEST, strtoupper($methodLower));
         }
-        if ($this->isCertVaridating) {
+        if ($this->isCertValidating) {
             curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
             curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 1);
             // Use the OS native certificate authorities, if possible.
@@ -712,7 +712,7 @@ public function accessToContainer($url)
         $ch = curl_init($url); //visit the container URL to set the cookie
         curl_setopt($ch, CURLOPT_COOKIEJAR, $cookieFile);
         curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-        if ($this->isCertVaridating) {
+        if ($this->isCertValidating) {
             curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
             curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 1);
         } else {
@@ -731,7 +731,7 @@ public function accessToContainer($url)
         $ch = curl_init($url); //visit container URL again
         curl_setopt($ch, CURLOPT_COOKIEFILE, $cookieFile);
         curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-        if ($this->isCertVaridating) {
+        if ($this->isCertValidating) {
             curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
             curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 1);
         } else {

src/Supporting/FileMakerRelation.php

@@ -100,7 +100,7 @@ public function getDataInfo()
      *
      * @return null|string The table occurrence name.
      */
-    public function getTargetTable(): ?string
+    public function getTargetTable(): null|string
     {
         return ($this->dataInfo) ? $this->dataInfo->table : null;
     }
@@ -111,7 +111,7 @@ public function getTargetTable(): ?string
      *
      * @return null|int The total record count.
      */
-    public function getTotalCount(): ?int
+    public function getTotalCount(): null|int
     {
         return ($this->dataInfo && property_exists($this->dataInfo, 'totalRecordCount')) ?
             $this->dataInfo->totalRecordCount : null;
@@ -124,7 +124,7 @@ public function getTotalCount(): ?int
      *
      * @return null|int The founded record count.
      */
-    public function getFoundCount(): ?int
+    public function getFoundCount(): null|int
     {
         return ($this->dataInfo) ? $this->dataInfo->foundCount : null;
     }
@@ -136,7 +136,7 @@ public function getFoundCount(): ?int
      *
      * @return null|int The returned record count.
      */
-    public function getReturnedCount(): ?int
+    public function getReturnedCount(): null|int
     {
         return ($this->dataInfo) ? $this->dataInfo->returnedCount : null;
     }