Added support of anonymous function for items attribute

Eugene Tupikov · Eugene Tupikov · commit 634c580e015b · 2015-09-08T09:56:32.000+06:00
diff --git a/README.md b/README.md
@@ -49,7 +49,8 @@ Widget support the following options that are additionally recognized over and a
   - `title` *string*: the column title
   - `value` *Closure*: you can set it to an anonymous function with the following signature: ```function($data) {}```
   - `defaultValue` *string*: default value of input,
-  - `items` *array*: the items for input with type dropDownList, listBox, checkboxList, radioList
+  - `items` *array*|*Closure*: the items for input with type dropDownList, listBox, checkboxList, radioList or anonymous function
+  which return array of items and has thw following signature: ```function($data) {}```
   - `options` *array*: the HTML attributes for the input
   - `headerOptions` *array*: the HTML attributes for the header cell
   - `enableError` *boolean*: whether to render inline error for the input. Default to `false`
diff --git a/examples/views/multiple-input.php b/examples/views/multiple-input.php
@@ -4,7 +4,6 @@
 use unclead\widgets\MultipleInput;
 use unclead\widgets\examples\models\ExampleModel;
 use yii\helpers\Html;
-use nex\chosen\Chosen;
 use unclead\widgets\MultipleInputColumn;
 
 // Note: You have to install https://github.com/kartik-v/yii2-widget-datepicker for correct work an example
@@ -41,14 +40,26 @@
             'enableError' => true,
             'title' => 'User',
             'defaultValue' => 33,
