Класс yii\captcha\Captcha

Captcha отображает изображение CAPTCHA и поле ввода для кода проверки, введённого пользователем.

Captcha используется совместно с yii\captcha\CaptchaAction для предоставления CAPTCHA — способа предотвращения спама на веб-сайтах.

Элемент изображения, отображаемый Captcha, будет показывать изображение CAPTCHA, сгенерированное действием, маршрут которого указан в $captchaAction. Это действие должно быть экземпляром yii\captcha\CaptchaAction.

Когда пользователь нажимает на изображение CAPTCHA, оно будет обновлено новым кодом CAPTCHA.

Можно использовать yii\captcha\CaptchaValidator для проверки соответствия введённого пользователем кода текущему коду проверки CAPTCHA.

Следующий пример показывает, как использовать этот виджет с атрибутом модели:

echo Captcha::widget([
    'model' => $model,
    'attribute' => 'captcha',
]);

Следующий пример будет использовать свойство name вместо:

echo Captcha::widget([
    'name' => 'captcha',
]);

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

<?= $form->field($model, 'captcha')->widget(\yii\captcha\Captcha::classname(), [
    // configure additional widget properties here
]) ?>

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

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

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

События

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

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

Маршрут действия, который генерирует изображения CAPTCHA. Действие, представленное этим маршрутом, должно быть действием yii\captcha\CaptchaAction. Обратитесь к yii\helpers\Url::toRoute() за допустимыми форматами.

public string|array $captchaAction = 'site/captcha'

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

Атрибуты HTML, которые должны быть применены к тегу изображения CAPTCHA.

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

public array $imageOptions = []

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

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

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

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

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

Шаблон для размещения тега изображения CAPTCHA и тега текстового поля ввода. В этом шаблоне токен {image} будет заменён фактическим тегом изображения, а {input} — тегом текстового поля.

public string $template = '{image} {input}'

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