[Release] CRUD 3.4 Upgrade

CHANGELOG.md

@@ -20,6 +20,22 @@ All Notable changes to `Backpack CRUD` will be documented in this file
 - Nothing
 -----------
 
+## Unreleased
+
+## Added
+- one-line installation command ```php artisan backpack:crud:install```;
+- 1-1 relatiosnhips; merges #865;
+
+## Fixed
+- ```checkbox``` field was using the default value over the DB value on edit; merges #1239;
+- no longer registering Base, Elfinder and Image service providers and aliases, since they all now use auto-load; merges #1279;
+- datatables responsive working with colvis and export buttons;
+
+### Removed
+- elFinder is no longer a dependency; users should require it themselves, if they need it;
+
+-----------
+
 ## [3.3.17] - 2018-03-21
 
 ## Fixed

composer.json

@@ -25,7 +25,6 @@
     ],
     "require": {
         "backpack/base": "^0.8.0",
-        "barryvdh/laravel-elfinder": "^0.3.10",
         "doctrine/dbal": "^2.5",
         "venturecraft/revisionable": "1.*",
         "intervention/image": "^2.3"

src/CrudPanel.php

@@ -21,6 +21,7 @@
 use Backpack\CRUD\PanelTraits\AutoFocus;
 use Backpack\CRUD\PanelTraits\FakeFields;
 use Backpack\CRUD\PanelTraits\FakeColumns;
+use Illuminate\Database\Eloquent\Collection;
 use Backpack\CRUD\PanelTraits\ViewsAndRestoresRevisions;
 
 class CrudPanel
@@ -255,16 +256,91 @@ public function sort($items)
      *          App/Models/Address defined by a company() method on the user model and an address() method on the
      *          company model, the 'App/Models/Address' string will be returned.
      *
-     * @param $relationString String Relation string. A dot notation can be used to chain multiple relations.
+     * @param string $relationString Relation string. A dot notation can be used to chain multiple relations.
+     * @param int $length Optionally specify the number of relations to omit from the start of the relation string. If
+     *        the provided length is negative, then that many relations will be omitted from the end of the relation
+     *        string.
+     * @param \Illuminate\Database\Eloquent\Model $model Optionally specify a different model than the one in the crud object.
      *
-     * @return string relation model name
+     * @return string Relation model name.
      */
-    private function getRelationModel($relationString)
+    public function getRelationModel($relationString, $length = null, $model = null)
     {
-        $result = array_reduce(explode('.', $relationString), function ($obj, $method) {
+        $relationArray = explode('.', $relationString);
+
+        if (! isset($length)) {
+            $length = count($relationArray);
+        }
+
+        if (! isset($model)) {
+            $model = $this->model;
+        }
+
+        $result = array_reduce(array_splice($relationArray, 0, $length), function ($obj, $method) {
             return $obj->$method()->getRelated();
-        }, $this->model);
+        }, $model);
 
         return get_class($result);
     }
+
+    /**
+     * Get the given attribute from a model or models resulting from the specified relation string (eg: the list of streets from
+     * the many addresses of the company of a given user).
+     *
+     * @param \Illuminate\Database\Eloquent\Model $model Model (eg: user).
+     * @param string $relationString Model relation. Can be a string representing the name of a relation method in the given
+     *        Model or one from a different Model through multiple relations. A dot notation can be used to specify
+     *        multiple relations (eg: user.company.address).
+     * @param string $attribute The attribute from the relation model (eg: the street attribute from the address model).
+     *
+     * @return array An array containing a list of attributes from the resulting model.
+     */
+    public function getModelAttributeFromRelation($model, $relationString, $attribute)
+    {
+        $endModels = $this->getRelationModelInstances($model, $relationString);
+        $attributes = [];
+        foreach ($endModels as $model) {
+            if ($model->{$attribute}) {
+                $attributes[] = $model->{$attribute};
+            }
+        }
+
+        return $attributes;
+    }
+
+    /**
+     * Traverse the tree of relations for the given model, defined by the given relation string, and return the ending
+     * associated model instance or instances.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $model The CRUD model.
+     * @param string $relationString Relation string. A dot notation can be used to chain multiple relations.
+     * @return array An array of the associated model instances defined by the relation string.
+     */
+    private function getRelationModelInstances($model, $relationString)
+    {
+        $relationArray = explode('.', $relationString);
+        $firstRelationName = array_first($relationArray);
+        $relation = $model->{$firstRelationName};
+
+        $results = [];
+        if (! empty($relation)) {
+            if ($relation instanceof Collection) {
+                $currentResults = $relation->toArray();
+            } else {
+                $currentResults[] = $relation;
+            }
+
+            array_shift($relationArray);
+
+            if (! empty($relationArray)) {
+                foreach ($currentResults as $currentResult) {
+                    $results = array_merge($results, $this->getRelationModelInstances($currentResult, implode('.', $relationArray)));
+                }
+            } else {
+                $results = $currentResults;
+            }
+        }
+
+        return $results;
+    }
 }

