2 followers

Class yii\widgets\ActiveField

Inheritanceyii\widgets\ActiveField » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/widgets/ActiveField.php

ActiveField represents a form input field within an yii\widgets\ActiveForm.

For more details and usage information on ActiveField, see the guide article on forms.

Public Properties

Hide inherited properties

Property Type Description Defined By
$addAriaAttributes boolean Adds aria HTML attributes aria-required and aria-invalid for inputs yii\widgets\ActiveField
$attribute string The model attribute that this field is associated with. yii\widgets\ActiveField
$behaviors yii\base\Behavior[] List of behaviors attached to this component. yii\base\Component
$enableAjaxValidation boolean|null Whether to enable AJAX-based data validation. yii\widgets\ActiveField
$enableClientValidation boolean|null Whether to enable client-side data validation. yii\widgets\ActiveField
$errorOptions array The default options for the error tags. yii\widgets\ActiveField
$form yii\widgets\ActiveForm The form that this field is associated with. yii\widgets\ActiveField
$hintOptions array The default options for the hint tags. yii\widgets\ActiveField
$inputOptions array The default options for the input tags. yii\widgets\ActiveField
$labelOptions array The default options for the label tags. yii\widgets\ActiveField
$model yii\base\Model The data model that this field is associated with. yii\widgets\ActiveField
$options array The HTML attributes (name-value pairs) for the field container tag. yii\widgets\ActiveField
$parts array Different parts of the field (e.g. input, label). yii\widgets\ActiveField
$selectors array The jQuery selectors for selecting the container, input and error tags. yii\widgets\ActiveField
$template string The template that is used to arrange the label, the input field, the error message and the hint text. yii\widgets\ActiveField
$validateOnBlur boolean|null Whether to perform validation when the input field loses focus. yii\widgets\ActiveField
$validateOnChange boolean|null Whether to perform validation when the value of the input field is changed. yii\widgets\ActiveField
$validateOnType boolean|null Whether to perform validation while the user is typing in the input field. yii\widgets\ActiveField
$validationDelay integer|null Number of milliseconds that the validation should be delayed when the user types in the field and $validateOnType is set true. yii\widgets\ActiveField

Public Methods

Hide inherited methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__toString() PHP magic method that returns the string representation of this object. yii\widgets\ActiveField
__unset() Sets a component property to be null. yii\base\Component
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
begin() Renders the opening tag of the field container. yii\widgets\ActiveField
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
checkbox() Renders a checkbox. yii\widgets\ActiveField
checkboxList() Renders a list of checkboxes. yii\widgets\ActiveField
className() Returns the fully qualified name of this class. yii\base\BaseObject
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
end() Renders the closing tag of the field container. yii\widgets\ActiveField
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
error() Generates a tag that contains the first validation error of $attribute. yii\widgets\ActiveField
fileInput() Renders a file input. yii\widgets\ActiveField
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
hiddenInput() Renders a hidden input. yii\widgets\ActiveField
hint() Renders the hint tag. yii\widgets\ActiveField
init() Initializes the object. yii\base\BaseObject
input() Renders an input tag. yii\widgets\ActiveField
label() Generates a label tag for $attribute. yii\widgets\ActiveField
listBox() Renders a list box. yii\widgets\ActiveField
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
passwordInput() Renders a password input. yii\widgets\ActiveField
radio() Renders a radio button. yii\widgets\ActiveField
radioList() Renders a list of radio buttons. yii\widgets\ActiveField
render() Renders the whole field. yii\widgets\ActiveField
textInput() Renders a text input. yii\widgets\ActiveField
textarea() Renders a text area. yii\widgets\ActiveField
trigger() Triggers an event. yii\base\Component
widget() Renders a widget as the input of the field. yii\widgets\ActiveField

Protected Methods

Hide inherited methods

Method Description Defined By
addAriaAttributes() Adds aria attributes to the input options. yii\widgets\ActiveField
addErrorClassIfNeeded() Adds validation class to the input options if needed. yii\widgets\ActiveField
addRoleAttributes() Add role attributes to the input options yii\widgets\ActiveField
adjustLabelFor() Adjusts the for attribute for the label based on the input options. yii\widgets\ActiveField
getClientOptions() Returns the JS options for the field. yii\widgets\ActiveField
getInputId() Returns the HTML id of the input element of this form field. yii\widgets\ActiveField
isAjaxValidationEnabled() Checks if ajax validation enabled for the field. yii\widgets\ActiveField
isClientValidationEnabled() Checks if client validation enabled for the field. yii\widgets\ActiveField

Property Details

Hide inherited properties

$addAriaAttributes public property (available since version 2.0.11)

Adds aria HTML attributes aria-required and aria-invalid for inputs

$attribute public property

The model attribute that this field is associated with.

public string $attribute null
$enableAjaxValidation public property

Whether to enable AJAX-based data validation. If not set, it will take the value of yii\widgets\ActiveForm::$enableAjaxValidation.

