Класс yii\widgets\MaskedInput

MaskedInput генерирует замаскированное текстовое поле ввода.

MaskedInput похож на yii\helpers\Html::textInput(), за исключением того, что для ввода данных используется маска, что позволяет принудительно вводить данные в правильном формате, например, номера телефонов, номера социального страхования.

Для использования MaskedInput необходимо установить свойство $mask. Следующий пример демонстрирует, как использовать MaskedInput для сбора номеров телефонов:

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

Этот виджет также можно использовать в yii\widgets\ActiveForm с помощью метода widget(), например, так:

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

Замаскированное текстовое поле реализовано с использованием плагина jQuery для маскирования ввода.

Публичные свойства

Защищённые свойства

Публичные методы

Защищённые методы

События

Константы

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

$_hashVar защищённое свойство

Хэшированная переменная для хранения pluginOptions

protected string $_hashVar = null

$aliases общедоступное свойство

Пользовательские псевдонимы для использования. Должны быть настроены как maskAlias => settings, где

• maskAlias — строка, содержащая текст для идентификации определения псевдонима маски (например, 'phone'), и
• settings — массив, содержащий настройки символа маски, точно такие же, как параметры, переданные в $clientOptions.

public array $aliases = null

$clientOptions открытое свойство

Параметры плагина JQuery для плагина маски ввода.

См. также https://github.com/RobinHerbots/Inputmask.

public array $clientOptions = []

$definitions открытое свойство

Пользовательские определения масок для использования. Должны быть настроены как maskSymbol => settings, где

• maskSymbol — строка, содержащая символ для идентификации вашего определения маски, и
• settings — массив, состоящий из следующих элементов:
  • validator: строка, регулярное выражение JS или функция JS.
  • cardinality: целое число, определяющее количество символов, которые представляются и проверяются для определения.
  • prevalidator: массив, проверяет символы перед достижением кардинальности определения.
  • definitionSymbol: строка, разрешает перемещение значений из других определений с этим definitionSymbol.

public array $definitions = null

$mask открытое свойство

Маска ввода (например, '99/99/9999' для ввода даты). Следующие символы могут быть использованы в маске и предварительно определены:

• a: представляет буквенный символ (A-Z, a-z)
• 9: представляет числовой символ (0-9)
• *: представляет буквенно-цифровой символ (A-Z, a-z, 0-9)
• [ и ]: все вводимые между квадратными скобками рассматриваются как необязательный пользовательский ввод. Это основано на настройке optionalmarker в $clientOptions.

Дополнительные определения могут быть установлены через свойство $definitions.

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

$options открытое свойство

Атрибуты HTML для тега input.

См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как рендерятся атрибуты.

public array $options = ['class' => 'form-control']

$type открытое свойство (доступно начиная с версии 2.0.6)

Тип тега input. В настоящее время поддерживаются только 'text' и 'tel'.

См. также https://github.com/RobinHerbots/Inputmask.

public string $type = 'text'

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