Added support for setting filename when inserting files into a container

Author: David Nahodyl

README.md

@@ -89,7 +89,21 @@ Many fields in your FileMaker database will be read-only, such as summaries and
 ### Container Fields
 This package supports both reading and writing container field data. Container fields are retrieved from FileMaker as attributes on your model which will contain a URL which can be used to retrieve the file from the container.
 
-When setting a container field you should set it as an `Illuminate/HTTP/File` object. These attributes will be written back to your container fields along with any other model updates when the `save()` method is called on your model object.
+#### Writing to container fields
+When setting a container field you should set the value to be an `Illuminate/HTTP/File` or `Illuminate/HTTP/UploadedFile` object. These attributes will be written back to your container fields along with any other model updates when the `save()` method is called on your model object.
+```
+  $file = new File(storage_path('app/public/gator.jpg'));
+  $newPet->photo = $file;
+  $newPet->save();
+```
+
+#### Custom filenames when inserting files into containers
+By default, files are inserted into containers using the filename of the file you are inserting. If you wish to set a new filename when the file is inserted into the container you can do so by passing the file and filename together in an array when setting your container.
+```
+  $file = new File(storage_path('app/public/gator.jpg'));
+  $newPet->photo = [$file, 'fluffy.jpg'];
+  $newPet->save();
+```
 
 ### Renaming and Mapping FileMaker Fields
 Sometimes you might be working with a FileMaker database with inconvenient field names. These fields can be remapped to model attributes by setting the `$fieldMapping` attribute. This should be an array of strings, mapping FileMaker Field Name => New Attribute Name. You can then use these names as regular Eloquent attributes and they will work with the correct fields in FileMaker

src/Database/Eloquent/FMModel.php

@@ -10,6 +10,7 @@
 use Illuminate\Database\Eloquent\Relations\Concerns\AsPivot;
 use Illuminate\Database\Eloquent\Relations\Pivot;
 use Illuminate\Http\File;
+use Illuminate\Http\UploadedFile;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 
@@ -401,11 +402,11 @@ public function getAttributesForFileMakerWrite()
         // Remove any fields which have been set to write a file, as they should be handled as containers
         foreach ($fieldData as $key => $field){
             // remove any containers to be written.
-            if (is_a($field, File::class)){
+            // users can set the field to be a File, UploadFile, or array [$file, 'MyFile.pdf']
+            if ($this->isContainer($field)){
                 $fieldData->forget($key);
             }
         }
-        //$fieldData->forget($this->getContainerFields());
         return $fieldData;
     }
 
