TbInput.php

Go to the documentation of this file.

<?php
abstract class TbInput extends CInputWidget
{
        // The different input types.
        const TYPE_CHECKBOX = 'checkbox';
        const TYPE_CHECKBOXLIST = 'checkboxlist';
        const TYPE_CHECKBOXLIST_INLINE = 'checkboxlist_inline';
        const TYPE_CHECKBOXGROUPSLIST = 'checkboxgroupslist';
        const TYPE_DROPDOWN = 'dropdownlist';
        const TYPE_FILE = 'filefield';
        const TYPE_PASSWORD = 'password';
        const TYPE_PASSFIELD = 'passfield';
        const TYPE_RADIO = 'radiobutton';
        const TYPE_RADIOLIST = 'radiobuttonlist';
        const TYPE_RADIOLIST_INLINE = 'radiobuttonlist_inline';
        const TYPE_RADIOBUTTONGROUPSLIST = 'radiobuttongroupslist';
        const TYPE_TEXTAREA = 'textarea';
        const TYPE_TEXT = 'text';
        const TYPE_MASKEDTEXT = 'maskedtextfield';
        const TYPE_CAPTCHA = 'captcha';
        const TYPE_UNEDITABLE = 'uneditable';
        const TYPE_DATEPICKER = 'datepicker';
        const TYPE_DATETIMEPICKER = 'datetimepicker';
        const TYPE_REDACTOR = 'redactor';
        const TYPE_MARKDOWNEDITOR = 'markdowneditor';
        const TYPE_HTML5EDITOR = 'wysihtml5';
        const TYPE_DATERANGEPICKER = 'daterangepicker';
        const TYPE_TOGGLEBUTTON = 'togglebutton';
        const TYPE_COLORPICKER = 'colorpicker';
        const TYPE_CKEDITOR = 'ckeditor';
        const TYPE_TIMEPICKER = 'timepicker';
        const TYPE_SELECT2 = 'select2';
        const TYPE_TYPEAHEAD = 'typeahead';
        const TYPE_NUMBER = 'numberfield';
        const TYPE_CUSTOM = 'custom';

        public $form;

        public $label;

        public $type;

        public $data = array();

        public $prependText;

        public $appendText;

        public $hintText;

        public $labelOptions = array();

        public $prependOptions = array();

        public $appendOptions = array();

        public $hintOptions = array();

        public $errorOptions = array();

        public $captchaOptions = array();

        public $enableAjaxValidation = true;

        public $enableClientValidation = true;

        public function init()
        {
                if (!isset($this->form)) {
                        throw new CException(__CLASS__ . ': Failed to initialize widget! Form is not set.');
                }

                if (!isset($this->model)) {
                        throw new CException(__CLASS__ . ': Failed to initialize widget! Model is not set.');
                }

                if (!isset($this->type)) {
                        throw new CException(__CLASS__ . ': Failed to initialize widget! Input type is not set.');
                }

                // todo: move this logic elsewhere, it doesn't belong here ...
                if ($this->type === self::TYPE_UNEDITABLE) {
                        if (isset($this->htmlOptions['class'])) {
                                $this->htmlOptions['class'] .= ' uneditable-input';
                        } else {
                                $this->htmlOptions['class'] = 'uneditable-input';
                        }
                }

                $this->processHtmlOptions();
        }

        protected function processHtmlOptions()
        {
                if (isset($this->htmlOptions['label'])) {
                        $this->label = $this->htmlOptions['label'];
                        unset($this->htmlOptions['label']);
                }

                if (isset($this->htmlOptions['prepend'])) {
                        $this->prependText = $this->htmlOptions['prepend'];
                        unset($this->htmlOptions['prepend']);
                }

                if (isset($this->htmlOptions['append'])) {
                        $this->appendText = $this->htmlOptions['append'];
                        unset($this->htmlOptions['append']);
                }

                if (isset($this->htmlOptions['hint'])) {
                        $this->hintText = $this->htmlOptions['hint'];
                        unset($this->htmlOptions['hint']);
                }

                if (isset($this->htmlOptions['labelOptions'])) {
                        $this->labelOptions = $this->htmlOptions['labelOptions'];
                        unset($this->htmlOptions['labelOptions']);
                }

                if (isset($this->htmlOptions['prependOptions'])) {
                        $this->prependOptions = $this->htmlOptions['prependOptions'];
                        unset($this->htmlOptions['prependOptions']);
                }

                if (isset($this->htmlOptions['appendOptions'])) {
                        $this->appendOptions = $this->htmlOptions['appendOptions'];
                        unset($this->htmlOptions['appendOptions']);
                }

                if (isset($this->htmlOptions['hintOptions'])) {
                        $this->hintOptions = $this->htmlOptions['hintOptions'];
                        unset($this->htmlOptions['hintOptions']);
                }

                if (isset($this->htmlOptions['errorOptions'])) {
                        $this->errorOptions = $this->htmlOptions['errorOptions'];
                        if (isset($this->htmlOptions['errorOptions']['enableAjaxValidation'])) {
                                $this->enableAjaxValidation = (boolean)$this->htmlOptions['errorOptions']['enableAjaxValidation'];
                        }

                        if (isset($this->htmlOptions['errorOptions']['enableClientValidation'])) {
                                $this->enableClientValidation = (boolean)$this->htmlOptions['errorOptions']['enableClientValidation'];
                        }
                        unset($this->htmlOptions['errorOptions']);
                }

                if (isset($this->htmlOptions['captchaOptions'])) {
                        $this->captchaOptions = $this->htmlOptions['captchaOptions'];
                        unset($this->htmlOptions['captchaOptions']);
                }
        }

