Merge pull request #275 from bscheshirwork/add-template-for-input

- Add template for input
- Pass more params to a prepareValue closure
- implement DivRenderer

Author: unclead

src/components/BaseColumn.php

@@ -150,6 +150,12 @@ abstract class BaseColumn extends BaseObject
      */
     public $columnOptions = [];
 
+    /**
+     * @var string the template of input for customize view.
+     * For example: '<div class="input-group"><span class="input-group-addon"><i class="fas fa-mobile-alt"></i></span>{input}</div>'
+     */
+    public $inputTemplate = '{input}';
+
     /**
      * @var Model|ActiveRecordInterface|array
      */
@@ -214,14 +220,19 @@ public function isHiddenInput()
 
     /**
      * Prepares the value of column.
-     *
+     * @param array $contextParams the params who passed to closure:
+     * string $id the id of input element
+     * string $name the name of input element
+     * string $indexPlaceholder The index placeholder of multiple input. The {$indexPlaceholder} template will be replace by $index
+     * int $index The index of multiple input
+     * int $columnIndex The index of current model attributes
      * @return mixed
      */
-    protected function prepareValue()
+    protected function prepareValue($contextParams = [])
     {
         $data = $this->getModel();
         if ($this->value instanceof \Closure) {
-            $value = call_user_func($this->value, $data);
+            $value = call_user_func($this->value, $data, $contextParams);
         } else {
             $value = null;
             if ($data instanceof ActiveRecordInterface ) {
@@ -284,11 +295,18 @@ private function normalize($name) {
     /**
      * Renders the input.
      *
-     * @param string    $name the name of the input
-     * @param array     $options the HTML options of input
+     * @param string $name the name of the input
+     * @param array $options the HTML options of input
+     * @param array $contextParams the params who passed to closure:
+     * string $id the id of input element
+     * string $name the name of input element
+     * string $indexPlaceholder The index placeholder of multiple input. The {$indexPlaceholder} template will be replace by $index
+     * int $index The index of multiple input
+     * int $columnIndex The index of current model attributes
      * @return string
+     * @throws InvalidConfigException
      */
-    public function renderInput($name, $options)
+    public function renderInput($name, $options, $contextParams = [])
     {
         if ($this->options instanceof \Closure) {
             $optionsExt = call_user_func($this->options, $this->getModel());
@@ -301,7 +319,7 @@ public function renderInput($name, $options)
 
         $value = null;
         if ($this->type !== self::TYPE_DRAGCOLUMN) {
-            $value = $this->prepareValue();
+            $value = $this->prepareValue($contextParams);
         }
 
         if (isset($options['items'])) {
@@ -314,7 +332,7 @@ public function renderInput($name, $options)
             $input = $this->renderDefault($name, $value, $options);
         }
 
-        return $input;
+        return strtr($this->inputTemplate, ['{input}' => $input]);
     }