improved getLayoutMetadata and documentation improvements

Author: Smef

README.md

@@ -265,6 +265,7 @@ performScript
 setContainer
 duplicate
 createRecord
+getLayoutMetadata
 ```
 
 #### Examples:
@@ -278,6 +279,16 @@ Find the 10 most recent invoices for a customer
 $invoices = FM::layout('invoice')->where('customer_id', $customer->id)->orderByDesc('date')->limit(10)->get();
 ```
 
+Get layout metadata, which includes field, portal, and value list information
+```
+$layoutMetadata = FM::layout('MyLayoutName')->getLayoutMetadata('MyLayoutName');
+```
+
+Get layout metadata for a specific record
+```
+$layoutMetadata = FM::layout('MyLayoutName')->recordId(879)->getLayoutMetadata();
+```
+
 Run a script
 ```
 $result = FM::layout('MyLayoutName')->performScript('MyScriptName');

src/Database/Query/FMBaseBuilder.php

@@ -248,11 +248,11 @@ protected function bulkDeleteFromQuery(): int
     /**
      * Delete a record using the internal FileMaker record ID
      *
-     * @param $recordId
+     * @param Int $recordId
      * @return int
      * @throws FileMakerDataApiException
      */
-    public function deleteByRecordId($recordId): int
+    public function deleteByRecordId(Int $recordId): int
     {
 
         $this->recordId = $recordId;
@@ -821,6 +821,14 @@ public function executeScript($script = null, $param = null)
         return $result;
     }
 
+    public function getLayoutMetadata($layoutName = null)
+    {
+        if ($layoutName) {
+            $this->layout($layoutName);
+        }
+        return $this->connection->getLayoutMetadata($this);
+    }
+
     /**
      * Prepare the value and operator for a where clause.
      *

src/Services/FileMakerConnection.php

@@ -9,7 +9,6 @@
 use GearboxSolutions\EloquentFileMaker\Database\Query\Grammars\FMGrammar;
 use GearboxSolutions\EloquentFileMaker\Database\Schema\FMBuilder;
 use GearboxSolutions\EloquentFileMaker\Exceptions\FileMakerDataApiException;
-use GuzzleHttp\Exception\ConnectException;
 use GuzzleHttp\Exception\TransferException;
 use GuzzleHttp\Middleware;
 use Illuminate\Database\Connection;
@@ -576,6 +575,7 @@ public function performScript(FMBaseBuilder $query)
         return $this->executeScript($query);
     }
 
+
     protected function getSessionTokenCacheKey()
     {
         return 'filemaker-session-' . $this->getName();
@@ -717,10 +717,36 @@ protected function getDefaultQueryGrammar()
         return new FMGrammar();
     }
 
-    public function getLayoutMetadata($layout = null)
+//    public function getLayoutMetadata($layout = null)
+//    {
+//        $response = $this->makeRequest('get', $this->getLayoutUrl($layout));
+//        return $response['response'];
+//    }
+
+    /**
+     * @param String | FMBaseBuilder $query
+     * @return mixed
+     * @throws FileMakerDataApiException
+     */
+    public function getLayoutMetadata(FMBaseBuilder|string $query = null)
     {
-        $response = $this->makeRequest('get', $this->getLayoutUrl($layout));
-        return $response['response'];
+        // if the query is just a string, it means that it's a layout name
+        if (is_string($query)) {
+            $query = $this->table($query);
+        }
+
+        $this->setLayout($query->from);
+        $url = $this->getLayoutUrl();
+
+        $queryParams = [];
+        $param = $query->getRecordId();
+        if ($param !== null) {
+            $queryParams['recordId'] = $param;
+        }
+
+        $response = $this->makeRequest('get', $url, $queryParams);
+
+        return $response;
     }
 
     public function getSchemaBuilder()

src/Support/Facades/FM.php

@@ -14,11 +14,17 @@
  * Executes against DatabaseManager. If DatabaseManager doesn't have the functionality, it uses __call to call against
  * the connection, which would be a FileMakerConnection.
  *
- * @method static FileMakerConnection connection(string $name = null)
  * @method static FMBaseBuilder layout($layoutName)
  * @method static FMBaseBuilder table($layoutName)
+ * @method static FMBaseBuilder delete($recordId)
+ * @method static FMBaseBuilder deleteByRecordId($recordId)
+
+
  * @method static array setGlobalFields(array $globalFields)
+ * @method static FileMakerConnection connection(string $name = null)
  * @method static FileMakerConnection setRetries(int $retries)
+ * @method static FileMakerConnection getLayoutMetadata($layoutName = null)
+
  *
  *
  * @see \Illuminate\Database\DatabaseManager