$enableClientValidation public property

Whether to enable client-side data validation. If not set, it will take the value of yii\widgets\ActiveForm::$enableClientValidation.

$errorOptions public property

The default options for the error tags. The parameter passed to error() will be merged with this property when rendering the error tag. The following special options are recognized:

  • tag: the tag name of the container element. Defaults to div. Setting it to false will not render a container tag. See also yii\helpers\Html::tag().
  • encode: whether to encode the error output. Defaults to true.

If you set a custom id for the error element, you may need to adjust the $selectors accordingly.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $errorOptions = [
    
'class' => 'help-block',
]
$form public property

The form that this field is associated with.

$hintOptions public property

The default options for the hint tags. The parameter passed to hint() will be merged with this property when rendering the hint tag. The following special options are recognized:

  • tag: the tag name of the container element. Defaults to div. Setting it to false will not render a container tag. See also yii\helpers\Html::tag().

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $hintOptions = [
    
'class' => 'hint-block',
]
$inputOptions public property

The default options for the input tags. The parameter passed to individual input methods (e.g. textInput()) will be merged with this property when rendering the input tag.

If you set a custom id for the input element, you may need to adjust the $selectors accordingly.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $inputOptions = [
    
'class' => 'form-control',
]
$labelOptions public property

The default options for the label tags. The parameter passed to label() will be merged with this property when rendering the label tag.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $labelOptions = [
    
'class' => 'control-label',
]
$model public property

The data model that this field is associated with.

public yii\base\Model $model null
$options public property

The HTML attributes (name-value pairs) for the field container tag. The values will be HTML-encoded using yii\helpers\Html::encode(). If a value is null, the corresponding attribute will not be rendered. The following special options are recognized:

  • tag: the tag name of the container element. Defaults to div. Setting it to false will not render a container tag. See also yii\helpers\Html::tag().

If you set a custom id for the container element, you may need to adjust the $selectors accordingly.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $options = [
    
'class' => 'form-group',
]
$parts public property

Different parts of the field (e.g. input, label). This will be used together with $template to generate the final field HTML code. The keys are the token names in $template, while the values are the corresponding HTML code. Valid tokens include {input}, {label} and {error}. Note that you normally don't need to access this property directly as it is maintained by various methods of this class.

public array $parts = []
$selectors public property

The jQuery selectors for selecting the container, input and error tags. The array keys should be container, input, and/or error, and the array values are the corresponding selectors. For example, ['input' => '#my-input'].

The container selector is used under the context of the form, while the input and the error selectors are used under the context of the container.

You normally do not need to set this property as the default selectors should work well for most cases.

public array $selectors = []
$template public property

The template that is used to arrange the label, the input field, the error message and the hint text. The following tokens will be replaced when render() is called: {label}, {input}, {error} and {hint}.

public string $template "{label}\n{input}\n{hint}\n{error}"
$validateOnBlur public property

Whether to perform validation when the input field loses focus. If not set, it will take the value of yii\widgets\ActiveForm::$validateOnBlur.

$validateOnChange public property

Whether to perform validation when the value of the input field is changed. If not set, it will take the value of yii\widgets\ActiveForm::$validateOnChange.

$validateOnType public property

Whether to perform validation while the user is typing in the input field. If not set, it will take the value of yii\widgets\ActiveForm::$validateOnType.

See also $validationDelay.

$validationDelay public property

Number of milliseconds that the validation should be delayed when the user types in the field and $validateOnType is set true. If not set, it will take the value of yii\widgets\ActiveForm::$validationDelay.

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\Component::__call()

Calls the named method which is not a class method.

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name string

The method name

$params array

Method parameters

return mixed

The method return value

throws yii\base\UnknownMethodException

when calling unknown method

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() public method

Defined in: yii\base\Component::__clone()

This method is called after the object is created by cloning an existing one.

It removes all behaviors because they are attached to the old object.

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() public method

Defined in: yii\base\BaseObject::__construct()

Constructor.

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call init().

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
public void __construct ( $config = [] )
$config array

Name-value pairs that will be used to initialize the object properties

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

            
__get() public method

Defined in: yii\base\Component::__get()

Returns the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a getter: return the getter result
  • a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

See also __set().

public mixed __get ( $name )
$name string

The property name

return mixed

The property value or the value of a behavior's property

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is write-only.

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() public method

Defined in: yii\base\Component::__isset()

Checks if a property is set, i.e. defined and not null.

This method will check in the following order and act accordingly:

  • a property defined by a setter: return whether the property is set
  • a property of a behavior: return whether the property is set
  • return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name

return boolean

Whether the named property is set

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() public method

Defined in: yii\base\Component::__set()

Sets the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value
  • an event in the format of "on xyz": attach the handler to the event "xyz"
  • a behavior in the format of "as xyz": attach the behavior named as "xyz"
  • a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

See also __get().

public void __set ( $name, $value )
$name string

The property name or the event name

$value mixed