src/CrudServiceProvider.php

@@ -7,6 +7,10 @@
 
 class CrudServiceProvider extends ServiceProvider
 {
+    protected $commands = [
+        \Backpack\CRUD\app\Console\Commands\Install::class,
+    ];
+
     /**
      * Indicates if loading of the provider is deferred.
      *
@@ -76,14 +80,8 @@ public function register()
             return new CRUD($app);
         });
 
-        // register its dependencies
-        $this->app->register(\Backpack\Base\BaseServiceProvider::class);
-        $this->app->register(\Barryvdh\Elfinder\ElfinderServiceProvider::class);
-        $this->app->register(\Intervention\Image\ImageServiceProvider::class);
-
-        // register their aliases
-        $loader = \Illuminate\Foundation\AliasLoader::getInstance();
-        $loader->alias('Image', \Intervention\Image\Facades\Image::class);
+        // register the artisan commands
+        $this->commands($this->commands);
 
         // map the elfinder prefix
         if (! \Config::get('elfinder.route.prefix')) {

src/PanelTraits/Create.php

@@ -2,6 +2,9 @@
 
 namespace Backpack\CRUD\PanelTraits;
 
+use Illuminate\Database\Eloquent\Relations\HasOne;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+
 trait Create
 {
     /*
@@ -22,12 +25,12 @@ public function create($data)
         $data = $this->decodeJsonCastedAttributes($data, 'create');
         $data = $this->compactFakeFields($data, 'create');
 
-        // ommit the n-n relationships when updating the eloquent item
+        // omit the n-n relationships when updating the eloquent item
         $nn_relationships = array_pluck($this->getRelationFieldsWithPivot('create'), 'name');
         $item = $this->model->create(array_except($data, $nn_relationships));
 
         // if there are any relationships available, also sync those
-        $this->syncPivot($item, $data);
+        $this->createRelations($item, $data);
 
         return $item;
     }
@@ -92,6 +95,26 @@ public function getRelationFieldsWithPivot($form = 'create')
         });
     }
 
+    /**
+     * Create the relations for the current model.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $item The current CRUD model.
+     * @param array $data The form data.
+     * @param string $form Optional form type. Can be either 'create', 'update' or 'both'. Default is 'create'.
+     */
+    public function createRelations($item, $data, $form = 'create')
+    {
+        $this->syncPivot($item, $data, $form);
+        $this->createOneToOneRelations($item, $data, $form);
+    }
+
+    /**
+     * Sync the declared many-to-many associations through the pivot field.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $model The current CRUD model.
+     * @param array $data The form data.
+     * @param string $form Optional form type. Can be either 'create', 'update' or 'both'. Default is 'create'.
+     */
     public function syncPivot($model, $data, $form = 'create')
     {
         $fields_with_relationships = $this->getRelationFields($form);
@@ -116,4 +139,96 @@ public function syncPivot($model, $data, $form = 'create')
             }
         }
     }
