#175 option generalErrorPosition to enable displaying of general error message

Author: Eugene Tupikov

CHANGELOG.md

@@ -6,6 +6,7 @@ Yii2 multiple input change log
 - #215 collect all js script that has to be evaluate when add new row (not only from " on ready" section)
 - #198 introduce the option `theme` to disable all bootstrap css classes
 - #197 explicitly set tabindex for all inputs
+- #175 option `generalErrorPosition` to enable displaying of general error message 
 
 2.16.0
 ======

examples/models/ExampleModel.php

@@ -96,7 +96,7 @@ public function rules()
             ['title', 'string', 'min' => 5],
             ['emails', 'validateEmails'],
             ['phones', 'validatePhones'],
-            ['schedule', 'validateSchedule'],
+            ['schedule', 'validateSchedule', 'skipOnEmpty' => false],
             ['questions', 'validateQuestions']
         ];
     }

examples/views/multiple-input.php

@@ -21,6 +21,7 @@
     'validateOnBlur'            => false,
 ]);?>
 
+
 <h3>Single column</h3>
 <?php
     echo $form->field($model, 'emails')->widget(MultipleInput::className(), [
@@ -52,6 +53,7 @@
     'max' => 4,
     'sortable' => true,
     'allowEmptyList' => true,
+    'generalErrorPosition' => 'top',
     'rowOptions' => function($model) {
         $options = [];
 

src/MultipleInput.php

@@ -37,11 +37,14 @@ class MultipleInput extends InputWidget
 
     const ICONS_SOURCE_GLYPHICONS  = 'glyphicons';
     const ICONS_SOURCE_FONTAWESOME = 'fa';
+    
+    const GENERAL_ERROR_POS_TOP     = 'top';
+    const GENERAL_ERROR_POS_BOTTOM  = 'bottom';
 
     /**
      * @var ActiveRecordInterface[]|array[] input data
      */
-    public $data = null;
+    public $data;
 
     /**
      * @var array columns configuration
@@ -205,6 +208,17 @@ class MultipleInput extends InputWidget
      */
     public $theme = self::THEME_BS;
 
+    /**
+     * @var string|null set a position of generic error message (when you set an error for generic field instead of particular input)
+     * If set to null no generic error message will be shown. 
+     */
+    public $generalErrorPosition;
+
+    /**
+     * @var bool
+     */
+    private $showGeneralError = false;
+
     /**
      * Initialization.
      *
@@ -216,6 +230,16 @@ public function init()
             throw new InvalidConfigException('Property "form" must be an instance of yii\widgets\ActiveForm');
         }
 
+        $this->showGeneralError = $this->generalErrorPosition !== null && !$this->isEmbedded && $this->field;
+
+        if ($this->showGeneralError) {
+            if ($this->generalErrorPosition === self::GENERAL_ERROR_POS_BOTTOM) {
+                $this->field->template = "{input}\n{error}";
+            } else {
+                $this->field->template = "{error}\n{input}";
+            }
+        }
+
         $this->guessColumns();
         $this->initData();
 
@@ -276,9 +300,10 @@ protected function guessColumns()
     public function run()
     {
         $content = '';
-        if ($this->hasModel() && $this->isEmbedded === false) {
+        if ($this->isEmbedded === false && $this->hasModel()) {
             $content .= Html::hiddenInput(Html::getInputName($this->model, $this->attribute), null);
         }
+
         $content .= $this->createRenderer()->render();
 
         return $content;
@@ -339,6 +364,12 @@ private function createRenderer()
             'theme'             => $this->theme
         ];
 
+        if ($this->showGeneralError) {
+            $config['jsExtraSettings'] = [
+                'showGeneralError' => true
+            ];
+        }
+        
         if ($this->removeButtonOptions !== null) {
             $config['removeButtonOptions'] = $this->removeButtonOptions;
         }

src/assets/src/js/jquery.multipleInput.js

@@ -99,7 +99,9 @@
         /**
          * default prefix of a widget's placeholder
          */
-        indexPlaceholder: 'multiple_index'
+        indexPlaceholder: 'multiple_index',
+
+        showGeneralError: false
     };
 
     var isActiveFormEnabled = false;
@@ -162,7 +164,9 @@
                             }
                         });
 
-                        form.yiiActiveForm('remove', inputId);
+                        if (!settings.showGeneralError) {
+                            form.yiiActiveForm('remove', inputId);
+                        }
                     }
 
                     // append default options to option from settings

src/assets/src/js/jquery.multipleInput.min.js

@@ -107,7 +107,7 @@ abstract class BaseRenderer extends BaseObject implements RendererInterface
     public $columnClass;
 
     /**
-     * @var string position of add button. By default button is rendered in the row.
+     * @var array|string position of add button. By default button is rendered in the row.
      */
     public $addButtonPosition = self::POS_ROW;
 
@@ -178,6 +178,11 @@ abstract class BaseRenderer extends BaseObject implements RendererInterface
      */
     public $theme = self::THEME_BS;
 
+    /**
+     * @var array
+     */
+    public $jsExtraSettings = [];
+
     /**
      * @inheritdoc
      */
@@ -392,7 +397,7 @@ public function render()
             }
         }
 
-        $options = Json::encode([
+        $options = Json::encode(array_merge([
             'id'                => $this->id,
             'inputId'           => $this->context->options['id'],
             'template'          => $template,
@@ -402,7 +407,7 @@ public function render()
             'min'               => $this->min,
             'attributes'        => $this->prepareJsAttributes(),
             'indexPlaceholder'  => $this->getIndexPlaceholder()
-        ]);
+        ], $this->jsExtraSettings));
 
         $js = "jQuery('#{$this->id}').multipleInput($options);";
         $view->registerJs($js);
@@ -519,7 +524,7 @@ protected function prepareJsAttributes()
                 if (isset($attributeOptions['name']) && $attributeOptions['name'] === $column->name) {
                     $attributes[$inputID] = ArrayHelper::merge($attributeOptions, $column->attributeOptions);
                 } else {
-                    array_push($this->form->attributes, $attributeOptions);
+                    $this->form->attributes[] = $attributeOptions;
                 }
             } else {
                 $attributes[$inputID] = $column->attributeOptions;