CFormInputElement

Property Details

coreTypes property

public static array $coreTypes;

Core input types (alias=>CHtml method name)

enableAjaxValidation property (available since v1.1.7)

public boolean $enableAjaxValidation;

whether to allow AJAX-based validation for this input. Note that in order to use AJAX-based validation, CForm::activeForm must be configured with 'enableAjaxValidation'=>true. This property allows turning on or off AJAX-based validation for individual input fields. Defaults to true.

enableClientValidation property (available since v1.1.7)

public boolean $enableClientValidation;

whether to allow client-side validation for this input. Note that in order to use client-side validation, CForm::activeForm must be configured with 'enableClientValidation'=>true. This property allows turning on or off client-side validation for individual input fields. Defaults to true.

errorOptions property (available since v1.1.1)

public array $errorOptions;

the options used when rendering the error part. This property will be passed to the CActiveForm::error method call as its $htmlOptions parameter.

hint property

public string $hint;

hint text of this input

items property

public array $items;

the options for this input when it is a list box, drop-down list, check box list, or radio button list. Please see CHtml::listData for details of generating this property value.

label property

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

the label for this input. If the label is not manually set, this method will call CModel::getAttributeLabel to determine the label.

layout property

public string $layout;

the layout used to render label, input, hint and error. They correspond to the placeholders "{label}", "{input}", "{hint}" and "{error}".

name property

public string $name;

name of this input

required property

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

Gets the value indicating whether this input is required. If this property is not set explicitly, it will be determined by calling CModel::isAttributeRequired for the associated model and attribute of this input.

type property

public string $type;

the type of this input. This can be a widget class name, a path alias of a widget class name, or an input type alias (text, hidden, password, textarea, file, radio, checkbox, listbox, dropdownlist, checkboxlist, or radiolist). If a widget class, it must extend from CInputWidget or (@link CJuiInputWidget).

Method Details

evaluateVisible() method

protected boolean evaluateVisible()

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

Evaluates the visibility of this element. This method will check if the attribute associated with this input is safe for the current model scenario.

getLabel() method

public string getLabel()

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

getRequired() method

public boolean getRequired()

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

Gets the value indicating whether this input is required. If this property is not set explicitly, it will be determined by calling CModel::isAttributeRequired for the associated model and attribute of this input.

render() method

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);
}

Renders everything for this input. The default implementation simply returns the result of renderLabel, renderInput, renderHint. When CForm::showErrorSummary is false, renderError is also called to show error messages after individual input fields.

renderError() method

public string renderError()

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

Renders the error display of this input. The default implementation returns the result of CHtml::error

renderHint() method

public string renderHint()

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

Renders the hint text for this input. The default implementation returns the hint property enclosed in a paragraph HTML tag.

renderInput() method

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();
    }
}

Renders the input field. The default implementation returns the result of the appropriate CHtml method or the widget.

renderLabel() method

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);
}

Renders the label for this input. The default implementation returns the result of activeLabelEx.

setLabel() method

public void setLabel(string $value)

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

setRequired() method

public void setRequired(boolean $value)

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