\BXmaker\AuthUserPhone\Param

\BXmaker\AuthUserPhone\Param

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

Методы

__construct

public function __construct(string $moduleId, string $siteId);

getAutoFillGroupIds

Вернет массив идентификаторов групп для которых включено автозаполнение номеров телефонов, если массив пуст, то заполнять для всех пользователей

/**
 * @return []
 */
public function getAutoFillGroupIds();

getAutoFillPhoneSourceFields

Вернет массив с вариантами полей в которых может быть телефон, для использования в списке выбора

/**
 * @return []
 */
public function getAutoFillPhoneSourceFields();

getAutoFillPhoneSourceFieldsSelect

Вернет массив с вариантами полей в которых может быть телефон, для использования в списке выбора

/**
 * @return \string[][]
 */
public function getAutoFillPhoneSourceFieldsSelect();

getBotCallCheckIPLimitForBlock

Вернет количество попыток проверить код из номере телефона робота до блокировки

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

getBotCallCheckIPLimitForCaptcha

Вернет количество попыток проверить код из номере телефона робота до показа капчи

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

getBotCallCheckLimitForCaptcha

Вернет количество попыток ввода кода полученного при звонке от робота до капчи

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

getBotCallLength

Вернет длину временного кода для звонка от робота

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

getBotCallLengthSelect

Возвращает массив с вариантами значение длины кода для использования в списке выбора для подтверждения через звонок от робота

/**
 * @return array
 */
public function getBotCallLengthSelect();

getBotCallLengthSelectDefaultValue

Возвращает значение по умолчанию для списка выбора варианта длины кода для использования на странице настроек

/**
 * @return false|mixed
 */
public function getBotCallLengthSelectDefaultValue();

getBotCallLifeTime

Вернет время жизни кода в сек., полученного при запросе звонка от робота

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

getBotCallRequestIPLimitForBlock

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

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

getBotCallRequestIPLimitForCaptcha

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

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

getBotCallRequestLimitForCaptcha

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

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

getBotCallTimeout

Вернет интервал между запросами звонка от робота в сек.

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

getComponentJQueryVersion

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

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

getComponentJQueryVersionSelect

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

/**
 * @return array
 */
public function getComponentJQueryVersionSelect();

getComponentJQueryVersionSelectDefaultValue

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

/**
 * @return false|mixed
 */
public function getComponentJQueryVersionSelectDefaultValue();

getConfirmQueue

Возвращает порядок вариантов подтверждения

/**
 * @return array
 */
public function getConfirmQueue();

getConfirmQueueSelect

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

public function getConfirmQueueSelect();

getConfirmQueueSelectDefaultValue

Возвращает значение по умолчанию для списка выбора варианта порядка подтверждения для использования на странице настроек

/**
 * @return false|mixed
 */
public function getConfirmQueueSelectDefaultValue();

getDefaultComponent

Возвращает название компонента который будет использован по умолчанию вместо стандартной авторизации/регистрации например bxmaker:authuserphone.simple

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

getDefaultComponentSelect

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

/**
 * @return array
 */
public function getDefaultComponentSelect();

getDefaultComponentSelectDefaultValue

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

/**
 * @return array
 */
public function getDefaultComponentSelectDefaultValue();

getIPLimitBlockTime

Вернет количество минут блокировки

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

getMessage

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

/**
 * @param $name
 * @param $arReplace
 * @return string
 */
public function getMessage($name, $arReplace = []);

getMessageNewPass

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

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

getMessagePass

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

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

getMessageTemporaryCode

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

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

getParam

Возвращает значение параметра

/**
 * @param $name
 * @param null $default_value - значение по умолчанию
 * @param null|string $siteId - идентификатор сайта или '' - для параметра без привязки к сайту
 * @return mixed|string|null
 */
public function getParam($name, $default_value = null, $siteId = null);

getPasswordLength

Возвращает минимальную длину пароля

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

getPasswordLengthSelect

Вернет массив с вариантами длины пароля для списка выбора

/**
 * @return array
 */
public function getPasswordLengthSelect();

getPasswordLengthSelectDefaultValue

Возвращает значение по умолчанию для списка выбора варианта длины пароля для использования на странице настроек

/**
 * @return false|mixed
 */
public function getPasswordLengthSelectDefaultValue();

getRequestConsentId

Проверка необходимости запрашивать пользовательское согласие

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

getRequestConsentSelect

Вернет список доступных соглашений, для использования в списке выбора

