Merge pull request #95 from unclead/issue-94

Ability to set custom renderer

Author: unclead

CHANGELOG.md

@@ -1,9 +1,11 @@
 Yii2 multiple input change log
 ==============================
 
-1.3.2 in development
+1.4.0 in development
 --------------------
 
+- #94: added ability to set custom renderer (unclead, bokodi-dev)
+
 1.3.1
 -----
 

docs/configuration.md

@@ -27,6 +27,9 @@ This can be `MultipleInput::POS_HEADER`, `MultipleInput::POS_ROW` or `MultipleIn
 **columnClass** *string*: the name of column class. You can specify your own class to extend base functionality.
 Defaults to `unclead\widgets\MultipleInputColumn` for `MultipleInput` and `unclead\widgets\TabularColumn` for `TabularInput`.
 
+**rendererClass** *string*: the name of renderer class. You can specify your own class to extend base functionality.
+Defaults to `unclead\widgets\renderers\TableRenderer`.
+
 **columns** *array*: the row columns configuration where you can set the properties which is described below
 
 **rowOptions** *array|\Closure*: the HTML attributes for the table body rows. This can be either an array

docs/usage.md

@@ -2,11 +2,11 @@
 
 > You can find source code of examples [here](./examples/)
 
-- [Input with one column](#one-column)
-- [Input with multiple column in each row](#multiple-columns)
-- [Tabular input](#tabular)
+- [One column](#one-column)
+- [Multiple columns](#multiple-columns-example)
+- [Tabular input](#tabular-input)
 
-##Input with one column <a href="one-column"></a>
+##One column
 
 ![Single column example](./images/single-column.gif?raw=true)
 
@@ -32,7 +32,7 @@ use unclead\widgets\MultipleInput;
 
 You can find more detail about this use case [here](multiple_input_single.md)
 
-##Input with multiple column in each row <a href="multiple-columns"></a>
+##Multiple columns
 
 ![Multiple columns example](./images/multiple-column.gif?raw=true)
 
@@ -105,7 +105,7 @@ use unclead\widgets\MultipleInput;
 
 You can find more detail about this use case [here](multiple_input_multiple.md)
 
-##Tabular input <a href="tabular"></a>
+##Tabular input
 
 For example you want to manage some models via tabular input. In this case you can use `TabularInput` widget which is based on `MultipleInput` widget.
 Use the following code for this purpose:

src/MultipleInput.php

@@ -14,6 +14,7 @@
 use yii\widgets\InputWidget;
 use yii\db\ActiveRecordInterface;
 use unclead\widgets\renderers\TableRenderer;
+use unclead\widgets\renderers\RendererInterface;
 
 
 /**
@@ -23,9 +24,9 @@
  */
 class MultipleInput extends InputWidget
 {
-    const POS_HEADER    = TableRenderer::POS_HEADER;
-    const POS_ROW       = TableRenderer::POS_ROW;
-    const POS_FOOTER    = TableRenderer::POS_FOOTER;
+    const POS_HEADER    = RendererInterface::POS_HEADER;
+    const POS_ROW       = RendererInterface::POS_ROW;
+    const POS_FOOTER    = RendererInterface::POS_FOOTER;
 
     /**
      * @var ActiveRecordInterface[]|array[] input data
@@ -101,6 +102,12 @@ class MultipleInput extends InputWidget
      */
     public $columnClass;
 
+    /**
+     * @var string the name of renderer class. Defaults to `unclead\widgets\renderers\TableRenderer`.
+     * @since 1.4
+     */
+    public $rendererClass;
+
     /**
      * Initialization.
      *
@@ -183,14 +190,18 @@ private function createRenderer()
             'context'           => $this,
         ];
 
-        if (!is_null($this->removeButtonOptions)) {
+        if ($this->removeButtonOptions !== null) {
             $config['removeButtonOptions'] = $this->removeButtonOptions;
         }
 
-        if (!is_null($this->addButtonOptions)) {
+        if ($this->addButtonOptions !== null) {
             $config['addButtonOptions'] = $this->addButtonOptions;
         }
 
+        if (!$this->rendererClass) {
+            $this->rendererClass = TableRenderer::className();
+        }
+        
         return new TableRenderer($config);
     }
 }

src/TabularInput.php

@@ -14,16 +14,17 @@
 use yii\db\ActiveRecordInterface;
 use yii\bootstrap\Widget;
 use unclead\widgets\renderers\TableRenderer;
+use unclead\widgets\renderers\RendererInterface;
 
 /**
  * Class TabularInput
  * @package unclead\widgets
  */
 class TabularInput extends Widget
 {
-    const POS_HEADER    = TableRenderer::POS_HEADER;
-    const POS_ROW       = TableRenderer::POS_ROW;
-    const POS_FOOTER    = TableRenderer::POS_FOOTER;
+    const POS_HEADER    = RendererInterface::POS_HEADER;
+    const POS_ROW       = RendererInterface::POS_ROW;
+    const POS_FOOTER    = RendererInterface::POS_FOOTER;
 
     /**
      * @var array
@@ -95,6 +96,12 @@ class TabularInput extends Widget
      */
     public $columnClass;
 
+    /**
+     * @var string the name of renderer class. Defaults to `unclead\widgets\renderers\TableRenderer`.
+     * @since 1.4
+     */
+    public $rendererClass;
+
     /**
      * Initialization.
      *
@@ -142,14 +149,18 @@ private function createRenderer()
             'context'           => $this,
         ];
 
-        if (!is_null($this->removeButtonOptions)) {
+        if ($this->removeButtonOptions !== null) {
             $config['removeButtonOptions'] = $this->removeButtonOptions;
         }
 
-        if (!is_null($this->addButtonOptions)) {
+        if ($this->addButtonOptions !== null) {
             $config['addButtonOptions'] = $this->addButtonOptions;
         }
 
+        if (!$this->rendererClass) {
+            $this->rendererClass = TableRenderer::className();
+        }
+
         return new TableRenderer($config);
     }
 }

src/components/BaseRenderer.php renamed to src/renderers/BaseRenderer.php

@@ -6,7 +6,7 @@
  * @license https://github.com/unclead/yii2-multiple-input/blob/master/LICENSE.md
  */
 
-namespace unclead\widgets\components;
+namespace unclead\widgets\renderers;
 
 use Yii;
 use yii\helpers\Html;
@@ -20,17 +20,14 @@
 use unclead\widgets\MultipleInput;
 use unclead\widgets\TabularInput;
 use unclead\widgets\assets\MultipleInputAsset;
+use unclead\widgets\components\BaseColumn;
 
 /**
  * Class BaseRenderer
- * @package unclead\widgets\components
+ * @package unclead\widgets\renderers
  */
-abstract class BaseRenderer extends Object
+abstract class BaseRenderer extends Object implements RendererInterface
 {
-    const POS_HEADER    = 'header';
-    const POS_ROW       = 'row';
-    const POS_FOOTER    = 'footer';
-
     /**
      * @var string the ID of the widget
      */
@@ -116,7 +113,7 @@ abstract class BaseRenderer extends Object
     private $indexPlaceholder;
 
     /**
-     * @param $context
+     * @inheritdoc
      */
     public function setContext($context)
     {

src/renderers/RendererInterface.php

@@ -0,0 +1,43 @@
+<?php
+
+/**
+ * @link https://github.com/unclead/yii2-multiple-input
+ * @copyright Copyright (c) 2014 unclead
+ * @license https://github.com/unclead/yii2-multiple-input/blob/master/LICENSE.md
+ */
+
+namespace unclead\widgets\renderers;
+
+
+/**
+ * Interface RendererInterface
+ * @package unclead\widgets\renderers
+ */
+interface RendererInterface
+{
+    const POS_HEADER    = 'header';
+    const POS_ROW       = 'row';
+    const POS_FOOTER    = 'footer';
+
+    /**
+     * Renders the widget's content.
+     *
+     * @return mixed
+     */
+    public function render();
+
+    /**
+     * Set current context.
+     * 
+     * @param mixed $context
+     * @return mixed
+     */
+    public function setContext($context);
+
+    /**
+     * Returns a placeholder.
+     *
+     * @return string
+     */
+    public function getIndexPlaceholder();
+}

src/renderers/TableRenderer.php

@@ -12,7 +12,6 @@
 use yii\db\ActiveRecordInterface;
 use yii\helpers\ArrayHelper;
 use yii\helpers\Html;
-use unclead\widgets\components\BaseRenderer;
 use unclead\widgets\components\BaseColumn;
 
 /**