-            'items' => [
+            /* it can be an anonymous function
+            'items' => function($data) {
+                return [
+                    31 => 'item 31',
+                    32 => 'item 32',
+                    33 => 'item 33',
+                    34 => 'item 34',
+                    35 => 'item 35',
+                    36 => 'item 36',
+                ];
+            }
+            */
+            'items' =>  [
                 31 => 'item 31',
                 32 => 'item 32',
                 33 => 'item 33',
                 34 => 'item 34',
                 35 => 'item 35',
                 36 => 'item 36',
-            ],
+            ]
         ],
         [
             'name'  => 'day',
@@ -83,7 +94,7 @@
         ],
         [
             'name'  => 'comment',
-            'type'  => 'static',
+            'type'  => MultipleInputColumn::TYPE_STATIC,
             'value' => function($data) {
                 return Html::tag('span', 'static content', ['class' => 'label label-info']);
             },
diff --git a/src/components/BaseColumn.php b/src/components/BaseColumn.php
@@ -50,7 +50,7 @@ abstract class BaseColumn extends Object
     public $type;
 
     /**
-     * @var string|Closure
+     * @var string|\Closure
      */
     public $value;
 
@@ -60,7 +60,23 @@ abstract class BaseColumn extends Object
     public $defaultValue;
 
     /**
-     * @var array
+     * @var array|\Closure items which used for rendering input with multiple choice, e.g. dropDownList. It can be an array
+     * or anonymous function with following signature:
+     *
+     * ```
+     *
+     * 'columns' => [
+     *     ...
+     *     [
+     *          'name' => 'column',
+     *          'items' => function($data) {
+     *             // do your magic
+     *          }
+     *          ....
+     *      ]
+     * ...
+     *
+     * ```
      */
     public $items;
 
@@ -85,7 +101,7 @@ abstract class BaseColumn extends Object
     public $errorOptions = ['class' => 'help-block help-block-error'];
 
     /**
-     * @var BaseRenderer
+     * @var BaseRenderer the renderer instance
      */
     public $renderer;
 
@@ -150,11 +166,11 @@ public function isHiddenInput()
     /**
      * Prepares the value of column.
      *
-     * @param array|ActiveRecord $data
      * @return mixed
      */
-    public function prepareValue($data)
+    protected function prepareValue()
     {
+        $data = $this->getModel();
         if ($this->value !== null) {
             $value = $this->value;
             if ($value instanceof \Closure) {
@@ -208,15 +224,15 @@ private function normalize($name) {
      * Renders the input.
      *
      * @param string $name name of the input
-     * @param mixed $value value of the input
      * @param array $options the input options
      * @return string
      */
-    public function renderInput($name, $value, $options)
+    public function renderInput($name, $options)
     {
         $options = array_merge($this->options, $options);
         $method = 'render' . Inflector::camelize($this->type);
 
+        $value = $this->prepareValue();
         if (method_exists($this, $method)) {
             $input = call_user_func_array([$this, $method], [$name, $value, $options]);
         } else {
@@ -227,6 +243,8 @@ public function renderInput($name, $value, $options)
 
 
     /**
+     * Renders drop down list.
+     *
      * @param $name
      * @param $value
      * @param $options
@@ -235,7 +253,21 @@ public function renderInput($name, $value, $options)
     protected function renderDropDownList($name, $value, $options)
     {
         Html::addCssClass($options, 'form-control');
-        return Html::dropDownList($name, $value, $this->items, $options);
+        return Html::dropDownList($name, $value, $this->prepareItems(), $options);
+    }
+
+    /**
+     * Returns the items for list.
+     *
+     * @return array|Closure|mixed
+     */
+    private function prepareItems()
+    {
+        if ($this->items instanceof \Closure) {
+            return call_user_func($this->items, $this->getModel());
+        } else {
+            return $this->items;
+        }
     }
 
     /**
@@ -247,7 +279,7 @@ protected function renderDropDownList($name, $value, $options)
     protected function renderListBox($name, $value, $options)
     {
         Html::addCssClass($options, 'form-control');
-        return Html::listBox($name, $value, $this->items, $options);
+        return Html::listBox($name, $value, $this->prepareItems(), $options);
     }
 
     /**
@@ -293,7 +325,7 @@ protected function renderRadioList($name, $value, $options)
         $options['item'] = function ($index, $label, $name, $checked, $value) {
             return '<div class="radio">' . Html::radio($name, $checked, ['label' => $label, 'value' => $value]) . '</div>';
         };
-        $input = Html::radioList($name, $value, $this->items, $options);
+        $input = Html::radioList($name, $value, $this->prepareItems(), $options);
         return Html::tag('div', $input, ['class' => 'radio-list']);
     }
 
@@ -329,7 +361,7 @@ protected function renderCheckboxList($name, $value, $options)
         $options['item'] = function ($index, $label, $name, $checked, $value) {
             return '<div class="checkbox">' . Html::checkbox($name, $checked, ['label' => $label, 'value' => $value]) . '</div>';
         };
-        $input = Html::checkboxList($name, $value, $this->items, $options);
+        $input = Html::checkboxList($name, $value, $this->prepareItems(), $options);
         return Html::tag('div', $input, ['class' => 'checkbox-list']);
     }
 
diff --git a/src/renderers/TableRenderer.php b/src/renderers/TableRenderer.php
@@ -133,9 +133,9 @@ private function renderRowContent($index = null, $item = null)
             /* @var $column BaseColumn */
             $column->setModel($item);
             if ($column->isHiddenInput()) {
-                $hiddenInputs[] = $this->renderCellContent($column, $index, $item);
+                $hiddenInputs[] = $this->renderCellContent($column, $index);
             } else {
-                $cells[] = $this->renderCellContent($column, $index, $item);
+                $cells[] = $this->renderCellContent($column, $index);
             }
         }
 
@@ -160,15 +160,13 @@ private function renderRowContent($index = null, $item = null)
      *
      * @param BaseColumn $column
      * @param int|null $index
-     * @param $data
      * @return string
      */
-    public function renderCellContent($column, $index, $data)
+    public function renderCellContent($column, $index)
     {
         $id    = $column->getElementId($index);
-        $value = $column->prepareValue($data);
         $name  = $column->getElementName($index);
-        $input = $column->renderInput($name, $value, [
+        $input = $column->renderInput($name, [
             'id' => $id
         ]);
 
