Авторизация по номеру телефона
\BXmaker\AuthUserPhone\Param
namespace BXmaker\AuthUserPhone;
class Param
{
//...
}
public function __construct(string $moduleId, string $siteId);
Вернет массив идентификаторов групп для которых включено автозаполнение номеров телефонов, если массив пуст, то заполнять для всех пользователей
/**
* @return []
*/
public function getAutoFillGroupIds();
Вернет массив с вариантами полей в которых может быть телефон, для использования в списке выбора
/**
* @return []
*/
public function getAutoFillPhoneSourceFields();
Вернет массив с вариантами полей в которых может быть телефон, для использования в списке выбора
/**
* @return \string[][]
*/
public function getAutoFillPhoneSourceFieldsSelect();
Вернет количество попыток проверить код из номере телефона робота до блокировки
/**
* @return int
*/
public function getBotCallCheckIPLimitForBlock();
Вернет количество попыток проверить код из номере телефона робота до показа капчи
/**
* @return int
*/
public function getBotCallCheckIPLimitForCaptcha();
Вернет количество попыток ввода кода полученного при звонке от робота до капчи
/**
* @return int
*/
public function getBotCallCheckLimitForCaptcha();
Вернет длину временного кода для звонка от робота
/**
* @return int
*/
public function getBotCallLength();
Возвращает массив с вариантами значение длины кода для использования в списке выбора для подтверждения через звонок от робота
/**
* @return array
*/
public function getBotCallLengthSelect();
Возвращает значение по умолчанию для списка выбора варианта длины кода для использования на странице настроек
/**
* @return false|mixed
*/
public function getBotCallLengthSelectDefaultValue();
Вернет время жизни кода в сек., полученного при запросе звонка от робота
/**
* @return int
*/
public function getBotCallLifeTime();
Вернет количество попыток запросить звонок от робота до блокировки
/**
* @return int
*/
public function getBotCallRequestIPLimitForBlock();
Вернет количество попыток запросить звонок от робота до показа капчи
/**
* @return int
*/
public function getBotCallRequestIPLimitForCaptcha();
Вернет количество попыток запроса звонка от бота до капчи
/**
* @return int
*/
public function getBotCallRequestLimitForCaptcha();
Вернет интервал между запросами звонка от робота в сек.
/**
* @return int
*/
public function getBotCallTimeout();
Вернет версию jquery для подключения
/**
* @return int
*/
public function getComponentJQueryVersion();
Вернет массив вариантов форматирования телефона для использования в выводимом списке
/**
* @return array
*/
public function getComponentJQueryVersionSelect();
Вернет подключаемую версию jquery по умолчанию для страницы параметров
/**
* @return false|mixed
*/
public function getComponentJQueryVersionSelectDefaultValue();
Возвращает порядок вариантов подтверждения
/**
* @return array
*/
public function getConfirmQueue();
Возвращает массив вариантов порядка подтверждения для списка выбора
public function getConfirmQueueSelect();
Возвращает значение по умолчанию для списка выбора варианта порядка подтверждения для использования на странице настроек
/**
* @return false|mixed
*/
public function getConfirmQueueSelectDefaultValue();
Возвращает название компонента который будет использован по умолчанию вместо стандартной авторизации/регистрации например bxmaker:authuserphone.simple
/**
* @return string
*/
public function getDefaultComponent();
Возвращает массив с вариантами компонента по умолчанию для использования в SelectBoxFromArray
/**
* @return array
*/
public function getDefaultComponentSelect();
Возвращает значение по умолчанию для списка вариантов компонента по умолчанию для страницы настроек
/**
* @return array
*/
public function getDefaultComponentSelectDefaultValue();
Вернет количество минут блокировки
/**
* @return int
*/
public function getIPLimitBlockTime();
Вернет языкозависимое сообщение
/**
* @param $name
* @param $arReplace
* @return string
*/
public function getMessage($name, $arReplace = []);
Возвращает текс сообщения с новым паролем
/**
* @return string
*/
public function getMessageNewPass();
Возвращает текс сообщения с паролем
/**
* @return string
*/
public function getMessagePass();
Возвращает текс сообщения с временным кодом
/**
* @return string
*/
public function getMessageTemporaryCode();
Возвращает значение параметра
/**
* @param $name
* @param null $default_value - значение по умолчанию
* @param null|string $siteId - идентификатор сайта или '' - для параметра без привязки к сайту
* @return mixed|string|null
*/
public function getParam($name, $default_value = null, $siteId = null);
Возвращает минимальную длину пароля
/**
* @return int
*/
public function getPasswordLength();
Вернет массив с вариантами длины пароля для списка выбора
/**
* @return array
*/
public function getPasswordLengthSelect();
Возвращает значение по умолчанию для списка выбора варианта длины пароля для использования на странице настроек
/**
* @return false|mixed
*/
public function getPasswordLengthSelectDefaultValue();
Проверка необходимости запрашивать пользовательское согласие
/**
* @return int
*/
public function getRequestConsentId();
Вернет список доступных соглашений, для использования в списке выбора
public function getRequestConsentSelect() : array;
Возвращает время жизни временного кода для восстановления по почте
/**
* @return int
*/
public function getRestoreEmailCodeLifeTime();
Вернет идентификатор сайта, с параметрами которого работает объект класса
/**
* @return string
*/
public function getSiteId();
Вернет количество попыток проверить смс код до блокировки
/**
* @return int
*/
public function getSmsCodeCheckIPLimitForBlock();
Вернет количество попыток проверить смс код до показа капчи
/**
* @return int
*/
public function getSmsCodeCheckIPLimitForCaptcha();
Вернет количество попыток ввода смс кода до капчи
/**
* @return int
*/
public function getSmsCodeCheckLimitForCaptcha();
Вернет длину временного кода
/**
* @return int
*/
public function getSmsCodeLength();
Возвращает массив с вариантами значение длины кода для использования в списке выбора
/**
* @return array
*/
public function getSmsCodeLengthSelect();
Возвращает значение по умолчанию для списка выбора варианта длины кода для использования на странице настроек
/**
* @return false|mixed
*/
public function getSmsCodeLengthSelectDefaultValue();
Вернет время жизни кода в сек.
/**
* @return int
*/
public function getSmsCodeLifeTime();
Вернет количество попыток запросить смс код до блокировки
/**
* @return int
*/
public function getSmsCodeRequestIPLimitForBlock();
Вернет количество попыток запросить смс код до показа капчи
/**
* @return int
*/
public function getSmsCodeRequestIPLimitForCaptcha();
Вернет количество попыток запроса смс кода до капчи
/**
* @return int
*/
public function getSmsCodeRequestLimitForCaptcha();
Вернет интервал между запросами кода в сек.
/**
* @return int
*/
public function getSmsCodeTimeout();
Вернет количество попыток проверить выполненность звонка от пользователя до блокировки
/**
* @return int
*/
public function getUserCallCheckIPLimitForBlock();
Вернет количество попыток проверить выполненность звонка от пользователя до показа капчи
/**
* @return int
*/
public function getUserCallCheckIPLimitForCaptcha();
Вернет количество попыток ввода кода полученного при звонке от робота до капчи
/**
* @return int
*/
public function getUserCallCheckLimitForCaptcha();
Вернет время в течение которого пользователь должен позвонить на роботизированный номер для подтверждения своего номера телефона
/**
* @return int
*/
public function getUserCallLifeTime();
Вернет количество попыток запросить номер телефона для звонка от пользователя до блокировки
/**
* @return int
*/
public function getUserCallRequestIPLimitForBlock();
Вернет количество попыток запросить номер телефона дял звонка от пользователя до показа капчи
/**
* @return int
*/
public function getUserCallRequestIPLimitForCaptcha();
Вернет количество попыток запроса звонка от бота до капчи
/**
* @return int
*/
public function getUserCallRequestLimitForCaptcha();
Вернет интервал между запросами телефона на который должен позвонить пользователь для подтверждения своего номера телефона
/**
* @return int
*/
public function getUserCallTimeout();
Возвращает массив с полями в которые нужно копировать форматированные номера телефонов
/**
* @return array
*/
public function getUserFormatedPhoneFields();
Вернет список полей для спсика выбора которые можно выбрать для для автозаполнения
/**
* @return array
*/
public function getUserFormatedPhoneFieldsSelect();
Вернет массив вариантов групп пользователей
/**
* @return array
*/
public function getUserGroupSelect();
Вернет идентификатор варианта форматирования
/**
* @return bool
*/
public function getUserPhoneFormat();
Вернет массив вариантов форматирвоания телефона дял использования в выводимом списке
public function getUserPhoneFormatSelect();
Вернет значение по умолчанию для страницы паратмеров для спсика вараитов форматирования номера телефона
/**
* @return false|mixed
*/
public function getUserPhoneFormatSelectDefaultValue();
Возвращает список полей профиля пользователя которые необходимо проверять на заполненность
/**
* @return array
*/
public function getUserProfileRequiredFields();
Возвращает список полей профиля пользователя, которые можно выбрать как обязательные для проверки заоплнености для вывода в списке выбора
/**
* @return array
*/
public function getUserProfileRequiredFieldsSelect();
Возвращает url адрес для преадресации на страницу заполнения профиля
/**
* @return string
*/
public function getUserProfileUrl();
Вернет направление сортировки при посике польвзовтеля
/**
* @return bool
*/
public function getUserSearchOrder();
Вернет массив для использвоания в списке выбора с вариантами сортировки при поиске пользователя
/**
* @return array
*/
public function getUserSearchOrderSelect();
Проверка включен ли модуль для текущего сайта
/**
* @return bool
*/
public function isEnabled();
Проверка включена ли возможность авторизации по схема email + пароль
/**
* @return bool
*/
public function isEnabledAuthByEmail();
Проверка включена ли возможность авторизации по схема логин + пароль
/**
* @return bool
*/
public function isEnabledAuthByLogin();
Проверка включена ли возможность авторизации по схема логин + пароль
/**
* @return bool
*/
public function isEnabledAuthByPasswordFirst();
Нужно ли подлючать jquery в компонентах модуля
/**
* @return bool
*/
public function isEnabledAutoFillPhone();
Проверка вклчюен ли режим авторегистрации при входе
/**
* @return bool
*/
public function isEnabledAutoRegister();
Включена ли блокировка стандартной регистрации
/**
* @return bool
*/
public function isEnabledBlockDefaultRegisteration();
Менять пароль после входя по временному коду
/**
* @return bool
*/
public function isEnabledChangePasswordAfterAuthByTemporaryCode();
Проверка может ли пользователь менять номер телефона
/**
* @return bool
*/
public function isEnabledChangePhone();
Проверяет вклчюена ли проверка капчи при попытке восстанволения дступа по email
/**
* @return bool
*/
public function isEnabledCheckCaptchaForResotreByEmail();
Проверка нужно ли проверять заполненость профиля пользователя после авторизации
/**
* @return bool
*/
public function isEnabledCheckUserProfileAfterAuth();
Проверка нужно ли проверять заполненность профиля пользователя после регистрации
/**
* @return bool
*/
public function isEnabledCheckUserProfileAfterRegisteration();
Нужно ли подлючать jquery в компонентах модуля
/**
* @return bool
*/
public function isEnabledComponentJQuery();
Вклчюено ли подтверждение по звонку робота
/**
* @return boolean
*/
public function isEnabledConfirmByBotCall();
Вклчюено ли подтверждение по коду из смс
/**
* @return boolean
*/
public function isEnabledConfirmBySmsCode();
Вклчюено ли подтверждение по звонку пользователя
/**
* @return boolean
*/
public function isEnabledConfirmByUserCall();
Включена ли режим отладки
/**
* @return bool
*/
public function isEnabledDebugMode();
Включен ли вывод трэйса вместе с ошибкой
/**
* @return bool
*/
public function isEnabledDebugTrace();
Проверка включено ли лимитирование по IP адерсу
/**
* @return bool
*/
public function isEnabledIPLimit();
Проверка включена ли регистрация пользователей
/**
* @return bool
*/
public function isEnabledRegister();
Проверка нужно ли запрашивать Email при регистрации
/**
* @return bool
*/
public function isEnabledRegisterEmail();
Првоерка нужно ли запрашивать логин при регистрации
/**
* @return bool
*/
public function isEnabledRegisterLogin();
Проверка нужно ли запрашивать Пароль при регистрации
/**
* @return bool
*/
public function isEnabledRegisterPassword();
Проверка включена ли перезагрузка страницы после успешной атворизации
/**
* @return bool
*/
public function isEnabledReloadAfterAuth();
Проверка необходимости запрашивать пользовательское согласие
/**
* @return bool
*/
public function isEnabledRequestConsent();
Проверяет вклчюено ли восстановление доступа к сайту по email
/**
* @return bool
*/
public function isEnabledResotreByEmail();
Проверка вклчюена ли отправка пароля в смс при регистрации
/**
* @return bool
*/
public function isEnabledSendPasswordOnRegisteration();
Проверка включена ли отправка смс при установке нового пароля
/**
* @return bool
*/
public function isEnabledSendSmsWithNewPassword();
Проверка необходимости генерировать пароль только из цифр
/**
* @return bool
*/
public function isEnabledSetNumericPassword();
Включено ли проверка email адреса на уникальность
/**
* @return bool
*/
public function isEnabledUniqueEmail();
Установка парамтеров на время выполнения
/**
* @param $name
* @param $value
* @param null $siteId
* @return bool
*/
public function setParam($name, $value, $siteId = null);