implement changes to address #228, updated

Author: dbd5

CHANGELOG.md

@@ -7,7 +7,7 @@ Yii2 multiple input change log
 
 2.15.1 (for review)
 =======================
-- #228 added `fontMap` and `fontSource`property for MultipleInput and TabularInput
+- #228 added `iconMap` and `iconSource`property for MultipleInput and TabularInput
 - #228 changed the following methods to support icon class:
     BaseColumn->renderDragColumn(), TableRenderer->renderCellContent(), BaseRenderer->prepareButtons()
 

README.md

@@ -158,9 +158,9 @@ Multiple input and Tabular input widgets now support FontAwesome and indeed any
 
 To take advantage of this, please proceed as follows:
 1. Include the preferred icon library into your project. If you wish to use fontAwesome, you can use the included FontAwesomeAsset which will integrate the free fa from their CDN;
-2. Add a mapping for your preferred icon library if its not in the fontMap array of the widget, like the following;
+2. Add a mapping for your preferred icon library if its not in the iconMap array of the widget, like the following;
 ```
-public $fontMap = [
+public $iconMap = [
     'glyphicons' => [
         'drag-handle' => 'glyphicon glyphicon-menu-hamburger',
         'remove' => 'glyphicon glyphicon-remove',
@@ -177,13 +177,13 @@ public $fontMap = [
         'drag-handle' => 'my my-bars',
         'remove' => 'my my-times',
         'add' => 'my my-plus',
-        'clone' => 'my fa-files-o',
+        'clone' => 'my my-files',
     ]
 ];
 ```
-3. Set the preffered font source
+3. Set the preffered icon source
 ```
-    public $fontSource = 'my-amazing-icons';
+    public $iconSource = 'my-amazing-icons';
 ```
 If you do none of the above, the default behavior which assumes you are using glyphicons is retained.
 

src/MultipleInput.php

@@ -164,7 +164,7 @@ class MultipleInput extends InputWidget
      * @var array
      * --icon library classes mapped for various controls
      */
