\BXmaker\AuthUserPhone\Manager\Limit
\BXmaker\AuthUserPhone\Manager\Limit - Класс для работы с лимитами привязанными к телефону пользователя
namespace BXmaker\AuthUserPhone\Manager;
class Limit
{
//...
}
Методы
__construct
public function __construct();
checkCanDoCheck
Проверка можем ли продолжить проверку полученных код из смс, кода из звонка от робота и тп
/**
* @return $this
* @throws \BXmaker\AuthUserPhone\Exception\LimitException
* @throws \BXmaker\AuthUserPhone\Exception\NeedCaptchaException
*/
public function checkCanDoCheck();
checkCanDoRequest
Проверка можно ли продолжить делать отправку смс кода, звонка от робота и тп
/**
* @return $this
* @throws \BXmaker\AuthUserPhone\Exception\LimitException
* @throws \BXmaker\AuthUserPhone\Exception\NeedCaptchaException
*/
public function checkCanDoRequest();
clear
Удаление истории попыток
/**
* @return $this
* @throws \Exception
*/
public function clear();
getMessage
Вернет языкозависимое сообщение
/**
* @param $name
* @param array|null $arReplace
* @return string
*/
public function getMessage($name, $arReplace = null);
getPhone
Возвращает текущий номер телефона
/**
* @return string|null
*/
public function getPhone();
getRow
/**
* @return array|null
* @throws \Bitrix\Main\ArgumentException
* @throws \Bitrix\Main\ObjectPropertyException
* @throws \Bitrix\Main\SystemException
*/
public function getRow();
getType
Вернет тип подтверждения с которым работаем
/**
* @return string
*/
public function getType();
isNeedCaptchaForCheck
Проверяем нужно ли запрашивать капчу перед началом проверки кода из смс, кода от робота или выполненности звонка от пользователя
/**
* @return bool
*/
public function isNeedCaptchaForCheck();
isNeedCaptchaForRequest
Проверяем нужно ли запрашивать капчу перед началом проверки номера
/**
* @return bool
*/
public function isNeedCaptchaForRequest();
manager
/**
* @return \BXmaker\AuthUserPhone\Manager
*/
public function manager();
setCheck
Отмечаем попытку проверки номера телефона
/**
* @return $this
* @throws \Bitrix\Main\ArgumentException
* @throws \Bitrix\Main\ObjectPropertyException
* @throws \Bitrix\Main\SystemException
*/
public function setCheck();
setPhone
Устанавливает номер телефона с которым работаем
/**
* @param $phone
* @return $this
*/
public function setPhone($phone);
setRequest
Отмечаем попытку начать проверку номера телефона
/**
* @return $this
* @throws \Bitrix\Main\ArgumentException
* @throws \Bitrix\Main\ObjectPropertyException
* @throws \Bitrix\Main\SystemException
*/
public function setRequest();
setType
Установит тип подтверждения с которым работаем
/**
* @param $type - \BXmaker\AuthUserPhone\Manager::CONFIRM_TYPE_USER_CALL, \BXmaker\AuthUserPhone\Manager::CONFIRM_TYPE_BOT_CALL, \BXmaker\AuthUserPhone\Manager::CONFIRM_TYPE_SMS_CODE
* @return $this
*/
public function setType($type);
table
/**
* @return \BXmaker\AuthUserPhone\Manager\LimitTable
*/
public function table();