The property value

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is read-only.

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__toString() public method

PHP magic method that returns the string representation of this object.

public string __toString ( )
return string

The string representation of this object.

                public function __toString()
{
    // __toString cannot throw exception
    // use trigger_error to bypass this limitation
    try {
        return $this->render();
    } catch (\Exception $e) {
        ErrorHandler::convertExceptionToError($e);
        return '';
    } catch (\Throwable $e) {
        ErrorHandler::convertExceptionToError($e);
        return '';
    }
}

            
__unset() public method

Defined in: yii\base\Component::__unset()

Sets a component property to be null.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value to be null
  • a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name string

The property name

throws yii\base\InvalidCallException

if the property is read only.

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
addAriaAttributes() protected method (available since version 2.0.11)

Adds aria attributes to the input options.

protected void addAriaAttributes ( &$options )
$options

Array input options

                protected function addAriaAttributes(&$options)
{
    // Get proper attribute name when attribute name is tabular.
    $attributeName = Html::getAttributeName($this->attribute);
    if ($this->addAriaAttributes) {
        if (!isset($options['aria-required']) && $this->model->isAttributeRequired($attributeName)) {
            $options['aria-required'] = 'true';
        }
        if (!isset($options['aria-invalid']) && $this->model->hasErrors($attributeName)) {
            $options['aria-invalid'] = 'true';
        }
    }
}

            
addErrorClassIfNeeded() protected method (available since version 2.0.14)

Adds validation class to the input options if needed.

protected void addErrorClassIfNeeded ( &$options )
$options

Array input options

                protected function addErrorClassIfNeeded(&$options)
{
    // Get proper attribute name when attribute name is tabular.
    $attributeName = Html::getAttributeName($this->attribute);
    if ($this->model->hasErrors($attributeName)) {
        Html::addCssClass($options, $this->form->errorCssClass);
    }
}

            
addRoleAttributes() protected method (available since version 2.0.16)

Add role attributes to the input options

protected void addRoleAttributes ( &$options, $role )
$options

Array input options

$role string

                protected function addRoleAttributes(&$options, $role)
{
    if (!isset($options['role'])) {
        $options['role'] = $role;
    }
}

            
adjustLabelFor() protected method

Adjusts the for attribute for the label based on the input options.

protected void adjustLabelFor ( $options )
$options array

The input options.

                protected function adjustLabelFor($options)
{
    if (!isset($options['id'])) {
        return;
    }
    $this->_inputId = $options['id'];
    if (!isset($this->labelOptions['for'])) {
        $this->labelOptions['for'] = $options['id'];
    }
}

            
attachBehavior() public method

Defined in: yii\base\Component::attachBehavior()

Attaches a behavior to this component.

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the yii\base\Behavior::attach() method.

See also detachBehavior().

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

The name of the behavior.

$behavior string|array|yii\base\Behavior

The behavior configuration. This can be one of the following:

return yii\base\Behavior

The behavior object

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() public method

Defined in: yii\base\Component::attachBehaviors()

Attaches a list of behaviors to the component.

Each behavior is indexed by its name and should be a yii\base\Behavior object, a string specifying the behavior class, or an configuration array for creating the behavior.

See also attachBehavior().

public void attachBehaviors ( $behaviors )
$behaviors array

List of behaviors to be attached to the component

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
begin() public method

Renders the opening tag of the field container.

public string begin ( )
return string

The rendering result.

                public function begin()
{
    if ($this->form->enableClientScript) {
        $clientOptions = $this->getClientOptions();
        if (!empty($clientOptions)) {
            $this->form->attributes[] = $clientOptions;
        }
    }
    $inputID = $this->getInputId();
    $attribute = Html::getAttributeName($this->attribute);
    $options = $this->options;
    $class = isset($options['class']) ? (array) $options['class'] : [];
    $class[] = "field-$inputID";
    if ($this->model->isAttributeRequired($attribute)) {
        $class[] = $this->form->requiredCssClass;
    }
    $options['class'] = implode(' ', $class);
    if ($this->form->validationStateOn === ActiveForm::VALIDATION_STATE_ON_CONTAINER) {
        $this->addErrorClassIfNeeded($options);
    }
    $tag = ArrayHelper::remove($options, 'tag', 'div');
    return Html::beginTag($tag, $options);
}

            
behaviors() public method

Defined in: yii\base\Component::behaviors()

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from yii\base\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

public array behaviors ( )
return array

The behavior configurations.

                public function behaviors()
{
    return [];
}

            
canGetProperty() public method

Defined in: yii\base\Component::canGetProperty()

Returns a value indicating whether a property can be read.

A property can be read if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a readable property of the given name (when $checkBehaviors is true).

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property can be read

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() public method

Defined in: yii\base\Component::canSetProperty()

Returns a value indicating whether a property can be set.

A property can be written if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a writable property of the given name (when $checkBehaviors is true).

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property can be written

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
checkbox() public method

Renders a checkbox.

