Changed:
- added missing type-hints - added some missing `@return void`
This commit is contained in:
parent
01632b11c7
commit
241c221e4b
|
@ -35,10 +35,11 @@ class RecoveryCode
|
||||||
* Returns the number of code the provided users can still use to replace a TOTP code
|
* Returns the number of code the provided users can still use to replace a TOTP code
|
||||||
*
|
*
|
||||||
* @param int $uid User ID
|
* @param int $uid User ID
|
||||||
|
*
|
||||||
* @return int
|
* @return int
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
public static function countValidForUser($uid)
|
public static function countValidForUser(int $uid): int
|
||||||
{
|
{
|
||||||
return DBA::count('2fa_recovery_codes', ['uid' => $uid, 'used' => null]);
|
return DBA::count('2fa_recovery_codes', ['uid' => $uid, 'used' => null]);
|
||||||
}
|
}
|
||||||
|
@ -46,12 +47,13 @@ class RecoveryCode
|
||||||
/**
|
/**
|
||||||
* Checks the provided code is available to use for login by the provided user
|
* Checks the provided code is available to use for login by the provided user
|
||||||
*
|
*
|
||||||
* @param int $uid User ID
|
* @param int $uid User ID
|
||||||
* @param string $code
|
* @param string $code
|
||||||
|
*
|
||||||
* @return bool
|
* @return bool
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
public static function existsForUser($uid, $code)
|
public static function existsForUser(int $uid, string $code): bool
|
||||||
{
|
{
|
||||||
return DBA::exists('2fa_recovery_codes', ['uid' => $uid, 'code' => $code, 'used' => null]);
|
return DBA::exists('2fa_recovery_codes', ['uid' => $uid, 'code' => $code, 'used' => null]);
|
||||||
}
|
}
|
||||||
|
@ -60,10 +62,11 @@ class RecoveryCode
|
||||||
* Returns a complete list of all recovery codes for the provided user, including the used status
|
* Returns a complete list of all recovery codes for the provided user, including the used status
|
||||||
*
|
*
|
||||||
* @param int $uid User ID
|
* @param int $uid User ID
|
||||||
|
*
|
||||||
* @return array
|
* @return array
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
public static function getListForUser($uid)
|
public static function getListForUser(int $uid): array
|
||||||
{
|
{
|
||||||
$codesStmt = DBA::select('2fa_recovery_codes', ['code', 'used'], ['uid' => $uid]);
|
$codesStmt = DBA::select('2fa_recovery_codes', ['code', 'used'], ['uid' => $uid]);
|
||||||
|
|
||||||
|
@ -76,10 +79,11 @@ class RecoveryCode
|
||||||
*
|
*
|
||||||
* @param int $uid User ID
|
* @param int $uid User ID
|
||||||
* @param string $code
|
* @param string $code
|
||||||
|
*
|
||||||
* @return bool
|
* @return bool
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
public static function markUsedForUser($uid, $code)
|
public static function markUsedForUser(int $uid, string $code): bool
|
||||||
{
|
{
|
||||||
DBA::update('2fa_recovery_codes', ['used' => DateTimeFormat::utcNow()], ['uid' => $uid, 'code' => $code, 'used' => null]);
|
DBA::update('2fa_recovery_codes', ['used' => DateTimeFormat::utcNow()], ['uid' => $uid, 'code' => $code, 'used' => null]);
|
||||||
|
|
||||||
|
@ -91,9 +95,11 @@ class RecoveryCode
|
||||||
* Generates 12 codes constituted of 2 blocks of 6 characters separated by a dash.
|
* Generates 12 codes constituted of 2 blocks of 6 characters separated by a dash.
|
||||||
*
|
*
|
||||||
* @param int $uid User ID
|
* @param int $uid User ID
|
||||||
|
* @return void
|
||||||
|
*
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
public static function generateForUser($uid)
|
public static function generateForUser(int $uid)
|
||||||
{
|
{
|
||||||
$Random = (new Random())->pattern('[a-z0-9]');
|
$Random = (new Random())->pattern('[a-z0-9]');
|
||||||
|
|
||||||
|
@ -120,9 +126,11 @@ class RecoveryCode
|
||||||
* Deletes all the recovery codes for the provided user.
|
* Deletes all the recovery codes for the provided user.
|
||||||
*
|
*
|
||||||
* @param int $uid User ID
|
* @param int $uid User ID
|
||||||
|
* @return void
|
||||||
|
*
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
public static function deleteForUser($uid)
|
public static function deleteForUser(int $uid)
|
||||||
{
|
{
|
||||||
DBA::delete('2fa_recovery_codes', ['uid' => $uid]);
|
DBA::delete('2fa_recovery_codes', ['uid' => $uid]);
|
||||||
}
|
}
|
||||||
|
@ -131,9 +139,11 @@ class RecoveryCode
|
||||||
* Replaces the existing recovery codes for the provided user by a freshly generated set.
|
* Replaces the existing recovery codes for the provided user by a freshly generated set.
|
||||||
*
|
*
|
||||||
* @param int $uid User ID
|
* @param int $uid User ID
|
||||||
|
* @return void
|
||||||
|
*
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
public static function regenerateForUser($uid)
|
public static function regenerateForUser(int $uid)
|
||||||
{
|
{
|
||||||
self::deleteForUser($uid);
|
self::deleteForUser($uid);
|
||||||
self::generateForUser($uid);
|
self::generateForUser($uid);
|
||||||
|
|
|
@ -143,6 +143,7 @@ class TrustedBrowser
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param int $local_user
|
* @param int $local_user
|
||||||
|
*
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
public function removeAllForUser(int $local_user): bool
|
public function removeAllForUser(int $local_user): bool
|
||||||
|
|
Loading…
Reference in a new issue