Версия: 6.x
burger close
Класс AbstractCaptcha
Граф наследования:AbstractCaptcha:
ReCaptcha3 RSDefault Stub

Подробное описание

Абстрактный класс капчи. Любой класс капчи в системе должен быть потомком данного класса.

Открытые члены

 getShortName ()
 
 getTitle ()
 
 getFieldTitle ()
 
 getView ($name, $context=null, $attributes=[], $view_options=null, $template=null)
 
 check ($data, $context=null)
 
 errorText ()
 
 actionDefault ()
 
 onStart ()
 

Защищенные члены

 getReadyAttributes ($attributes=null)
 

Методы

actionDefault ( )

Действие по умолчанию

check (   $data,
  $context = null 
)
abstract

Проверяет правильность заполнения капчи

Аргументы
mixed$data- данные для проверки
string$context- контекст капчи
Возвращает
bool
errorText ( )

Возвращает текст ошибки, в случае если метод check возвращает false

Возвращает
string
getFieldTitle ( )
abstract

Возвращает название поля для клиентских форм

Возвращает
string
getReadyAttributes (   $attributes = null)
protected

Превращает массив атрибутов в строку

Аргументы
array$attributes
Возвращает
string
getShortName ( )
abstract

Возвращает идентификатор класса капчи

Возвращает
string
getTitle ( )
abstract

Возвращает внутреннее название класса капчи

Возвращает
string
getView (   $name,
  $context = null,
  $attributes = [],
  $view_options = null,
  $template = null 
)
abstract

Возвращает HTML капчи

Аргументы
string$name- атрибут name для шаблона отображения
string$context- контекст капчи
array$attributes- дополнительные атрибуты для Dom элемента капчи
array | null$view_options- параметры отображения формы. если null, то отображать все Возможные элементы массива: 'form' - форма, 'error' - блок с ошибками, 'hint' - ярлык с подсказкой,
string$template- используемый шаблон
Возвращает
string
onStart ( )

Запускается при старте системы