This method will generate the checked tag attribute according to the model attribute value.

public $this checkbox ( $options = [], $enclosedByLabel true )
$options array

The tag options in terms of name-value pairs. The following options are specially handled:

  • uncheck: string, the value associated with the uncheck state of the radio button. If not set, it will take the default value 0. This method will render a hidden input so that if the radio button is not checked and is submitted, the value of this attribute will still be submitted to the server via the hidden input. If you do not want any hidden input, you should explicitly set this option as null.
  • label: string, a label displayed next to the checkbox. It will NOT be HTML-encoded. Therefore you can pass in HTML code such as an image tag. If this is coming from end users, you should encode it to prevent XSS attacks. When this option is specified, the checkbox will be enclosed by a label tag. If you do not want any label, you should explicitly set this option as null.
  • labelOptions: array, the HTML attributes for the label tag. This is only used when the label option is specified.

The rest of the options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode(). If a value is null, the corresponding attribute will not be rendered.

If you set a custom id for the input element, you may need to adjust the $selectors accordingly.

$enclosedByLabel boolean

Whether to enclose the checkbox within the label. If true, the method will still use $template to layout the checkbox and the error message except that the checkbox is enclosed by the label tag.

return $this

The field object itself.

                public function checkbox($options = [], $enclosedByLabel = true)
{
    if ($this->form->validationStateOn === ActiveForm::VALIDATION_STATE_ON_INPUT) {
        $this->addErrorClassIfNeeded($options);
    }
    $this->addAriaAttributes($options);
    $this->adjustLabelFor($options);
    if ($enclosedByLabel) {
        $this->parts['{input}'] = Html::activeCheckbox($this->model, $this->attribute, $options);
        $this->parts['{label}'] = '';
    } else {
        if (isset($options['label']) && !isset($this->parts['{label}'])) {
            $this->parts['{label}'] = $options['label'];
            if (!empty($options['labelOptions'])) {
                $this->labelOptions = $options['labelOptions'];
            }
        }
        unset($options['labelOptions']);
        $options['label'] = null;
        $this->parts['{input}'] = Html::activeCheckbox($this->model, $this->attribute, $options);
    }
    return $this;
}

            
checkboxList() public method

Renders a list of checkboxes.

A checkbox list allows multiple selection, like listBox(). As a result, the corresponding submitted value is an array. The selection of the checkbox list is taken from the value of the model attribute.

public $this checkboxList ( $items, $options = [] )
$items array

The data item used to generate the checkboxes. The array values are the labels, while the array keys are the corresponding checkbox values.

$options array

Options (name => config) for the checkbox list. For the list of available options please refer to the $options parameter of yii\helpers\Html::activeCheckboxList().

return $this

The field object itself.

                public function checkboxList($items, $options = [])
{
    if ($this->form->validationStateOn === ActiveForm::VALIDATION_STATE_ON_INPUT) {
        $this->addErrorClassIfNeeded($options);
    }
    $this->addAriaAttributes($options);
    $this->adjustLabelFor($options);
    $this->_skipLabelFor = true;
    $this->parts['{input}'] = Html::activeCheckboxList($this->model, $this->attribute, $items, $options);
    return $this;
}

            
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return string

The fully qualified name of this class.

                public static function className()
{
    return get_called_class();
}

            
detachBehavior() public method

Defined in: yii\base\Component::detachBehavior()

Detaches a behavior from the component.

The behavior's yii\base\Behavior::detach() method will be invoked.

public yii\base\Behavior|null detachBehavior ( $name )
$name string

The behavior's name.

return yii\base\Behavior|null

The detached behavior. Null if the behavior does not exist.

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() public method

Defined in: yii\base\Component::detachBehaviors()

Detaches all behaviors from the component.

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
end() public method

Renders the closing tag of the field container.

public string end ( )
return string

The rendering result.

                public function end()
{
    return Html::endTag(ArrayHelper::keyExists('tag', $this->options) ? $this->options['tag'] : 'div');
}

            
ensureBehaviors() public method

Defined in: yii\base\Component::ensureBehaviors()

Makes sure that the behaviors declared in behaviors() are attached to this component.

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
error() public method

Generates a tag that contains the first validation error of $attribute.

Note that even if there is no validation error, this method will still return an empty error tag.

See also $errorOptions.

public $this error ( $options = [] )
$options array|false

The tag options in terms of name-value pairs. It will be merged with $errorOptions. The options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode(). If this parameter is false, no error tag will be rendered.

The following options are specially handled:

If you set a custom id for the error element, you may need to adjust the $selectors accordingly.

return $this

The field object itself.

                public function error($options = [])
{
    if ($options === false) {
        $this->parts['{error}'] = '';
        return $this;
    }
    $options = array_merge($this->errorOptions, $options);
    $this->parts['{error}'] = Html::error($this->model, $this->attribute, $options);
    return $this;
}

            
fileInput() public method

Renders a file input.

