method public static

RecoveryCodesTable::useCode()

Класс: \Bitrix\Security\Mfa\RecoveryCodesTable

Сигнатура

public static useCode(int $userId, string $searchCode) : bool

Описание

Использует код восстановления для пользователя

Параметры

$userId int

Требуемый идентификатор пользователя.

$searchCode string

Код восстановления в допустимом формате (см. RecoveryCodesTable::CODE_PATTERN).

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

bool

Как применяется в RecoveryCodesTable

RecoveryCodesTable::useCode() — метод класса \Bitrix\Security\Mfa\RecoveryCodesTable модуля «Проактивная защита». Это ORM-сущность D7 (наследник DataManager): строки читаются как объекты EO_RecoveryCodes, наборы — как EO_RecoveryCodes_Collection.

Статический метод — вызывается через имя класса RecoveryCodesTable, без создания объекта.

use Bitrix\Main\Loader;
use Bitrix\Security\Mfa\RecoveryCodesTable;

Loader::includeModule('security');

$userId = 1;
$searchCode = '';
$result = RecoveryCodesTable::useCode($userId, $searchCode);
// $result: bool

Собственные методы RecoveryCodesTable

clearByUser() Очищает все сохранённые коды восстановления для указанного пользователя
regenerateCodes() Генерирует новые коды восстановления для указанного пользователя. Ранее сгенерированные коды будут удалены

Исходный файл: source/security/lib/mfa/recoverycodes.php:157