SliderInput.php 2.35 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\jui;

use yii\helpers\Html;

/**
 * SliderInput renders a slider jQuery UI widget that writes its value into hidden input.
 *
 * For example,
 *
 * ```
18
 * echo SliderInput::widget([
19
 *     'model' => $model,
Alexander Makarov committed
20
 *     'attribute' => 'amount',
21 22 23 24 25 26 27 28 29 30
 *     'clientOptions' => [
 *         'min' => 1,
 *         'max' => 10,
 *     ],
 * ]);
 * ```
 *
 * The following example will use the name property instead:
 *
 * ```
31
 * echo SliderInput::widget([
32 33 34 35 36 37 38 39 40 41 42 43 44 45
 *     'name' => 'amount',
 *     'clientOptions' => [
 *         'min' => 1,
 *         'max' => 10,
 *     ],
 * ]);
 * ```
 *
 * @see http://api.jqueryui.com/slider/
 * @author Alexander Makarov <sam@rmcreative.ru>
 * @since 2.0
 */
class SliderInput extends InputWidget
{
46 47 48 49 50 51
    /**
     * @var array the HTML attributes for the container tag.
     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
     */
    public $containerOptions = [];

52 53 54 55 56 57 58 59 60 61
    /**
     * @inheritDoc
     */
    protected $clientEventMap = [
        'change' => 'slidechange',
        'create' => 'slidecreate',
        'slide' => 'slide',
        'start' => 'slidestart',
        'stop' => 'slidestop',
    ];
62

63

64 65 66 67 68 69 70 71 72 73
    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();
        if (!isset($this->containerOptions['id'])) {
            $this->containerOptions['id'] = $this->options['id'] . '-container';
        }
    }
74

75 76 77 78 79 80
    /**
     * Executes the widget.
     */
    public function run()
    {
        echo Html::tag('div', '', $this->containerOptions);
81

82 83 84 85 86 87 88
        if ($this->hasModel()) {
            echo Html::activeHiddenInput($this->model, $this->attribute, $this->options);
            $this->clientOptions['value'] = $this->model{$this->attribute};
        } else {
            echo Html::hiddenInput($this->name, $this->value, $this->options);
            $this->clientOptions['value'] = $this->value;
        }
89

90 91 92 93 94
        if (!isset($this->clientEvents['slide'])) {
            $this->clientEvents['slide'] = 'function (event, ui) {
                $("#' . $this->options['id'] . '").val(ui.value);
            }';
        }
95

96 97
        $this->registerWidget('slider', SliderAsset::className(), $this->containerOptions['id']);
    }
98
}