This method will generate the name and value tag attributes automatically for the model attribute unless they are explicitly specified in $options.

public $this fileInput ( $options = [] )
$options array

The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode().

If you set a custom id for the input element, you may need to adjust the $selectors accordingly.

return $this

The field object itself.

                public function fileInput($options = [])
{
    // https://github.com/yiisoft/yii2/pull/795
    if ($this->inputOptions !== ['class' => 'form-control']) {
        $options = array_merge($this->inputOptions, $options);
    }
    // https://github.com/yiisoft/yii2/issues/8779
    if (!isset($this->form->options['enctype'])) {
        $this->form->options['enctype'] = 'multipart/form-data';
    }
    if ($this->form->validationStateOn === ActiveForm::VALIDATION_STATE_ON_INPUT) {
        $this->addErrorClassIfNeeded($options);
    }
    $this->addAriaAttributes($options);
    $this->adjustLabelFor($options);
    $this->parts['{input}'] = Html::activeFileInput($this->model, $this->attribute, $options);
    return $this;
}

            
getBehavior() public method

Defined in: yii\base\Component::getBehavior()

Returns the named behavior object.

public yii\base\Behavior|null getBehavior ( $name )
$name string

The behavior name

return yii\base\Behavior|null

The behavior object, or null if the behavior does not exist

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() public method

Defined in: yii\base\Component::getBehaviors()

Returns all behaviors attached to this component.

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

List of behaviors attached to this component

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getClientOptions() protected method

Returns the JS options for the field.

protected array getClientOptions ( )
return array

The JS options.

                protected function getClientOptions()
{
    $attribute = Html::getAttributeName($this->attribute);
    if (!in_array($attribute, $this->model->activeAttributes(), true)) {
        return [];
    }
    $clientValidation = $this->isClientValidationEnabled();
    $ajaxValidation = $this->isAjaxValidationEnabled();
    if ($clientValidation) {
        $validators = [];
        foreach ($this->model->getActiveValidators($attribute) as $validator) {
            /* @var $validator \yii\validators\Validator */
            $js = $validator->clientValidateAttribute($this->model, $attribute, $this->form->getView());
            if ($validator->enableClientValidation && $js != '') {
                if ($validator->whenClient !== null) {
                    $js = "if (({$validator->whenClient})(attribute, value)) { $js }";
                }
                $validators[] = $js;
            }
        }
    }
    if (!$ajaxValidation && (!$clientValidation || empty($validators))) {
        return [];
    }
    $options = [];
    $inputID = $this->getInputId();
    $options['id'] = Html::getInputId($this->model, $this->attribute);
    $options['name'] = $this->attribute;
    $options['container'] = isset($this->selectors['container']) ? $this->selectors['container'] : ".field-$inputID";
    $options['input'] = isset($this->selectors['input']) ? $this->selectors['input'] : "#$inputID";
    if (isset($this->selectors['error'])) {
        $options['error'] = $this->selectors['error'];
    } elseif (isset($this->errorOptions['class'])) {
        $options['error'] = '.' . implode('.', preg_split('/\s+/', $this->errorOptions['class'], -1, PREG_SPLIT_NO_EMPTY));
    } else {
        $options['error'] = isset($this->errorOptions['tag']) ? $this->errorOptions['tag'] : 'span';
    }
    $options['encodeError'] = !isset($this->errorOptions['encode']) || $this->errorOptions['encode'];
    if ($ajaxValidation) {
        $options['enableAjaxValidation'] = true;
    }
    foreach (['validateOnChange', 'validateOnBlur', 'validateOnType', 'validationDelay'] as $name) {
        $options[$name] = $this->$name === null ? $this->form->$name : $this->$name;
    }
    if (!empty($validators)) {
        $options['validate'] = new JsExpression('function (attribute, value, messages, deferred, $form) {' . implode('', $validators) . '}');
    }
    if ($this->addAriaAttributes === false) {
        $options['updateAriaInvalid'] = false;
    }
    // only get the options that are different from the default ones (set in yii.activeForm.js)
    return array_diff_assoc($options, [
        'validateOnChange' => true,
        'validateOnBlur' => true,
        'validateOnType' => false,
        'validationDelay' => 500,
        'encodeError' => true,
        'error' => '.help-block',
        'updateAriaInvalid' => true,
    ]);
}

            
getInputId() protected method (available since version 2.0.7)

Returns the HTML id of the input element of this form field.

protected string getInputId ( )
return string

The input id.

                protected function getInputId()
{
    return $this->_inputId ?: Html::getInputId($this->model, $this->attribute);
}

            
hasEventHandlers() public method

Defined in: yii\base\Component::hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.

public boolean hasEventHandlers ( $name )
$name string

The event name

return boolean

Whether there is any handler attached to the event.

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public method

Defined in: yii\base\Component::hasMethod()

Returns a value indicating whether a method is defined.

A method is defined if:

  • the class has a method with the specified name
  • an attached behavior has a method with the given name (when $checkBehaviors is true).
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

