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

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

Абстрактный класс провайдера доставки проверочного кода для верификации. Например, SMS или Email

Открытые члены
	setVerificationSession (VerificationSession $session)

	getVerificationSession ($throw_exception_if_not_set=true)

	send (&$code)

	canSelectForPhoneVerification ()

	getRecipientText ()

	getReSendCodeText ()

Открытые статические члены
static	getTitle ()

static	getId ()

Методы

canSelectForPhoneVerification ( )

abstract

Возвращает true, если данный провайдер подходит для верификации через номер телефона

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

static getId ( )

staticabstract

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

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

getRecipientText ( )

abstract

Возвращает текст с информацией о том, куда отправлен код Предварительно должен быть установлен объект верификационной сессии

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

getReSendCodeText ( )

Возвращает текст о том, через сколько можно будет повторить попытку получение кода. По умолчанию это: "Отправить новый код можно через" далее будет всегда добавлено XX сек.

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

static getTitle ( )

staticabstract

Возвращает название

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

getVerificationSession ( $throw_exception_if_not_set = true )

Возвращает объект верификационной сессии

Аргументы

bool $throw_exception_if_not_set Если true, то будет брошено исключение, если верификационная сессия не установлена

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

Исключения

Exception

send ( & $code )

abstract

Доставляет код к пользователю. Предварительно должен быть установлен объект верификационной сессии.

Внутри метода, $code может быть изменен, что открывает возможность для подключения сервисов вроде CallPassword, которые генерируют код, только после запроса к этим сервисам.

Аргументы

string $code Код верификации

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

Исключения

Exception Бросает исключение в случае ошибки

setVerificationSession ( VerificationSession $session )

Устанавливает объект верификационной сессии, с которой будут работать остальные методы

Аргументы

VerificationSession $session

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

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

Открытые статические члены

Методы