\BXmaker\AuthUserPhone\Captcha

\BXmaker\AuthUserPhone\Captcha - Класс для работы с капчей

namespace BXmaker\AuthUserPhone;
class Captcha
{
    //...
}

Методы

__construct

public function __construct();

checkOnRequest

Проверит присутствие данных капчи в запросе и сверит введенный код с ожидаемым в случае ошибки выбросит исключение

/**
 * @throws \BXmaker\AuthUserPhone\Exception\NeedCaptchaException
 */
public function checkOnRequest();

clear

Удалить капчу если больше не нужна и если есть идентификатор

/**
 * @return void
 */
public function clear();

createId

Создание новой капчи

/**
 * @return $this
 */
public function createId();

delete

public function delete($id);

getForJs

Вернет массив с описанием капчи для передачи на клиентскую сторону

/**
 * @return array {captchaSid : string, captchaSrc : string, captchaLength: int}
 */
public function getForJs();

getId

Вернет идентификатор созданной капчи

/**
 * @return string
 */
public function getId();

getImageSrc

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

/**
 * @param $captchaId - по умолчанию последняя созданная
 * @return string
 */
public function getImageSrc($captchaId = null);

getLength

Вернет длину кода

/**
 * @return int
 */
public function getLength();

getMessage

Вернет языкозависимое сообщение

/**
 * @param $name
 * @param array|null $arReplace
 * @return string
 */
public function getMessage($name, $arReplace = null);

isValid

Проверка валидности введенных символов с картинки

/**
 * @param $id - идентификатор капчи, sid
 * @param $code - символы с картинки
 * @return bool
 */
public function isValid($id, $code);