public function getRequestConsentSelect() : array;

getRestoreEmailCodeLifeTime

Возвращает время жизни временного кода для восстановления по почте

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

getSiteId

Вернет идентификатор сайта, с параметрами которого работает объект класса

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

getSmsCodeCheckIPLimitForBlock

Вернет количество попыток проверить смс код до блокировки

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

getSmsCodeCheckIPLimitForCaptcha

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

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

getSmsCodeCheckLimitForCaptcha

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

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

getSmsCodeLength

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

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

getSmsCodeLengthSelect

Возвращает массив с вариантами значение длины кода для использования в списке выбора

/**
 * @return array
 */
public function getSmsCodeLengthSelect();

getSmsCodeLengthSelectDefaultValue

Возвращает значение по умолчанию для списка выбора варианта длины кода для использования на странице настроек

/**
 * @return false|mixed
 */
public function getSmsCodeLengthSelectDefaultValue();

getSmsCodeLifeTime

Вернет время жизни кода в сек.

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

getSmsCodeRequestIPLimitForBlock

Вернет количество попыток запросить смс код до блокировки

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

getSmsCodeRequestIPLimitForCaptcha

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

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

getSmsCodeRequestLimitForCaptcha

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

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

getSmsCodeTimeout

Вернет интервал между запросами кода в сек.

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

getUserCallCheckIPLimitForBlock

Вернет количество попыток проверить выполненность звонка от пользователя до блокировки

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

getUserCallCheckIPLimitForCaptcha

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

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

getUserCallCheckLimitForCaptcha

Вернет количество попыток ввода кода полученного при звонке от робота до капчи

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

getUserCallLifeTime

Вернет время в течение которого пользователь должен позвонить на роботизированный номер для подтверждения своего номера телефона

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

getUserCallRequestIPLimitForBlock

Вернет количество попыток запросить номер телефона для звонка от пользователя до блокировки

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

getUserCallRequestIPLimitForCaptcha

Вернет количество попыток запросить номер телефона дял звонка от пользователя до показа капчи

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

getUserCallRequestLimitForCaptcha

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

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

getUserCallTimeout

Вернет интервал между запросами телефона на который должен позвонить пользователь для подтверждения своего номера телефона

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

getUserFormatedPhoneFields

Возвращает массив с полями в которые нужно копировать форматированные номера телефонов

/**
 * @return array
 */
public function getUserFormatedPhoneFields();

getUserFormatedPhoneFieldsSelect

Вернет список полей для спсика выбора которые можно выбрать для для автозаполнения

/**
 * @return array
 */
public function getUserFormatedPhoneFieldsSelect();

getUserGroupSelect

Вернет массив вариантов групп пользователей

/**
 * @return array
 */
public function getUserGroupSelect();

getUserPhoneFormat

Вернет идентификатор варианта форматирования

/**
 * @return bool
 */
public function getUserPhoneFormat();

getUserPhoneFormatSelect

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

public function getUserPhoneFormatSelect();

getUserPhoneFormatSelectDefaultValue

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

/**
 * @return false|mixed
 */
public function getUserPhoneFormatSelectDefaultValue();

getUserProfileRequiredFields

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

/**
 * @return array
 */
public function getUserProfileRequiredFields();

getUserProfileRequiredFieldsSelect

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

/**
 * @return array
 */
public function getUserProfileRequiredFieldsSelect();

getUserProfileUrl

Возвращает url адрес для преадресации на страницу заполнения профиля

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

getUserSearchOrder

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

/**
 * @return bool
 */
public function getUserSearchOrder();

getUserSearchOrderSelect

Вернет массив для использвоания в списке выбора с вариантами сортировки при поиске пользователя

/**
 * @return array
 */
public function getUserSearchOrderSelect();

isEnabled

Проверка включен ли модуль для текущего сайта

/**
 * @return bool
 */
public function isEnabled();

isEnabledAuthByEmail

Проверка включена ли возможность авторизации по схема email + пароль

/**
 * @return bool
 */
public function isEnabledAuthByEmail();

isEnabledAuthByLogin

Проверка включена ли возможность авторизации по схема логин + пароль

/**
 * @return bool
 */
public function isEnabledAuthByLogin();

isEnabledAuthByPasswordFirst

Проверка включена ли возможность авторизации по схема логин + пароль

/**
 * @return bool
 */
public function isEnabledAuthByPasswordFirst();