+
+    /**
+     * Create any existing one to one relations for the current model from the form data.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $item The current CRUD model.
+     * @param array $data The form data.
+     * @param string $form Optional form type. Can be either 'create', 'update' or 'both'. Default is 'create'.
+     */
+    private function createOneToOneRelations($item, $data, $form = 'create')
+    {
+        $relationData = $this->getRelationDataFromFormData($data, $form);
+        $this->createRelationsForItem($item, $relationData);
+    }
+
+    /**
+     * Create any existing one to one relations for the current model from the relation data.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $item The current CRUD model.
+     * @param array $formattedData The form data.
+     */
+    private function createRelationsForItem($item, $formattedData)
+    {
+        foreach ($formattedData['relations'] as $relationMethod => $relationData) {
+            $model = $relationData['model'];
+            $relation = $item->{$relationMethod}();
+
+            if ($relation instanceof BelongsTo) {
+                $modelInstance = $model::find($relationData['values'])->first();
+                if ($modelInstance != null) {
+                    $relation->associate($modelInstance)->save();
+                } else {
+                    $relation->dissociate()->save();
+                }
+            } elseif ($relation instanceof HasOne) {
+                if ($item->{$relationMethod} != null) {
+                    $item->{$relationMethod}->update($relationData['values']);
+                    $modelInstance = $item->{$relationMethod};
+                } else {
+                    $relationModel = new $model();
+                    $modelInstance = $relationModel->create($relationData['values']);
+                    $relation->save($modelInstance);
+                }
+            } else {
+                $relationModel = new $model();
+                $modelInstance = $relationModel->create($relationData['values']);
+                $relation->save($modelInstance);
+            }
+
+            if (isset($relationData['relations'])) {
+                $this->createRelationsForItem($modelInstance, ['relations' => $relationData['relations']]);
+            }
+        }
+    }
+
+    /**
+     * Get a relation data array from the form data.
+     * For each relation defined in the fields through the entity attribute, set the model, the parent model and the
+     * attribute values. For relations defined with the "dot" notations, this will be used to calculate the depth in the
+     * final array (@see \Illuminate\Support\Arr::set() for more).
+     *
+     * @param array $data The form data.
+     * @param string $form Optional form type. Can be either 'create', 'update' or 'both'. Default is 'create'.
+     *
+     * @return array The formatted relation data.
+     */
+    private function getRelationDataFromFormData($data, $form = 'create')
+    {
+        $relationFields = $this->getRelationFields($form);
+
+        $relationData = [];
+        foreach ($relationFields as $relationField) {
+            $attributeKey = $relationField['name'];
+            if (array_key_exists($attributeKey, $data) && empty($relationField['pivot'])) {
+                $key = implode('.relations.', explode('.', $relationField['entity']));
+                $fieldData = array_get($relationData, 'relations.'.$key, []);
+
+                if (! array_key_exists('model', $fieldData)) {
+                    $fieldData['model'] = $relationField['model'];
+                }
+
+                if (! array_key_exists('parent', $fieldData)) {
+                    $fieldData['parent'] = $this->getRelationModel($relationField['entity'], -1);
+                }
+
+                $fieldData['values'][$attributeKey] = $data[$attributeKey];
+
+                array_set($relationData, 'relations.'.$key, $fieldData);
+            }
+        }
+
+        return $relationData;
+    }
 }

src/PanelTraits/Search.php

@@ -113,12 +113,13 @@ public function getRowViews($entry)
                                 ->render();
         }
 
-        // add the details_row buttons as the first column
+        // add the details_row button to the first column
         if ($this->details_row) {
-            array_unshift($row_items, \View::make('crud::columns.details_row_button')
+            $details_row_button = \View::make('crud::columns.details_row_button')
                                            ->with('crud', $this)
                                            ->with('entry', $entry)
-                                           ->render());
+                                           ->render();
+            $row_items[0] = $details_row_button.$row_items[0];
         }
 
         return $row_items;