MaskedInput

API reference › yii › widgets › MaskedInput

class	`yii\widgets\MaskedInput`
Extends	`InputWidget` » `yii\base\Widget` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\ViewContextInterface`, `yii\base\Configurable`
Since	2.0
Source	`framework/widgets/MaskedInput.php`

MaskedInput generates a masked text input.

MaskedInput is similar to 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 ActiveForm using the widget() method, for example like this:

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

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

Properties

Property	Type	Description	Defined by
`$aliases`	`array\|null`	Custom aliases to use. Default: `null`.	`MaskedInput`
`$attribute`	`string\|null`	The model attribute that this widget is associated with. Default: `null`.	`InputWidget`
`$autoIdPrefix` static	`string`	The prefix to the automatically generated widget IDs. Default: `'w'`.	`yii\base\Widget`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$clientOptions`	`array`	The JQuery plugin options for the input mask plugin. Default: `[]`.	`MaskedInput`
`$definitions`	`array\|null`	Custom mask definitions to use. Default: `null`.	`MaskedInput`
`$field`	`ActiveField`	Active input field, which triggers this widget rendering. Default: `null`. Available since 2.0.11.	`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). Default: `null`.	`MaskedInput`
`$model`	`yii\base\Model\|null`	The data model that this widget is associated with. Default: `null`.	`InputWidget`
`$name`	`string\|null`	The input name. Default: `null`.	`InputWidget`
`$options`	`array`	The HTML attributes for the input tag. Default: `['class' => 'form-control']`.	`MaskedInput`
`$type`	`string`	The type of the input tag. Default: `'text'`. Available since 2.0.6.	`MaskedInput`
`$value`	`string`	The input value. Default: `null`.	`InputWidget`
`$view`	`yii\web\View`	The view object that can be used to render views or view files.	`yii\base\Widget`
`$viewPath` read-only	`string`	The directory containing the view files for this widget.	`yii\base\Widget`
`$_hashVar` protected	`string\|null`	The hashed variable to store the pluginOptions Default: `null`.	`MaskedInput`
`$_jsCallbacks` protected	`string[]`	The inputmask properties can be contained callbacks Default: `['oncomplete', 'onincomplete', 'oncleared', 'onKeyDown', 'onBeforeMask', 'onBeforePaste', 'onBeforeWrite', 'onUnMask', 'onKeyValidation', 'isComplete', 'preValidation', 'postValidation', 'canClearPosition']`.	`MaskedInput`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__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`
`__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()` static	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()` static	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()` static	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.	`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.	`MaskedInput`
`render()`	Renders a view.	`yii\base\Widget`
`renderFile()`	Renders a view file.	`yii\base\Widget`
`run()`	Executes the widget.	`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()` static	Creates a widget instance and runs it.	`yii\base\Widget`
`hashPluginOptions()` protected	Generates a hashed variable to store the plugin `clientOptions`.	`MaskedInput`
`hasModel()` protected		`InputWidget`
`initClientOptions()` protected	Initializes client options.	`MaskedInput`
`renderInputHtml()` protected	Render a HTML input tag.	`InputWidget`

Events

Event	Type	Description	Defined by
`EVENT_INIT`	`yii\base\Event`	An event that is triggered when the widget is initialized via `init()`. Event name: `'init'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_BEFORE_RUN`	`yii\base\WidgetEvent`	An event raised right before executing a widget. Event name: `'beforeRun'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_AFTER_RUN`	`yii\base\WidgetEvent`	An event raised right after executing a widget. Event name: `'afterRun'`. Available since 2.0.11.	`yii\base\Widget`

Constants

Constant	Value	Description	Defined by
`PLUGIN_NAME`	`'inputmask'`	The name of the jQuery plugin to use for this widget.	`MaskedInput`

Property details

$aliases

public array|null $aliases = null

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.

$definitions

public array|null $definitions = null

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.

$mask

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

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.

$type

public string $type = 'text'

The type of the input tag.

Currently only ‘text’ and ‘tel’ are supported.

Since

2.0.6

Method details

init()

public function init(): mixed

Initializes the widget.

Returns

mixed

Throws

yii\base\InvalidConfigException: if the “mask” property is not set.

registerClientScript()

public function registerClientScript(): mixed

Registers the needed client script and options.

Returns

mixed

run()

public function run(): string|void

Executes the widget.

Returns

string|void: The rendering result may be directly “echoed” or returned as a string

hashPluginOptions()

protected function hashPluginOptions(yii\web\View $view): mixed

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.

Parameters

Parameter	Type	Description
`$view`	`yii\web\View`	The view instance

Returns

mixed

initClientOptions()

protected function initClientOptions(): mixed

Initializes client options.

Returns

mixed