@@ -419,14 +420,24 @@ public function getContainersToWrite(){
         // Track any fields which have been set to write a file, as they should be handled as containers
         foreach ($fieldData as $key => $field){
             // remove any containers to be written.
-            if (is_a($field, File::class)){
+            if ($this->isContainer($field)){
                 $containers->push($key);
             }
         }
 
         return $containers;
     }
 
+    protected function isContainer($field){
+        return
+            is_a($field, File::class) ||
+            is_a($field, UploadedFile::class) ||
+            (
+                is_array($field) &&
+                sizeof($field) === 2
+            );
+    }
+
     /**
      * Get the table associated with the model.
      *

src/Database/Query/FMBaseBuilder.php

@@ -8,6 +8,7 @@
 use BlueFeather\EloquentFileMaker\Services\FileMakerConnection;
 use Illuminate\Database\Query\Builder;
 use Illuminate\Http\File;
+use Illuminate\Http\UploadedFile;
 use Illuminate\Support\Collection;
 use InvalidArgumentException;
 
@@ -528,7 +529,12 @@ public function portalData($array)
     }
 
 
-    public function setContainer($column, File $file)
+    /**
+     * @param String $column The name of the container field
+     * @param File | UploadedFile | array $file The file to be uploaded to the container or a file and filename array ex: [$file, 'MyFile.pdf']
+     * @return mixed
+     */
+    public function setContainer($column, $file)
     {
         $this->containerFieldName = $this->getMappedFieldName($column);
         $this->containerFile = $file;

src/Services/FileMakerConnection.php

@@ -30,7 +30,6 @@ class FileMakerConnection extends Connection
     protected $retries = 1;
 
 
-
     /**
      * Set the name of the connected database.
      *
@@ -137,7 +136,7 @@ protected function checkResponseForErrors($response)
     {
         $messages = Arr::get($response, 'messages', []);
 
-        if ($messages){
+        if ($messages) {
             foreach ($messages as $message) {
                 $code = (int)$message['code'];
 
@@ -157,7 +156,7 @@ protected function checkResponseForErrors($response)
                     }
                 }
             }
-        } else{
+        } else {
             $response->throw();
         }
 
@@ -169,12 +168,24 @@ public function uploadToContainerField(FMBaseBuilder $query)
         $this->setLayout($query->from);
         $url = $this->getRecordUrl() . $query->getRecordId() . '/containers/' . $query->containerFieldName;
 
-        $file = $query->containerFile;
+        /*
+         * The user can insert an array for the file to specify the file name, so we can check for that here
+         * The array should be in the format:
+         * [ $file, 'myFile.pdf' ]
+         */
+        if (is_array($query->containerFile)){
+            // we have a file and file name
+            $file = $query->containerFile[0];
+            $filename = $query->containerFile[1];
+        } else{
+            $file = $query->containerFile;
+            $filename = $file->getFilename();
+        }
 
         // create a stream resource
         $stream = fopen($file->getPathname(), 'r');
 
-        $request = Http::attach('upload', $stream, $file->getFilename());
+        $request = Http::attach('upload', $stream, $filename);
         $response = $this->makeRequest('post', $url, [], $request);
 
         return $response;
@@ -323,26 +334,26 @@ public function editRecord(FMBaseBuilder $query)
     /**
      * Attempt to emulate a sql update in FileMaker
      *
-     * @param  FMBaseBuilder  $query
-     * @param  array  $bindings
+     * @param FMBaseBuilder $query
+     * @param array $bindings
      * @return int
      */
     public function update($query, $bindings = [])
     {
         // If there's no FM Record ID it means we need to find a set of records and then update the results
-        if (!$query->getRecordId()){
+        if (!$query->getRecordId()) {
             // There's no FileMaker Record ID
             return $this->performFindAndUpdateResults($query);
         }
 
         // This is just a single record to edit
-        try{
+        try {
             // Do the update
             $this->editRecord($query);
-        } catch (FileMakerDataApiException $e){
+        } catch (FileMakerDataApiException $e) {
             // Record is missing is ok for laravel functions
             // Throw if it isn't error code 101, which is missing record
-            if ($e->getCode() !== 101){
+            if ($e->getCode() !== 101) {
                 throw $e;
             }
             // Error 101 - Record Not Found
@@ -358,14 +369,15 @@ public function update($query, $bindings = [])
      * @return int
      * @throws FileMakerDataApiException
      */
-    protected function performFindAndUpdateResults(FMBaseBuilder $query){
+    protected function performFindAndUpdateResults(FMBaseBuilder $query)
+    {
         // find the records in the find request query
         $findQuery = clone $query;
         $findQuery->fieldData = null;
         try {
             $results = $this->performFind($findQuery);
-        } catch (FileMakerDataApiException $e){
-            if ($e->getCode() === 401){
+        } catch (FileMakerDataApiException $e) {
+            if ($e->getCode() === 401) {
                 // no records match request
                 // we should exit here
                 // return 0 to show that no records were updated;
@@ -375,27 +387,28 @@ protected function performFindAndUpdateResults(FMBaseBuilder $query){
 
         $records = $results['response']['data'];
         $updatedCount = 0;
-        foreach ($records as $record){
+        foreach ($records as $record) {
             // update each record
             $builder = new FMBaseBuilder($this);
             $builder->recordId($record['recordId']);
             $builder->fieldData = $query->fieldData;
             $builder->layout($query->from);
-            try{
+            try {
                 // Do the update
                 $this->editRecord($builder);
                 // Update if we don't get a record missing exception
                 $updatedCount++;
-            } catch (FileMakerDataApiException $e){
+            } catch (FileMakerDataApiException $e) {
                 // Record is missing is ok for laravel functions
                 // Throw if it isn't error code 101, which is missing record
-                if ($e->getCode() !== 101){
+                if ($e->getCode() !== 101) {
                     throw $e;
                 }
             }
         }
 
-        return count($records);    }
+        return count($records);
+    }
 
     /**
      * @param FMBaseBuilder $query
@@ -411,7 +424,7 @@ public function createRecord(FMBaseBuilder $query)
         $postData = $this->buildPostDataFromQuery($query);
 
         // fieldData is required for create, so fill a blank value if none exists
-        if (!isset($postData['fieldData'])){
+        if (!isset($postData['fieldData'])) {
             $postData['fieldData'] = json_decode("{}");
         }