isEnabledAutoFillPhone

Нужно ли подлючать jquery в компонентах модуля

/**
 * @return bool
 */
public function isEnabledAutoFillPhone();

isEnabledAutoRegister

Проверка вклчюен ли режим авторегистрации при входе

/**
 * @return bool
 */
public function isEnabledAutoRegister();

isEnabledBlockDefaultRegisteration

Включена ли блокировка стандартной регистрации

/**
 * @return bool
 */
public function isEnabledBlockDefaultRegisteration();

isEnabledChangePasswordAfterAuthByTemporaryCode

Менять пароль после входя по временному коду

/**
 * @return bool
 */
public function isEnabledChangePasswordAfterAuthByTemporaryCode();

isEnabledChangePhone

Проверка может ли пользователь менять номер телефона

/**
 * @return bool
 */
public function isEnabledChangePhone();

isEnabledCheckCaptchaForResotreByEmail

Проверяет вклчюена ли проверка капчи при попытке восстанволения дступа по email

/**
 * @return bool
 */
public function isEnabledCheckCaptchaForResotreByEmail();

isEnabledCheckUserProfileAfterAuth

Проверка нужно ли проверять заполненость профиля пользователя после авторизации

/**
 * @return bool
 */
public function isEnabledCheckUserProfileAfterAuth();

isEnabledCheckUserProfileAfterRegisteration

Проверка нужно ли проверять заполненность профиля пользователя после регистрации

/**
 * @return bool
 */
public function isEnabledCheckUserProfileAfterRegisteration();

isEnabledComponentJQuery

Нужно ли подлючать jquery в компонентах модуля

/**
 * @return bool
 */
public function isEnabledComponentJQuery();

isEnabledConfirmByBotCall

Вклчюено ли подтверждение по звонку робота

/**
 * @return boolean
 */
public function isEnabledConfirmByBotCall();

isEnabledConfirmBySmsCode

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

/**
 * @return boolean
 */
public function isEnabledConfirmBySmsCode();

isEnabledConfirmByUserCall

Вклчюено ли подтверждение по звонку пользователя

/**
 * @return boolean
 */
public function isEnabledConfirmByUserCall();

isEnabledDebugMode

Включена ли режим отладки

/**
 * @return bool
 */
public function isEnabledDebugMode();

isEnabledDebugTrace

Включен ли вывод трэйса вместе с ошибкой

/**
 * @return bool
 */
public function isEnabledDebugTrace();

isEnabledIPLimit

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

/**
 * @return bool
 */
public function isEnabledIPLimit();

isEnabledRegister

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

/**
 * @return bool
 */
public function isEnabledRegister();

isEnabledRegisterEmail

Проверка нужно ли запрашивать Email при регистрации

/**
 * @return bool
 */
public function isEnabledRegisterEmail();

isEnabledRegisterLogin

Првоерка нужно ли запрашивать логин при регистрации

/**
 * @return bool
 */
public function isEnabledRegisterLogin();

isEnabledRegisterPassword

Проверка нужно ли запрашивать Пароль при регистрации

/**
 * @return bool
 */
public function isEnabledRegisterPassword();

isEnabledReloadAfterAuth

Проверка включена ли перезагрузка страницы после успешной атворизации

/**
 * @return bool
 */
public function isEnabledReloadAfterAuth();

isEnabledRequestConsent

Проверка необходимости запрашивать пользовательское согласие

/**
 * @return bool
 */
public function isEnabledRequestConsent();

isEnabledResotreByEmail

Проверяет вклчюено ли восстановление доступа к сайту по email

/**
 * @return bool
 */
public function isEnabledResotreByEmail();

isEnabledSendPasswordOnRegisteration

Проверка вклчюена ли отправка пароля в смс при регистрации

/**
 * @return bool
 */
public function isEnabledSendPasswordOnRegisteration();

isEnabledSendSmsWithNewPassword

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

/**
 * @return bool
 */
public function isEnabledSendSmsWithNewPassword();

isEnabledSetNumericPassword

Проверка необходимости генерировать пароль только из цифр

/**
 * @return bool
 */
public function isEnabledSetNumericPassword();

isEnabledUniqueEmail

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

/**
 * @return bool
 */
public function isEnabledUniqueEmail();

setParam

Установка парамтеров на время выполнения

/**
 * @param $name
 * @param $value
 * @param null $siteId
 * @return bool
 */
public function setParam($name, $value, $siteId = null);