The property name

$checkBehaviors boolean

Whether to treat behaviors' methods as methods of this component

return boolean

Whether the method is defined

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public method

Defined in: yii\base\Component::hasProperty()

Returns a value indicating whether a property is defined for this component.

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a property of the given name (when $checkBehaviors is true).

See also:

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property is defined

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
hiddenInput() public method

Renders a hidden input.

Note that this method is provided for completeness. In most cases because you do not need to validate a hidden input, you should not need to use this method. Instead, you should use yii\helpers\Html::activeHiddenInput().

This method will generate the name and value tag attributes automatically for the model attribute unless they are explicitly specified in $options.

public $this hiddenInput ( $options = [] )
$options array

The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode().

If you set a custom id for the input element, you may need to adjust the $selectors accordingly.

return $this

The field object itself.

                public function hiddenInput($options = [])
{
    $options = array_merge($this->inputOptions, $options);
    $this->adjustLabelFor($options);
    $this->parts['{input}'] = Html::activeHiddenInput($this->model, $this->attribute, $options);
    return $this;
}

            
hint() public method

Renders the hint tag.

public $this hint ( $content, $options = [] )
$content string|boolean|null

The hint content. If null, the hint will be generated via yii\base\Model::getAttributeHint(). If false, the generated field will not contain the hint part. Note that this will NOT be encoded.

$options array

The tag options in terms of name-value pairs. These will be rendered as the attributes of the hint tag. The values will be HTML-encoded using yii\helpers\Html::encode().

The following options are specially handled:

return $this

The field object itself.

                public function hint($content, $options = [])
{
    if ($content === false) {
        $this->parts['{hint}'] = '';
        return $this;
    }
    $options = array_merge($this->hintOptions, $options);
    if ($content !== null) {
        $options['hint'] = $content;
    }
    $this->parts['{hint}'] = Html::activeHint($this->model, $this->attribute, $options);
    return $this;
}

            
init() public method

Defined in: yii\base\BaseObject::init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

                public function init()
{
}

            
input() public method

Renders an input tag.

public $this input ( $type, $options = [] )
$type string

The input type (e.g. text, password)

$options array

The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode().

If you set a custom id for the input element, you may need to adjust the $selectors accordingly.

return $this

The field object itself.

                public function input($type, $options = [])
{
    $options = array_merge($this->inputOptions, $options);
    if ($this->form->validationStateOn === ActiveForm::VALIDATION_STATE_ON_INPUT) {
        $this->addErrorClassIfNeeded($options);
    }
    $this->addAriaAttributes($options);
    $this->adjustLabelFor($options);
    $this->parts['{input}'] = Html::activeInput($type, $this->model, $this->attribute, $options);
    return $this;
}

            
isAjaxValidationEnabled() protected method (available since version 2.0.11)

Checks if ajax validation enabled for the field.

protected boolean isAjaxValidationEnabled ( )

                protected function isAjaxValidationEnabled()
{
    return $this->enableAjaxValidation || $this->enableAjaxValidation === null && $this->form->enableAjaxValidation;
}

            
isClientValidationEnabled() protected method (available since version 2.0.11)

Checks if client validation enabled for the field.

protected boolean isClientValidationEnabled ( )

                protected function isClientValidationEnabled()
{
    return $this->enableClientValidation || $this->enableClientValidation === null && $this->form->enableClientValidation;
}

            
label() public method

Generates a label tag for $attribute.

public $this label ( $label null, $options = [] )
$label string|null|false

The label to use. If null, the label will be generated via yii\base\Model::getAttributeLabel(). If false, the generated field will not contain the label part. Note that this will NOT be encoded.

$options array|null

The tag options in terms of name-value pairs. It will be merged with $labelOptions. The options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode(). If a value is null, the corresponding attribute will not be rendered.

return $this

The field object itself.

                public function label($label = null, $options = [])
{
    if ($label === false) {
        $this->parts['{label}'] = '';
        return $this;
    }
    $options = array_merge($this->labelOptions, $options);
    if ($label !== null) {
        $options['label'] = $label;
    }
    if ($this->_skipLabelFor) {
        $options['for'] = null;
    }
    $this->parts['{label}'] = Html::activeLabel($this->model, $this->attribute, $options);
    return $this;
}

            
listBox() public method

Renders a list box.

The selection of the list box is taken from the value of the model attribute.

public $this listBox ( $items, $options = [] )
$items array

The option data items. The array keys are option values, and the array values are the corresponding option labels. The array can also be nested (i.e. some array values are arrays too). For each sub-array, an option group will be generated whose label is the key associated with the sub-array. If you have a list of data models, you may convert them into the format described above using yii\helpers\ArrayHelper::map().

Note, the values and labels will be automatically HTML-encoded by this method, and the blank spaces in the labels will also be HTML-encoded.

$options array

The tag options in terms of name-value pairs.

For the list of available options please refer to the $options parameter of yii\helpers\Html::activeListBox().