        public function run()
        {
                switch ($this->type) {
                        case self::TYPE_CHECKBOX:
                                $this->checkBox();
                                break;

                        case self::TYPE_CHECKBOXLIST:
                                $this->checkBoxList();
                                break;

                        case self::TYPE_CHECKBOXLIST_INLINE:
                                $this->checkBoxListInline();
                                break;

                        case self::TYPE_CHECKBOXGROUPSLIST:
                                $this->checkBoxGroupsList();
                                break;

                        case self::TYPE_DROPDOWN:
                                $this->dropDownList();
                                break;

                        case self::TYPE_FILE:
                                $this->fileField();
                                break;

                        case self::TYPE_PASSWORD:
                                $this->passwordField();
                                break;

                        case self::TYPE_PASSFIELD:
                                $this->passfieldField();
                                break;

                        case self::TYPE_RADIO:
                                $this->radioButton();
                                break;

                        case self::TYPE_RADIOLIST:
                                $this->radioButtonList();
                                break;

                        case self::TYPE_RADIOLIST_INLINE:
                                $this->radioButtonListInline();
                                break;

                        case self::TYPE_RADIOBUTTONGROUPSLIST:
                                $this->radioButtonGroupsList();
                                break;

                        case self::TYPE_TEXTAREA:
                                $this->textArea();
                                break;

                        case 'textfield': // backwards compatibility
                        case self::TYPE_TEXT:
                                $this->textField();
                                break;

                        case self::TYPE_MASKEDTEXT:
                                $this->maskedTextField();
                                break;

                        case self::TYPE_CAPTCHA:
                                $this->captcha();
                                break;

                        case self::TYPE_UNEDITABLE:
                                $this->uneditableField();
                                break;

                        case self::TYPE_DATEPICKER:
                                $this->datepickerField();
                                break;

                        case self::TYPE_DATETIMEPICKER:
                                $this->datetimepickerField();
                                break;

                        case self::TYPE_REDACTOR:
                                $this->redactorJs();
                                break;

                        case self::TYPE_MARKDOWNEDITOR:
                                $this->markdownEditorJs();
                                break;

                        case self::TYPE_HTML5EDITOR:
                                $this->html5Editor();
                                break;

                        case self::TYPE_DATERANGEPICKER:
                                $this->dateRangeField();
                                break;

                        case self::TYPE_TOGGLEBUTTON:
                                $this->toggleButton();
                                break;

                        case self::TYPE_COLORPICKER:
                                $this->colorpickerField();
                                break;

                        case self::TYPE_CKEDITOR:
                                $this->ckEditor();
                                break;

                        case self::TYPE_TIMEPICKER:
                                $this->timepickerField();
                                break;

                        case self::TYPE_SELECT2:
                                $this->select2Field();
                                break;

                        case self::TYPE_TYPEAHEAD:
                                $this->typeAheadField();
                                break;

                        case self::TYPE_NUMBER:
                                $this->numberField();
                                break;

                        case self::TYPE_CUSTOM:
                                $this->customField();
                                break;

                        default:
                                throw new CException(__CLASS__ . ': Failed to run widget! Type is invalid.');
                }
        }

        protected function getLabel()
        {
                if ($this->label !== false && !in_array($this->type, array('checkbox', 'radio')) && $this->hasModel()) {
                        return $this->form->labelEx($this->model, $this->attribute, $this->labelOptions);
                } else if ($this->label !== null) {
                        return $this->label;
                } else {
                        return '';
                }
        }

