CFormInputElement

Подробное описание свойств

coreTypes свойство

public static array $coreTypes;

Типы входных данных ядра (псевдоним=>имя метода CHtml)

enableAjaxValidation свойство (доступно с версии 1.1.7)

public boolean $enableAjaxValidation;

разрешить ли проверку на основе AJAX для этого элемента ввода. Обратите внимание, что для использования проверки на основе AJAX, CForm::activeForm должен быть настроен с 'enableAjaxValidation'=>true. Это свойство позволяет включить или выключить проверку на основе AJAX для отдельных элементов ввода. По умолчанию значение равно true.

enableClientValidation свойство (доступно с версии 1.1.7)

public boolean $enableClientValidation;

разрешить ли проверку на стороне клиента для этого элемента ввода. Обратите внимание, что для использования проверки на стороне клиента, CForm::activeForm должен быть настроен с 'enableClientValidation'=>true. Это свойство позволяет включить или выключить проверку на стороне клиента для отдельных элементов ввода. По умолчанию значение равно true.

errorOptions свойство (доступно с версии 1.1.1)

public array $errorOptions;

параметры, используемые при отображении части ошибки. Это свойство будет передано в вызов метода CActiveForm::error в качестве параметра $htmlOptions.

hint свойство

public string $hint;

текст подсказки этого элемента ввода

items свойство

public array $items;

параметры для этого элемента ввода, когда это список, выпадающий список, список флажков или список радиокнопок. Подробности по генерации этого значения свойства см. в CHtml::listData.

label свойство

public string getLabel()
public void setLabel(string $value)

метка для этого элемента ввода. Если метка не задана вручную, этот метод вызовет CModel::getAttributeLabel для определения метки.

layout свойство

public string $layout;

макет, используемый для отображения метки, поля ввода, подсказки и ошибки. Они соответствуют плейсхолдерам "{label}", "{input}", "{hint}" и "{error}".

name свойство

public string $name;

имя этого элемента ввода

required свойство

public boolean getRequired()
public void setRequired(boolean $value)

Получает значение, указывающее, является ли этот элемент ввода обязательным. Если это свойство не установлено явно, оно будет определено путем вызова CModel::isAttributeRequired для связанной модели и атрибута этого элемента ввода.

type свойство

public string $type;

тип этого элемента ввода. Это может быть имя класса виджета, псевдоним пути имени класса виджета или псевдоним типа ввода (text, hidden, password, textarea, file, radio, checkbox, listbox, dropdownlist, checkboxlist или radiolist). Если это класс виджета, он должен быть расширением CInputWidget или (@link CJuiInputWidget).

Подробное описание методов

evaluateVisible() метод

protected boolean evaluateVisible()

protected function evaluateVisible()
{
    return $this->getParent()->getModel()->isAttributeSafe($this->name);
}

Оценивает видимость этого элемента. Этот метод проверит, является ли атрибут, связанный с этим элементом ввода, безопасным для текущей модели сценария.

getLabel() метод

public string getLabel()

public function getLabel()
{
    if($this->_label!==null)
        return $this->_label;
    else
        return $this->getParent()->getModel()->getAttributeLabel($this->name);
}

getRequired() метод

public boolean getRequired()

public function getRequired()
{
    if($this->_required!==null)
        return $this->_required;
    else
        return $this->getParent()->getModel()->isAttributeRequired($this->name);
}

Получает значение, указывающее, является ли этот элемент ввода обязательным. Если это свойство не установлено явно, оно будет определено путем вызова CModel::isAttributeRequired для связанной модели и атрибута этого элемента ввода.

render() метод

public string render()

public function render()
{
    if($this->type==='hidden')
        return $this->renderInput();
    $output=array(
        '{label}'=>$this->renderLabel(),
        '{input}'=>$this->renderInput(),
        '{hint}'=>$this->renderHint(),
        '{error}'=>!$this->getParent()->showErrors ? '' : $this->renderError(),
    );
    return strtr($this->layout,$output);
}

Рендерит всё для этого элемента ввода. Стандартная реализация просто возвращает результат renderLabel, renderInput, renderHint. Когда CForm::showErrorSummary ложно, renderError также вызывается для отображения сообщений об ошибках после отдельных полей ввода.

renderError() метод

public string renderError()

public function renderError()
{
    $parent=$this->getParent();
    return $parent->getActiveFormWidget()->error($parent->getModel(), $this->name, $this->errorOptions, $this->enableAjaxValidation, $this->enableClientValidation);
}

Рендерит отображения ошибок этого элемента ввода. Стандартная реализация возвращает результат CHtml::error

renderHint() метод

public string renderHint()

public function renderHint()
{
    return $this->hint===null ? '' : '<div class="hint">'.$this->hint.'</div>';
}

Рендерит текста подсказки для этого элемента ввода. Стандартная реализация возвращает свойство hint, заключенное в тег абзаца HTML.

renderInput() метод

public string renderInput()

public function renderInput()
{
    if(isset(self::$coreTypes[$this->type]))
    {
        $method=self::$coreTypes[$this->type];
        if(strpos($method,'List')!==false)
            return CHtml::$method($this->getParent()->getModel(), $this->name, $this->items, $this->attributes);
        else
            return CHtml::$method($this->getParent()->getModel(), $this->name, $this->attributes);
    }
    else
    {
        $attributes=$this->attributes;
        $attributes['model']=$this->getParent()->getModel();
        $attributes['attribute']=$this->name;
        ob_start();
        $this->getParent()->getOwner()->widget($this->type, $attributes);
        return ob_get_clean();
    }
}

Рендерит поля ввода. Стандартная реализация возвращает результат соответствующего метода CHtml или виджета.

renderLabel() метод

public string renderLabel()

public function renderLabel()
{
    $options = array(
        'label'=>$this->getLabel(),
        'required'=>$this->getRequired()
    );

    if(!empty($this->attributes['id']))
        $options['for']=$this->attributes['id'];

    return CHtml::activeLabel($this->getParent()->getModel(), $this->name, $options);
}

Рендерит метки для этого элемента ввода. Стандартная реализация возвращает результат activeLabelEx.

setLabel() метод

public void setLabel(string $value)

public function setLabel($value)
{
    $this->_label=$value;
}

setRequired() метод

public void setRequired(boolean $value)

public function setRequired($value)
{
    $this->_required=$value;
}