If you set a custom id for the input element, you may need to adjust the $selectors accordingly.

return $this

The field object itself.

                public function listBox($items, $options = [])
{
    $options = array_merge($this->inputOptions, $options);
    if ($this->form->validationStateOn === ActiveForm::VALIDATION_STATE_ON_INPUT) {
        $this->addErrorClassIfNeeded($options);
    }
    $this->addAriaAttributes($options);
    $this->adjustLabelFor($options);
    $this->parts['{input}'] = Html::activeListBox($this->model, $this->attribute, $items, $options);
    return $this;
}

            
off() public method

Defined in: yii\base\Component::off()

Detaches an existing event handler from this component.

This method is the opposite of on().

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

See also on().

public boolean off ( $name, $handler null )
$name string

Event name

$handler callable|null

The event handler to be removed. If it is null, all handlers attached to the named event will be removed.

return boolean

If a handler is found and detached

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() public method

Defined in: yii\base\Component::on()

Attaches an event handler to an event.

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an yii\base\Event object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

See also off().

public void on ( $name, $handler, $data null, $append true )
$name string

The event name

$handler callable

The event handler

$data mixed

The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via yii\base\Event::$data.

$append boolean

Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
passwordInput() public method

Renders a password input.

This method will generate the name and value tag attributes automatically for the model attribute unless they are explicitly specified in $options.

public $this passwordInput ( $options = [] )
$options array

The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode().

If you set a custom id for the input element, you may need to adjust the $selectors accordingly.

return $this

The field object itself.

                public function passwordInput($options = [])
{
    $options = array_merge($this->inputOptions, $options);
    if ($this->form->validationStateOn === ActiveForm::VALIDATION_STATE_ON_INPUT) {
        $this->addErrorClassIfNeeded($options);
    }
    $this->addAriaAttributes($options);
    $this->adjustLabelFor($options);
    $this->parts['{input}'] = Html::activePasswordInput($this->model, $this->attribute, $options);
    return $this;
}

            
radio() public method

Renders a radio button.

This method will generate the checked tag attribute according to the model attribute value.

public $this radio ( $options = [], $enclosedByLabel true )
$options array

The tag options in terms of name-value pairs. The following options are specially handled:

  • uncheck: string, the value associated with the uncheck state of the radio button. If not set, it will take the default value 0. This method will render a hidden input so that if the radio button is not checked and is submitted, the value of this attribute will still be submitted to the server via the hidden input. If you do not want any hidden input, you should explicitly set this option as null.
  • label: string, a label displayed next to the radio button. It will NOT be HTML-encoded. Therefore you can pass in HTML code such as an image tag. If this is coming from end users, you should encode it to prevent XSS attacks. When this option is specified, the radio button will be enclosed by a label tag. If you do not want any label, you should explicitly set this option as null.
  • labelOptions: array, the HTML attributes for the label tag. This is only used when the label option is specified.

The rest of the options will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode(). If a value is null, the corresponding attribute will not be rendered.

If you set a custom id for the input element, you may need to adjust the $selectors accordingly.

$enclosedByLabel boolean

Whether to enclose the radio within the label. If true, the method will still use $template to layout the radio button and the error message except that the radio is enclosed by the label tag.

return $this

The field object itself.

                public function radio($options = [], $enclosedByLabel = true)
{
    if ($this->form->validationStateOn === ActiveForm::VALIDATION_STATE_ON_INPUT) {
        $this->addErrorClassIfNeeded($options);
    }
    $this->addAriaAttributes($options);
    $this->adjustLabelFor($options);
    if ($enclosedByLabel) {
        $this->parts['{input}'] = Html::activeRadio($this->model, $this->attribute, $options);
        $this->parts['{label}'] = '';
    } else {
        if (isset($options['label']) && !isset($this->parts['{label}'])) {
            $this->parts['{label}'] = $options['label'];
            if (!empty($options['labelOptions'])) {
                $this->labelOptions = $options['labelOptions'];
            }
        }
        unset($options['labelOptions']);
        $options['label'] = null;
        $this->parts['{input}'] = Html::activeRadio($this->model, $this->attribute, $options);
    }
    return $this;
}

            
radioList() public method

Renders a list of radio buttons.

A radio button list is like a checkbox list, except that it only allows single selection. The selection of the radio buttons is taken from the value of the model attribute.

public $this radioList ( $items, $options = [] )
$items array

The data item used to generate the radio buttons. The array values are the labels, while the array keys are the corresponding radio values.

$options array

Options (name => config) for the radio button list. For the list of available options please refer to the $options parameter of yii\helpers\Html::activeRadioList().

return $this

The field object itself.

                public function radioList($items, $options = [])
{
    if ($this->form->validationStateOn === ActiveForm::VALIDATION_STATE_ON_INPUT) {
        $this->addErrorClassIfNeeded($options);
    }
    $this->addRoleAttributes($options, 'radiogroup');
    $this->addAriaAttributes($options);
    $this->adjustLabelFor($options);
    $this->_skipLabelFor = true;
    $this->parts['{input}'] = Html::activeRadioList($this->model, $this->attribute, $items, $options);
    return $this;
}

            
render() public method