-    public $fontMap = [
+    public $iconMap = [
         'glyphicons' => [
             'drag-handle' => 'glyphicon glyphicon-menu-hamburger',
             'remove' => 'glyphicon glyphicon-remove',
@@ -182,7 +182,7 @@ class MultipleInput extends InputWidget
      * @var string
      * --name of default icon library
      */
-    public $fontSource = 'glyphicons';
+    public $iconSource = 'glyphicons';
 
     /**
      * Initialization.
@@ -281,9 +281,9 @@ private function createRenderer()
         }
 
         /**
-         * set default font map
+         * set default icon map
          */
-        $fontmap = array_key_exists($this->fontSource, $this->fontMap)?$this->fontMap[$this->fontSource]:$this->fontMap['glyphicons'];
+        $iconmap = array_key_exists($this->iconSource, $this->iconMap) ? $this->iconMap[$this->iconSource] : $this->iconMap['glyphicons'];
         $config = [
             'id'                => $this->getId(),
             'columns'           => $this->columns,
@@ -301,7 +301,7 @@ private function createRenderer()
             'enableError'       => $this->enableError,
             'cloneButton'       => $this->cloneButton,
             'extraButtons'      => $this->extraButtons,
-            'fontMap'           => $fontmap,
+            'iconMap'           => $iconmap,
         ];
 
         if ($this->removeButtonOptions !== null) {

src/TabularInput.php

@@ -152,7 +152,7 @@ class TabularInput extends Widget
      * @var array
      * --icon library classes mapped for various controls
      */
-    public $fontMap = [
+    public $iconMap = [
         'glyphicons' => [
             'drag-handle' => 'glyphicon glyphicon-menu-hamburger',
             'remove' => 'glyphicon glyphicon-remove',
@@ -170,7 +170,7 @@ class TabularInput extends Widget
      * @var string
      * --name of default icon library
      */
-    public $fontSource = 'glyphicons';
+    public $iconSource = 'glyphicons';
 
     /**
      * Initialization.
@@ -225,9 +225,9 @@ public function run()
     private function createRenderer()
     {
         /**
-         * set default font map
+         * set default icon map
          */
-        $fontmap = array_key_exists($this->fontSource, $this->fontMap)?$this->fontMap[$this->fontSource]:$this->fontMap['glyphicons'];
+        $iconmap = array_key_exists($this->iconSource, $this->iconMap) ? $this->iconMap[$this->iconSource] : $this->iconMap['glyphicons'];
         $config = [
             'id'                => $this->getId(),
             'columns'           => $this->columns,
@@ -244,7 +244,7 @@ private function createRenderer()
             'sortable'          => $this->sortable,
             'enableError'       => $this->enableError,
             'layoutConfig'      => $this->layoutConfig,
-            'fontMap'           => $fontmap,
+            'iconMap'           => $iconmap,
         ];
 
         if ($this->removeButtonOptions !== null) {

src/components/BaseColumn.php

@@ -467,7 +467,6 @@ protected function renderStatic($name, $value, $options)
      */
     protected function renderDragColumn($name, $value, $options)
     {
-        // return Html::tag('span', null, ['class' => 'glyphicon glyphicon-menu-hamburger drag-handle']);
         /**
          * Class was passed into options by TableRenderer->renderCellContent(),
          * we can extract it here
@@ -478,7 +477,7 @@ protected function renderDragColumn($name, $value, $options)
         }
         $dragClass = implode(" ", [$class, 'drag-handle']);
 
-        return Html::tag('span', null, ['class'=>$dragClass]);
+        return Html::tag('span', null, ['class' => $dragClass]);
     }
 
     /**

src/renderers/BaseRenderer.php

@@ -166,7 +166,7 @@ abstract class BaseRenderer extends BaseObject implements RendererInterface
      */
     public $layoutConfig = [];
 
-    public $fontMap;
+    public $iconMap;
 
     /**
      * @inheritdoc
@@ -250,23 +250,23 @@ private function prepareButtons()
         }
 
         if (!array_key_exists('label', $this->removeButtonOptions)) {
-            $this->removeButtonOptions['label'] = Html::tag('i', null, ['class' => $this->getFontClass('remove')]);
+            $this->removeButtonOptions['label'] = Html::tag('i', null, ['class' => $this->getIconClass('remove')]);
         }
 
         if (!array_key_exists('class', $this->addButtonOptions)) {
             $this->addButtonOptions['class'] = 'btn btn-default';
         }
 
         if (!array_key_exists('label', $this->addButtonOptions)) {
-            $this->addButtonOptions['label'] = Html::tag('i', null, ['class' => $this->getFontClass('add')]);
+            $this->addButtonOptions['label'] = Html::tag('i', null, ['class' => $this->getIconClass('add')]);
         }
 
         if (!array_key_exists('class', $this->cloneButtonOptions)) {
             $this->cloneButtonOptions['class'] = 'btn btn-info';
         }
 
         if (!array_key_exists('label', $this->cloneButtonOptions)) {
-            $this->cloneButtonOptions['label'] = Html::tag('i', null, ['class' => $this->getFontClass('clone')]);
+            $this->cloneButtonOptions['label'] = Html::tag('i', null, ['class' => $this->getIconClass('clone')]);
         }
     }
 
@@ -496,9 +496,13 @@ protected function prepareJsAttributes()
      * @param $action - the control parameter, used as key into allowed types
      * @return string - the relevant icon class
      */
-    protected function getFontClass($action) {
+    protected function getIconClass($action) {
         if (in_array($action, ['add', 'remove', 'clone', 'drag-handle'])) {
-            return $this->fontMap[$action];
+            return $this->iconMap[$action];
+        }
+
+        if (YII_DEBUG) {
+            throw new InvalidConfigException('Out of bounds, "' . $action . '" not found in your iconMap');
         }
         return '';
     }

src/renderers/TableRenderer.php

@@ -255,13 +255,13 @@ public function renderCellContent($column, $index)
         $name  = $column->getElementName($index);
 
         /**
-         * This class inherits fontMap from BaseRenderer
+         * This class inherits iconMap from BaseRenderer
          * If the input to be rendered is a drag column, we give it the appropriate icon class
          * via the $options array
          */
         $options = ['id' => $id];
-        if (substr($id, -4)=='drag') {
-            $options = ArrayHelper::merge($options, ['class'=>$this->fontMap['drag-handle']]);
+        if (substr($id, -4) === 'drag') {
+            $options = ArrayHelper::merge($options, ['class' => $this->iconMap['drag-handle']]);
         }
         $input = $column->renderInput($name, $options);