Merge branch 'main' into add-eager-loading

Author: David Nahodyl

src/Database/Eloquent/Concerns/FMGuardsAttributes.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace BlueFeather\EloquentFileMaker\Database\Eloquent\Concerns;
+
+use Illuminate\Support\Facades\Cache;
+
+trait FMGuardsAttributes
+{
+
+    /**
+     * Determine if the given key is guarded.
+     *
+     * @param string $key
+     * @return bool
+     */
+    public function isGuarded($key)
+    {
+        if (empty($this->getGuarded())) {
+            return false;
+        }
+
+        return $this->getGuarded() == ['*'] ||
+            !empty(preg_grep('/^' . preg_quote($key) . '$/i', $this->getGuarded())) ||
+            !$this->isGuardableColumn($key);
+    }
+
+    /**
+     * Determine if the given column is a valid, guardable column.
+     *
+     * @param string $key
+     * @return bool
+     */
+    protected function isGuardableColumn($key)
+    {
+        $this->primeGuardableColumns();
+
+        if(in_array($key, static::$guardableColumns[get_class($this)])) {
+            return true;
+        }
+
+        $this->primeGuardableColumns(true);
+
+        return in_array($key, static::$guardableColumns[get_class($this)]);
+    }
+
+    protected function primeGuardableColumns($forceRefresh = false)
+    {
+        if (!isset(static::$guardableColumns[get_class($this)])) {
+            $columns = $this->getColumns($forceRefresh);
+
+            if (empty($columns)) {
+                return true;
+            }
+            static::$guardableColumns[get_class($this)] = $columns;
+        }
+    }
+
+
+    protected function getColumns($forceRefresh = false): array
+    {
+        $cacheKey = "eloquent-filemaker-{$this->table}-columns";
+        $refreshCallback = function() {
+            $layoutMetaData = $this->getConnection()->getLayoutMetadata($this->table);
+
+            return array_column($layoutMetaData['fieldMetaData'], 'name');
+        };
+
+        if($forceRefresh) {
+            Cache::forever($cacheKey, $columns = $refreshCallback());
+
+            return $columns;
+        }
+
+        return Cache::rememberForever($cacheKey, $refreshCallback);
+    }
+
+}

src/Database/Eloquent/FMModel.php

@@ -2,6 +2,7 @@
 
 namespace BlueFeather\EloquentFileMaker\Database\Eloquent;
 
+use BlueFeather\EloquentFileMaker\Database\Eloquent\Concerns\FMGuardsAttributes;
 use BlueFeather\EloquentFileMaker\Database\Eloquent\Concerns\FMHasRelationships;
 use BlueFeather\EloquentFileMaker\Database\Query\FMBaseBuilder;
 use BlueFeather\EloquentFileMaker\Exceptions\FileMakerDataApiException;
@@ -18,6 +19,7 @@ abstract class FMModel extends Model
 {
 
     use FMHasRelationships;
+    use FMGuardsAttributes;
 
     /**
      * Indicates if the model should be timestamped.
@@ -62,6 +64,13 @@ abstract class FMModel extends Model
      */
     protected $modId;
 
+    /**
+     * The "type" of the primary key ID. FileMaker uses UUID strings by default.
+     *
+     * @var string
+     */
+    protected $keyType = 'string';
+
 
     public function __construct(array $attributes = [])
     {

src/Database/Query/FMBaseBuilder.php

@@ -845,9 +845,13 @@ public function count($columns = '*')
 
     public function whereDate($column, $operator, $value = null, $boolean = 'and')
     {
+        if (is_null($value)) {
+            $value = $operator;
+            $operator = '=';
+        }
 
-        if ($operator instanceof DateTimeInterface) {
-            $operator = $operator->format('n/j/Y');
+        if ($value instanceof DateTimeInterface) {
+            $value = $value->format('n/j/Y');
         }
 
         return $this->where($column, $operator, $value, $boolean);

src/Database/Schema/FMBuilder.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace BlueFeather\EloquentFileMaker\Database\Schema;
+
+class FMBuilder extends \Illuminate\Database\Schema\Builder
+{
+    /**
+     * Get the column listing for a given table.
+     *
+     * @param  string  $table
+     * @return array
+     */
+    public function getColumnListing($table)
+    {
+        $layoutMetaData = $this->connection->getLayoutMetadata($table);
+        $fieldMetaData = $layoutMetaData['fieldMetaData'];
+        $columns = array_column($fieldMetaData, 'name');
+
+        return $columns;
+    }
+
+}

src/Services/FileMakerConnection.php

@@ -7,6 +7,7 @@
 use BlueFeather\EloquentFileMaker\Database\Eloquent\FMEloquentBuilder;
 use BlueFeather\EloquentFileMaker\Database\Query\FMBaseBuilder;
 use BlueFeather\EloquentFileMaker\Database\Query\Grammars\FMGrammar;
+use BlueFeather\EloquentFileMaker\Database\Schema\FMBuilder;
 use BlueFeather\EloquentFileMaker\Exceptions\FileMakerDataApiException;
 use GuzzleHttp\Exception\ConnectException;
 use GuzzleHttp\Exception\RequestException;
@@ -100,8 +101,12 @@ protected function getRecordUrl()
         return $this->getLayoutUrl() . '/records/';
     }
 
-    protected function getLayoutUrl()
+    protected function getLayoutUrl($layout = null)
     {
+        // Set the connection layout as the layout parameter, otherwise get the layout from the connection
+        if($layout){
+            $this->setLayout($layout);
+        }
         return $this->getDatabaseUrl() . '/layouts/' . $this->getLayout();
     }
 
@@ -637,4 +642,16 @@ protected function getDefaultQueryGrammar()
     {
         return new FMGrammar();
     }
+
+    public function getLayoutMetadata($layout = null){
+        $response = $this->makeRequest('get', $this->getLayoutUrl($layout));
+        return $response['response'];
+    }
+
+    public function getSchemaBuilder()
+    {
+        parent::getSchemaBuilder();
+
+        return new FMBuilder($this);
+    }
 }