Renders the whole field.

This method will generate the label, error tag, input tag and hint tag (if any), and assemble them into HTML according to $template.

public string render ( $content null )
$content string|callable|null

The content within the field container. If null (not set), the default methods will be called to generate the label, error tag and input tag, and use them as the content. If a callable, it will be called to generate the content. The signature of the callable should be:

function ($field) {
    return $html;
}
return string

The rendering result.

                public function render($content = null)
{
    if ($content === null) {
        if (!isset($this->parts['{input}'])) {
            $this->textInput();
        }
        if (!isset($this->parts['{label}'])) {
            $this->label();
        }
        if (!isset($this->parts['{error}'])) {
            $this->error();
        }
        if (!isset($this->parts['{hint}'])) {
            $this->hint(null);
        }
        $content = strtr($this->template, $this->parts);
    } elseif (!is_string($content)) {
        $content = call_user_func($content, $this);
    }
    return $this->begin() . "\n" . $content . "\n" . $this->end();
}

            
textInput() public method

Renders a text input.

This method will generate the name and value tag attributes automatically for the model attribute unless they are explicitly specified in $options.

public $this textInput ( $options = [] )
$options array

The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode().

The following special options are recognized:

  • maxlength: int|bool, when maxlength is set true and the model attribute is validated by a string validator, the maxlength option will take the value of yii\validators\StringValidator::$max. This is available since version 2.0.3.

Note that if you set a custom id for the input element, you may need to adjust the value of $selectors accordingly.

return $this

The field object itself.

                public function textInput($options = [])
{
    $options = array_merge($this->inputOptions, $options);
    if ($this->form->validationStateOn === ActiveForm::VALIDATION_STATE_ON_INPUT) {
        $this->addErrorClassIfNeeded($options);
    }
    $this->addAriaAttributes($options);
    $this->adjustLabelFor($options);
    $this->parts['{input}'] = Html::activeTextInput($this->model, $this->attribute, $options);
    return $this;
}

            
textarea() public method

Renders a text area.

The model attribute value will be used as the content in the textarea.

public $this textarea ( $options = [] )
$options array

The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode().

If you set a custom id for the textarea element, you may need to adjust the $selectors accordingly.

return $this

The field object itself.

                public function textarea($options = [])
{
    $options = array_merge($this->inputOptions, $options);
    if ($this->form->validationStateOn === ActiveForm::VALIDATION_STATE_ON_INPUT) {
        $this->addErrorClassIfNeeded($options);
    }
    $this->addAriaAttributes($options);
    $this->adjustLabelFor($options);
    $this->parts['{input}'] = Html::activeTextarea($this->model, $this->attribute, $options);
    return $this;
}

            
trigger() public method

Defined in: yii\base\Component::trigger()

Triggers an event.

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

public void trigger ( $name, yii\base\Event $event null )
$name string

The event name

$event yii\base\Event|null

The event instance. If not set, a default yii\base\Event object will be created.

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

            
widget() public method

Renders a widget as the input of the field.

Note that the widget must have both model and attribute properties. They will be initialized with $model and $attribute of this field, respectively.

If you want to use a widget that does not have model and attribute properties, please use render() instead.

While widgets extending from yii\base\Widget work with active field, it is preferred to use yii\widgets\InputWidget as a base class.

For example to use the yii\widgets\MaskedInput widget to get some date input, you can use the following code, assuming that $form is your yii\widgets\ActiveForm instance:

$form->field($model, 'date')->widget(\yii\widgets\MaskedInput::class, [
    'mask' => '99/99/9999',
]);

If you set a custom id for the input element, you may need to adjust the $selectors accordingly.

public $this widget ( $class, $config = [] )
$class string

The widget class name.

$config array

Name-value pairs that will be used to initialize the widget.

return $this

The field object itself.

throws Exception

                public function widget($class, $config = [])
{
    /* @var $class \yii\base\Widget */
    $config['model'] = $this->model;
    $config['attribute'] = $this->attribute;
    $config['view'] = $this->form->getView();
    if (is_subclass_of($class, 'yii\widgets\InputWidget')) {
        foreach ($this->inputOptions as $key => $value) {
            if (!isset($config['options'][$key])) {
                $config['options'][$key] = $value;
            }
        }
        $config['field'] = $this;
        if (!isset($config['options'])) {
            $config['options'] = [];
        }
        if ($this->form->validationStateOn === ActiveForm::VALIDATION_STATE_ON_INPUT) {
            $this->addErrorClassIfNeeded($config['options']);
        }
        $this->addAriaAttributes($config['options']);
        $this->adjustLabelFor($config['options']);
    }
    $this->parts['{input}'] = $class::widget($config);
    return $this;
}