Класс RecoveryCodesTable

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

Открытые статические члены
static	getTableName ()
static	getMap ()
static	clearByUser ($userId)
static	regenerateCodes ($userId)
static	useCode ($userId, $searchCode)

Открытые атрибуты
const	CODES_PER_USER = 10
const	CODE_PATTERN = '#^[a-z0-9]{4}-[a-z0-9]{4}$#D'

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

Class RecoveryCodesTable

DO NOT WRITE ANYTHING BELOW THIS

<<< ORMENTITYANNOTATION @method static EO_RecoveryCodes_Query query() @method static EO_RecoveryCodes_Result getByPrimary($primary, array $parameters = []) @method static EO_RecoveryCodes_Result getById($id) @method static EO_RecoveryCodes_Result getList(array $parameters = []) @method static EO_RecoveryCodes_Entity getEntity() @method static \Bitrix\Security\Mfa\EO_RecoveryCodes createObject($setDefaultValues = true) @method static \Bitrix\Security\Mfa\EO_RecoveryCodes_Collection createCollection() @method static \Bitrix\Security\Mfa\EO_RecoveryCodes wakeUpObject($row) @method static \Bitrix\Security\Mfa\EO_RecoveryCodes_Collection wakeUpCollection($rows)

См. определение в файле recoverycodes.php строка 39

Методы

clearByUser()

static clearByUser ( $userId )

static

Clear all saved recovery codes for provided user

Аргументы

int

$userId

Needed user id.

Возвращает

bool Returns true if successful

Исключения

ArgumentTypeException

Bitrix\Main\ArgumentException

См. определение в файле recoverycodes.php строка 97

getMap()

static getMap ( )

static

{}

Возвращает

array

См. определение в файле recoverycodes.php строка 60

getTableName()

static getTableName ( )

static

{}

Возвращает

string

См. определение в файле recoverycodes.php строка 50

regenerateCodes()

static regenerateCodes ( $userId )

static

Generate new recovery codes for provided user Previously generated codes will be removed

Аргументы

int

$userId

Needed user id.

Возвращает

bool Returns true if successful

Исключения

ArgumentTypeException

См. определение в файле recoverycodes.php строка 124

useCode()

static useCode ( $userId, $searchCode )

static

Use recovery code for user

Аргументы

int	$userId	Needed user id.
string	$searchCode	Recovery code in accepted format (see RecoveryCodesTable::CODE_PATTERN).

Возвращает

bool Returns true if successful

Исключения

ArgumentTypeException

Bitrix\Main\ArgumentException

См. определение в файле recoverycodes.php строка 157

Данные класса

CODE_PATTERN

const CODE_PATTERN = '#^[a-z0-9]{4}-[a-z0-9]{4}$#D'

См. определение в файле recoverycodes.php строка 43

CODES_PER_USER

const CODES_PER_USER = 10

См. определение в файле recoverycodes.php строка 42