Merge pull request #4220 from Laravel-Backpack/validation-for-subfields

Always apply field validation, on top of array & formRequest validation

Author: tabacitu

src/BackpackServiceProvider.php

@@ -6,8 +6,6 @@
 use Backpack\CRUD\app\Library\CrudPanel\CrudPanel;
 use Illuminate\Routing\Router;
 use Illuminate\Support\Collection;
-use Illuminate\Support\Facades\App;
-use Illuminate\Support\Facades\Route;
 use Illuminate\Support\ServiceProvider;
 
 class BackpackServiceProvider extends ServiceProvider
@@ -57,6 +55,9 @@ public function boot(\Illuminate\Routing\Router $router)
      */
     public function register()
     {
+        // load the macros
+        include_once __DIR__.'/macros.php';
+
         // Bind the CrudPanel object to Laravel's service container
         $this->app->singleton('crud', function ($app) {
             return new CrudPanel($app);
@@ -67,12 +68,6 @@ public function register()
             return new Collection();
         });
 
-        // load a macro for Route,
-        // helps developers load all routes for a CRUD resource in one line
-        if (! Route::hasMacro('crud')) {
-            $this->addRouteMacro();
-        }
-
         // register the helper functions
         $this->loadHelpers();
 
@@ -179,47 +174,6 @@ public function setupCustomRoutes(Router $router)
         }
     }
 
-    /**
-     * The route macro allows developers to generate the routes for a CrudController,
-     * for all operations, using a simple syntax: Route::crud().
-     *
-     * It will go to the given CrudController and get the setupRoutes() method on it.
-     */
-    private function addRouteMacro()
-    {
-        Route::macro('crud', function ($name, $controller) {
-            // put together the route name prefix,
-            // as passed to the Route::group() statements
-            $routeName = '';
-            if ($this->hasGroupStack()) {
-                foreach ($this->getGroupStack() as $key => $groupStack) {
-                    if (isset($groupStack['name'])) {
-                        if (is_array($groupStack['name'])) {
-                            $routeName = implode('', $groupStack['name']);
-                        } else {
-                            $routeName = $groupStack['name'];
-                        }
-                    }
-                }
-            }
-            // add the name of the current entity to the route name prefix
-            // the result will be the current route name (not ending in dot)
-            $routeName .= $name;
-
-            // get an instance of the controller
-            if ($this->hasGroupStack()) {
-                $groupStack = $this->getGroupStack();
-                $groupNamespace = $groupStack && isset(end($groupStack)['namespace']) ? end($groupStack)['namespace'].'\\' : '';
-            } else {
-                $groupNamespace = '';
-            }
-            $namespacedController = $groupNamespace.$controller;
-            $controllerInstance = App::make($namespacedController);
-
-            return $controllerInstance->setupRoutes($name, $routeName, $controller);
-        });
-    }
-
     public function loadViewsWithFallbacks()
     {
         $customBaseFolder = resource_path('views/vendor/backpack/base');

src/app/Library/CrudPanel/CrudField.php

@@ -25,6 +25,8 @@
  * @method self wrapper(array $value)
  * @method self fake(bool $value)
  * @method self store_in(string $value)
+ * @method self validationRules(string $value)
+ * @method self validationMessages(array $value)
  */
 class CrudField
 {
@@ -195,6 +197,40 @@ public function subfields($subfields)
         return $this->save();
     }
 
+    /**
+     * Save the validation rules on the CrudPanel per field basis.
+     *
+     * @param  string  $rules  the field rules: required|min:1|max:5
+     * @return self
+     */
+    public function validationRules(string $rules)
+    {
+        $this->attributes['validationRules'] = $rules;
+        $this->crud()->setValidationFromArray([$this->attributes['name'] => $rules]);
+
+        return $this;
+    }
+
+    /**
+     * Save the validation messages on the CrudPanel per field basis.
+     *
+     * @param  array  $messages  the messages for field rules: [required => please input something, min => the minimum allowed is 1]
+     * @return self
+     */
+    public function validationMessages(array $messages)
+    {
+        $this->attributes['validationMessages'] = $messages;
+
+        // append the field name to the rule name of validationMessages array.
+        // eg: ['required => 'This field is required']
+        // will be transformed into: ['field_name.required' => 'This field is required]
+        $this->crud()->setValidationFromArray([], array_merge(...array_map(function ($rule, $message) {
+            return [$this->attributes['name'].'.'.$rule => $message];
+        }, array_keys($messages), $messages)));
+
+        return $this;
+    }
+
     // ---------------
     // PRIVATE METHODS
     // ---------------

src/app/Library/CrudPanel/Traits/Fields.php

@@ -58,6 +58,8 @@ public function makeSureFieldHasNecessaryAttributes($field)
         $field = $this->makeSureFieldHasType($field);
         $field = $this->makeSureSubfieldsHaveNecessaryAttributes($field);
 
+        $this->setupFieldValidation($field, $field['parentFieldName'] ?? false);
+
         return $field;
     }
 

src/app/Library/CrudPanel/Traits/FieldsProtectedMethods.php

@@ -268,6 +268,8 @@ protected function makeSureSubfieldsHaveNecessaryAttributes($field)
                 $subfield = ['name' => $subfield];
             }
 
+            $subfield['parentFieldName'] = $field['name'];
+
             if (! isset($field['model'])) {
                 // we're inside a simple 'repeatable' with no model/relationship, so
                 // we assume all subfields are supposed to be text fields
@@ -292,6 +294,7 @@ protected function makeSureSubfieldsHaveNecessaryAttributes($field)
                 case 'MorphToMany':
                 case 'BelongsToMany':
                     $pivotSelectorField = static::getPivotFieldStructure($field);
+                    $this->setupFieldValidation($pivotSelectorField, $field['name']);
                     $field['subfields'] = Arr::prepend($field['subfields'], $pivotSelectorField);
                     break;
                 case 'MorphMany':

src/app/Library/CrudPanel/Traits/Relationships.php

@@ -299,6 +299,10 @@ private static function getPivotFieldStructure($field)
         $pivotSelectorField['delay'] = 500;
         $pivotSelectorField['placeholder'] = trans('backpack::crud.select_entry');
         $pivotSelectorField['label'] = \Str::of($field['name'])->singular()->ucfirst();
+        $pivotSelectorField['validationRules'] = 'required';
+        $pivotSelectorField['validationMessages'] = [
+            'required' => trans('backpack::crud.pivot_selector_required_validation_message'),
+        ];
 
         if (isset($field['baseModel'])) {
             $pivotSelectorField['baseModel'] = $field['baseModel'];