        protected function getPrepend()
        {
                if ($this->hasAddOn()) {
                        $htmlOptions = $this->prependOptions;

                        if (isset($htmlOptions['class'])) {
                                $htmlOptions['class'] .= ' add-on';
                        } else {
                                $htmlOptions['class'] = 'add-on';
                        }

                        ob_start();
                        echo '<div class="' . $this->getAddonCssClass() . '">';
                        if (isset($this->prependText)) {
                                if (isset($htmlOptions['isRaw']) && $htmlOptions['isRaw']) {
                                        echo $this->prependText;
                                } else {
                                        echo CHtml::tag('span', $htmlOptions, $this->prependText);
                                }
                        }

                        return ob_get_clean();
                } else {
                        return '';
                }
        }

        protected function getAppend()
        {
                if ($this->hasAddOn()) {
                        $htmlOptions = $this->appendOptions;

                        if (isset($htmlOptions['class'])) {
                                $htmlOptions['class'] .= ' add-on';
                        } else {
                                $htmlOptions['class'] = 'add-on';
                        }

                        ob_start();
                        if (isset($this->appendText)) {
                                if (isset($htmlOptions['isRaw']) && $htmlOptions['isRaw']) {
                                        echo $this->appendText;
                                } else {
                                        echo CHtml::tag('span', $htmlOptions, $this->appendText);
                                }
                        }

                        echo '</div>';
                        return ob_get_clean();
                } else {
                        return '';
                }
        }

        protected function getAttributeId($attribute)
        {
                return isset($this->htmlOptions['id'])
                        ? $this->htmlOptions['id']
                        : CHtml::getIdByName(CHtml::resolveName($this->model, $attribute));
        }

        protected function getError()
        {
                return $this->form->error(
                        $this->model,
                        $this->attribute,
                        $this->errorOptions,
                        $this->enableAjaxValidation,
                        $this->enableClientValidation
                );
        }

        protected function getHint()
        {
                if (isset($this->hintText)) {
                        $htmlOptions = $this->hintOptions;

                        if (isset($htmlOptions['class'])) {
                                $htmlOptions['class'] .= ' help-block';
                        } else {
                                $htmlOptions['class'] = 'help-block';
                        }

                        return CHtml::tag('p', $htmlOptions, $this->hintText);
                } else {
                        return '';
                }
        }

        protected function getContainerCssClass()
        {
                return $this->model->hasErrors($this->attribute) ? CHtml::$errorCss : '';
        }

        protected function getAddonCssClass()
        {
                $classes = array();
                if (isset($this->prependText)) {
                        $classes[] = 'input-prepend';
                }
                if (isset($this->appendText)) {
                        $classes[] = 'input-append';
                }

                return implode(' ', $classes);
        }

        protected function hasAddOn()
        {
                return isset($this->prependText) || isset($this->appendText);
        }

        abstract protected function checkBox();

        abstract protected function toggleButton();

        abstract protected function checkBoxList();

        abstract protected function checkBoxListInline();

        abstract protected function checkBoxGroupsList();

        abstract protected function dropDownList();

        abstract protected function fileField();

        abstract protected function passwordField();

        abstract protected function passfieldField();

        abstract protected function radioButton();

        abstract protected function radioButtonList();

        abstract protected function radioButtonListInline();

        abstract protected function radioButtonGroupsList();

        abstract protected function textArea();

        abstract protected function textField();

        abstract protected function maskedTextField();

        abstract protected function captcha();

        abstract protected function uneditableField();

        abstract protected function datepickerField();

        abstract protected function datetimepickerField();

        abstract protected function redactorJs();

        abstract protected function markdownEditorJs();

        abstract protected function ckEditor();

        abstract protected function html5Editor();

        abstract protected function dateRangeField();

        abstract protected function colorpickerField();

        abstract protected function timepickerField();

        abstract protected function select2Field();

        abstract protected function typeAheadField();

        abstract protected function numberField();

        abstract protected function customField();

        protected function getSeparatedSelectableInput()
        {
                switch ($this->type)
                {
                        case self::TYPE_CHECKBOX:
                                $method = 'checkBox';
                                break;
                        case self::TYPE_RADIO:
                                $method = 'radioButton';
                                break;
                        default:
                                throw new CException('This method can be used with only selectable control', E_USER_ERROR);
                }

                $control = $this->form->{$method}($this->model, $this->attribute, $this->htmlOptions);
                $hidden  = '';

                $hasHiddenField = (array_key_exists('uncheckValue', $this->htmlOptions) && $this->htmlOptions['uncheckValue'] === null)
                        ? false
                        : true;

                if ($hasHiddenField && preg_match('/<input .*?type="hidden".*?\/>/', $control, $matches))
                {
                        $hidden = $matches[0];
                        $control = str_replace($hidden, '', $control);
                }

                return array($hidden, $control);
        }
}