Fix #22: Ability to configure picker button options

Author: kartik-v

CHANGE.md

@@ -5,6 +5,9 @@ version 1.3.2
 - (enh #21): Add new remove button to clear dates. Applicable only for following `DatePicker` types:
     - `DatePicker::TYPE_COMPONENT_PREPEND` and 
     - `DatePicker::TYPE_COMPONENT_APPEND` 
+- (enh #22): Ability to configure picker button options. Applicable only for following `DatePicker` types:
+    - `DatePicker::TYPE_COMPONENT_PREPEND` and 
+    - `DatePicker::TYPE_COMPONENT_APPEND` 
 
 version 1.3.1
 =============

DatePicker.php

@@ -58,6 +58,17 @@ class DatePicker extends \kartik\base\InputWidget
      * - 'label': string the button label. Defaults to `<i class="glyphicon glyphicon-calendar"></i>`
      */
     public $buttonOptions = [];
+    
+    /**
+     * @var mixed the calendar picker button configuration.
+     * - if this is passed as a string, it will be displayed as is (will not be HTML encoded).
+     * - if this is set to false, the picker button will not be displayed.
+     * - if this is passed as an array (this is the DEFAULT) it will treat this as HTML attributes
+     *   for the button (to be displayed as a Bootstrap addon). The following special keys are recognized;
+     *   - icon - string, the bootstrap glyphicon name/suffix. Defaults to 'calendar'.
+     *   - title - string, the title to be displayed on hover. Defaults to 'Select date & time'.
+     */
+    public $pickerButton = [];
 
     /**
      * @var mixed the calendar remove button configuration - applicable only for type 
@@ -135,6 +146,7 @@ class DatePicker extends \kartik\base\InputWidget
      */
     public function init()
     {
+        $this->_msgCat = 'kvdate';
         parent::init();
         $this->_hasAddon = $this->type == self::TYPE_COMPONENT_PREPEND || $this->type == self::TYPE_COMPONENT_APPEND;
         if ($this->type === self::TYPE_RANGE && $this->attribute2 === null && $this->name2 === null) {
@@ -156,6 +168,7 @@ public function init()
             throw new InvalidConfigException("The 'attribute2' property must be set for a 'range' type markup and a defined 'form' property.");
         }
         $s = DIRECTORY_SEPARATOR;
+        $this->initI18N();
         $this->setLanguage('bootstrap-datepicker.', __DIR__ . "{$s}assets{$s}", null, '.min.js');
         $this->parseDateFormat('date');
         $this->_id = ($this->type == self::TYPE_INPUT) ? 'jQuery("#' . $this->options['id'] . '")' : 'jQuery("#' . $this->options['id'] . '").parent()';
@@ -191,21 +204,30 @@ protected function renderInput()
     }
 
     /**
-     * Returns the remove button addon
+     * Returns the addon to render
+     *
+     * @param array $options the HTML attributes for the addon
+     * @param string $type whether the addon is the picker or remove
      * @return string
      */
-    protected function renderRemoveButton()
+    protected function renderAddon(&$options, $type = 'picker')
     {
-        $options = $this->removeButton;
         if ($options === false) {
             return '';
         }
-        Html::addCssClass($options, 'input-group-addon kv-date-remove');
-        $icon = '<i class="glyphicon glyphicon-' . ArrayHelper::remove($options, 'icon', 'remove') . '"></i>';
+        if (is_string($options)) {
+            return $options;
+        }
+        $icon = ($type === 'picker') ? 'calendar' : 'remove';
+        Html::addCssClass($options, 'input-group-addon kv-date-' . $icon);
+        $icon = '<i class="glyphicon glyphicon-' . ArrayHelper::remove($options, 'icon', $icon) . '"></i>';
         if (empty($options['title'])) {
-            $options['title'] = Yii::t('app', 'Clear field');
+            $title = ($type === 'picker') ? Yii::t('kvdate', 'Select date') : Yii::t('kvdate', 'Clear field');
+            if ($title != false) {
+                $options['title'] = $title;
+            }
         }
-        return Html::tag('span', $icon, $options);        
+        return Html::tag('span', $icon, $options);
     }
 
     /**
@@ -231,11 +253,11 @@ protected function parseMarkup($input)
         }
         if ($this->_hasAddon) {
             Html::addCssClass($this->_container, 'date');
-            $addon = "<span class='input-group-addon'>{$this->addon}</span>";
-            $remove = $this->renderRemoveButton();
-            $content = $addon . $remove . $input;
+            $picker = $this->renderAddon($this->pickerButton);
+            $remove = $this->renderAddon($this->removeButton, 'remove');
+            $content = $picker . $remove . $input;
             if ($this->type == self::TYPE_COMPONENT_APPEND) {
-                $content = $input . $remove . $addon;
+                $content = $input . $remove . $picker;
             }
             return Html::tag('div', $content, $this->_container);
         }

messages/config.php

@@ -0,0 +1,52 @@
+<?php
+
+return [
+    // string, required, root directory of all source files
+    'sourcePath' => __DIR__ . DIRECTORY_SEPARATOR . '..',
+    // string, required, root directory containing message translations.
+    'messagePath' => __DIR__,
+    // array, required, list of language codes that the extracted messages
+    // should be translated to. For example, ['zh-CN', 'de'].
+    'languages' => ['en', 'de','ru'],
+    // string, the name of the function for translating messages.
+    // Defaults to 'Yii::t'. This is used as a mark to find the messages to be
+    // translated. You may use a string for single function name or an array for
+    // multiple function names.
+    'translator' => 'Yii::t',
+    // boolean, whether to sort messages by keys when merging new messages
+    // with the existing ones. Defaults to false, which means the new (untranslated)
+    // messages will be separated from the old (translated) ones.
+    'sort' => false,
+    // boolean, whether the message file should be overwritten with the merged messages
+    'overwrite' => true,
+    // boolean, whether to remove messages that no longer appear in the source code.
+    // Defaults to false, which means each of these messages will be enclosed with a pair of '' marks.
+    'removeUnused' => false,
+    // array, list of patterns that specify which files/directories should NOT be processed.
+    // If empty or not set, all files/directories will be processed.
+    // A path matches a pattern if it contains the pattern string at its end. For example,
+    // '/a/b' will match all files and directories ending with '/a/b';
+    // the '*.svn' will match all files and directories whose name ends with '.svn'.
+    // and the '.svn' will match all files and directories named exactly '.svn'.
+    // Note, the '/' characters in a pattern matches both '/' and '\'.
+    // See helpers/FileHelper::findFiles() description for more details on pattern matching rules.
+    'only' => ['*.php'],
+    // array, list of patterns that specify which files (not directories) should be processed.
+    // If empty or not set, all files will be processed.
+    // Please refer to "except" for details about the patterns.
+    // If a file/directory matches both a pattern in "only" and "except", it will NOT be processed.
+    'except' => [
+        '.svn',
+        '.git',
+        '.gitignore',
+        '.gitkeep',
+        '.hgignore',
+        '.hgkeep',
+        '/messages',
+    ],
+    // Generated file format. Can be either "php", "po" or "db".
+    'format' => 'php',
+    // When format is "db", you may specify the following two options
+    //'db' => 'db',
+    //'sourceMessageTable' => '{{%source_message}}',
+];

messages/de/kvdate.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * Message translations.
+ *
+ * This file is automatically generated by 'yii message' command.
+ * It contains the localizable messages extracted from source code.
+ * You may modify this file by translating the extracted messages.
+ *
+ * Each array element represents the translation (value) of a message (key).
+ * If the value is empty, the message is considered as not translated.
+ * Messages that no longer need translation will have their translations
+ * enclosed between a pair of '@@' marks.
+ *
+ * Message string can be used with plural forms format. Check i18n section
+ * of the guide for details.
+ *
+ * NOTE: this file must be saved in UTF-8 encoding.
+ */
+return [
+    'Clear field' => 'Feld löschen',
+    'Select date' => 'Datum wählen',
+];

messages/en/kvdate.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * Message translations.
+ *
+ * This file is automatically generated by 'yii message' command.
+ * It contains the localizable messages extracted from source code.
+ * You may modify this file by translating the extracted messages.
+ *
+ * Each array element represents the translation (value) of a message (key).
+ * If the value is empty, the message is considered as not translated.
+ * Messages that no longer need translation will have their translations
+ * enclosed between a pair of '@@' marks.
+ *
+ * Message string can be used with plural forms format. Check i18n section
+ * of the guide for details.
+ *
+ * NOTE: this file must be saved in UTF-8 encoding.
+ */
+return [
+    'Clear field' => '',
+    'Select date' => '',
+];

messages/ru/kvdate.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * Message translations.
+ *
+ * This file is automatically generated by 'yii message' command.
+ * It contains the localizable messages extracted from source code.
+ * You may modify this file by translating the extracted messages.
+ *
+ * Each array element represents the translation (value) of a message (key).
+ * If the value is empty, the message is considered as not translated.
+ * Messages that no longer need translation will have their translations
+ * enclosed between a pair of '@@' marks.
+ *
+ * Message string can be used with plural forms format. Check i18n section
+ * of the guide for details.
+ *
+ * NOTE: this file must be saved in UTF-8 encoding.
+ */
+return [
+    'Clear field' => 'Очистить поле',
+    'Select date' => 'Выбрать дату',
+];