Class yii\widgets\MaskedInput

All Classes | Properties | Methods | Events | Constants
Inheritanceyii\widgets\MaskedInput » yii\widgets\InputWidget » yii\base\Widget » yii\base\Component » yii\base\Object
Implementsyii\base\Configurable, yii\base\ViewContextInterface
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/widgets/MaskedInput.php

MaskedInput generates a masked text input.

MaskedInput is similar to yii\helpers\Html::textInput() except that an input mask will be used to force users to enter properly formatted data, such as phone numbers, social security numbers.

To use MaskedInput, you must set the $mask property. The following example shows how to use MaskedInput to collect phone numbers:

echo MaskedInput::widget([
    'name' => 'phone',
    'mask' => '999-999-9999',
]);

You can also use this widget in an yii\widgets\ActiveForm using the widget() method, for example like this:

<?= $form->field($model, 'from_date')->widget(\yii\widgets\MaskedInput::className(), [
    'mask' => '999-999-9999',
]) ?>

The masked text field is implemented based on the jQuery input masked plugin.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$aliases array Custom aliases to use. yii\widgets\MaskedInput
$attribute string The model attribute that this widget is associated with. yii\widgets\InputWidget
$autoIdPrefix string The prefix to the automatically generated widget IDs. yii\base\Widget
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$clientOptions array The JQuery plugin options for the input mask plugin. yii\widgets\MaskedInput
$counter integer A counter used to generate $id for widgets. yii\base\Widget
$definitions array Custom mask definitions to use. yii\widgets\MaskedInput
$field yii\widgets\ActiveField Active input field, which triggers this widget rendering. yii\widgets\InputWidget
$id string ID of the widget. yii\base\Widget
$mask string|array|yii\web\JsExpression The input mask (e.g. '99/99/9999' for date input). yii\widgets\MaskedInput
$model yii\base\Model The data model that this widget is associated with. yii\widgets\InputWidget
$name string The input name. yii\widgets\InputWidget
$options array The HTML attributes for the input tag. yii\widgets\MaskedInput
$stack yii\base\Widget[] The widgets that are currently being rendered (not ended). yii\base\Widget
$type string The type of the input tag. yii\widgets\MaskedInput
$value string The input value. yii\widgets\InputWidget
$view yii\web\View The view object that can be used to render views or view files. yii\base\Widget
$viewPath string The directory containing the view files for this widget. yii\base\Widget

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$_hashVar string The hashed variable to store the pluginOptions yii\widgets\MaskedInput

Public Methods

Hide inherited methods

MethodDescriptionDefined 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\Object
__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
__unset() Sets a component property to be null. yii\base\Component
afterRun() This method is invoked right after a widget is executed. yii\base\Widget
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
beforeRun() This method is invoked right before the widget is executed. yii\base\Widget
begin() Begins a widget. yii\base\Widget
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
className() Returns the fully qualified name of this class. yii\base\Object
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
end() Ends a widget. yii\base\Widget
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getId() Returns the ID of the widget. yii\base\Widget
getView() Returns the view object that can be used to render views or view files. yii\base\Widget
getViewPath() Returns the directory containing the view files for this widget. yii\base\Widget
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
init() Initializes the widget. yii\widgets\MaskedInput
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
registerClientScript() Registers the needed client script and options. yii\widgets\MaskedInput
render() Renders a view. yii\base\Widget
renderFile() Renders a view file. yii\base\Widget
run() Executes the widget. yii\widgets\MaskedInput
setId() Sets the ID of the widget. yii\base\Widget
setView() Sets the view object to be used by this widget. yii\base\Widget
trigger() Triggers an event. yii\base\Component
widget() Creates a widget instance and runs it. yii\base\Widget

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
hasModel() yii\widgets\InputWidget
hashPluginOptions() Generates a hashed variable to store the plugin clientOptions. Helps in reusing the variable for similar options passed for other widgets on the same page. The following special data attribute will also be added to the input field to allow accessing the client options via javascript: yii\widgets\MaskedInput
initClientOptions() Initializes client options yii\widgets\MaskedInput

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_AFTER_RUN yii\base\WidgetEvent An event raised right after executing a widget. (available since version 2.0.11) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent An event raised right before executing a widget. (available since version 2.0.11) yii\base\Widget
EVENT_INIT yii\base\Event An event that is triggered when the widget is initialized via init(). (available since version 2.0.11) yii\base\Widget

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
PLUGIN_NAME 'inputmask' The name of the jQuery plugin to use for this widget. yii\widgets\MaskedInput

Property Details

$_hashVar protected property

The hashed variable to store the pluginOptions

protected string $_hashVar = null
$aliases public property

Custom aliases to use. Should be configured as maskAlias => settings, where

  • maskAlias is a string containing a text to identify your mask alias definition (e.g. 'phone') and
  • settings is an array containing settings for the mask symbol, exactly similar to parameters as passed in $clientOptions.
public array $aliases = null
$clientOptions public property

The JQuery plugin options for the input mask plugin.

See also https://github.com/RobinHerbots/jquery.inputmask.

public array $clientOptions = []
$definitions public property

Custom mask definitions to use. Should be configured as maskSymbol => settings, where

  • maskSymbol is a string, containing a character to identify your mask definition and
  • settings is an array, consisting of the following entries:
    • validator: string, a JS regular expression or a JS function.
    • cardinality: int, specifies how many characters are represented and validated for the definition.
    • prevalidator: array, validate the characters before the definition cardinality is reached.
    • definitionSymbol: string, allows shifting values from other definitions, with this definitionSymbol.
public array $definitions = null
$mask public property

The input mask (e.g. '99/99/9999' for date input). The following characters can be used in the mask and are predefined:

  • a: represents an alpha character (A-Z, a-z)
  • 9: represents a numeric character (0-9)
  • *: represents an alphanumeric character (A-Z, a-z, 0-9)
  • [ and ]: anything entered between the square brackets is considered optional user input. This is based on the optionalmarker setting in $clientOptions.

Additional definitions can be set through the $definitions property.

public string|array|yii\web\JsExpression $mask = null
$options public property

The HTML attributes for the input tag.

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

public array $options = ['class' => 'form-control']
$type public property (available since version 2.0.6)

The type of the input tag. Currently only 'text' and 'tel' are supported.

See also https://github.com/RobinHerbots/jquery.inputmask.

public string $type = 'text'

Method Details

hashPluginOptions() protected method

Generates a hashed variable to store the plugin clientOptions. Helps in reusing the variable for similar options passed for other widgets on the same page. The following special data attribute will also be added to the input field to allow accessing the client options via javascript:

  • 'data-plugin-inputmask' will store the hashed variable storing the plugin options.
protected void hashPluginOptions ( $view )
$view yii\web\View

The view instance
init() public method

Initializes the widget.

public void init ( )
throws yii\base\InvalidConfigException

if the "mask" property is not set.
initClientOptions() protected method

Initializes client options

protected void initClientOptions ( )
registerClientScript() public method

Registers the needed client script and options.

public void registerClientScript ( )
run() public method

Executes the widget.

public string run ( )
return string

The result of widget execution to be outputted.