Граф наследования:RSDefault:

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

Базовая капча ReadyScript Картинка с цифрами и поле для ввода

Открытые члены
	getShortName ()

	getTitle ()

	getFieldTitle ()

	getView ($name, $context=null, $attributes=[], $view_options=null, $template=null)

	check ($data, $context=null)

	errorText ()

	actionImage ()

	actionDefault ()

Открытые члены унаследованные от AbstractCaptcha
	getShortName ()

	getTitle ()

	getFieldTitle ()

	getView ($name, $context=null, $attributes=[], $view_options=null, $template=null)

	check ($data, $context=null)

	errorText ()

	actionDefault ()

	onStart ()

Поля данных
const	SESSION_VAR = 'kaptcha_keystring-'

const	SESSION_CHECKCOUNT_VAR = 'kaptcha_keystring_checkcount-'

const	DEFAULT_TEMPLATE = '%kaptcha%form/rs_default.tpl'

const	CHECK_LIMIT = 5

Защищенные члены
	getKeyString ($context=null)

	setKeyString ($str, $context=null)

	getSessionVarKey ($context=null, $type=self::SESSION_VAR)

Защищенные члены унаследованные от AbstractCaptcha
	getReadyAttributes ($attributes=null)

Методы

actionDefault ( )

Действие по умолчанию вызывает генерацию картинки (для совместимости)

actionImage ( )

Генерирует картинку капчи

check	(	$data,
		$context = `null`
	)

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

Аргументы

mixed	$data	- данные для проверки
string	$context	- контекст капчи

Возвращает: bool

errorText ( )

Возвращает текст ошибки

Возвращает: string

getFieldTitle ( )

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

Возвращает: string

getKeyString ( $context = null )

protected

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

Аргументы

string $context - контекст капчи

Возвращает: string

getSessionVarKey	(	$context = `null`,
		$type = `self::SESSION_VAR`
	)

protected

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

Аргументы

string	$context	- контекст капчи
bool	$type	- имя ключа

getShortName ( )

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

Возвращает: string

getTitle ( )

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

Возвращает: string

getView	(	$name,
		$context = `null`,
		$attributes = `[]`,
		$view_options = `null`,
		$template = `null`
	)

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

Аргументы

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

Возвращает: string

setKeyString	(	$str,
		$context = `null`
	)

protected

Устанавливает код проверки капчи в сессию

Аргументы

string	$str	- код проверки
string	$context	- контекст капчи

Поля

const CHECK_LIMIT = 5

const DEFAULT_TEMPLATE = '%kaptcha%form/rs_default.tpl'

const SESSION_CHECKCOUNT_VAR = 'kaptcha_keystring_checkcount-'

const SESSION_VAR = 'kaptcha_keystring-'

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

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

Поля данных

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

Методы

Поля