- added missing type-hints
- added some missing `@return void`
This commit is contained in:
Roland Häder 2022-09-12 03:54:36 +02:00
parent 01632b11c7
commit 241c221e4b
Signed by: roland
GPG key ID: C82EDE5DDFA0BA77
2 changed files with 19 additions and 8 deletions

View file

@ -35,10 +35,11 @@ class RecoveryCode
* Returns the number of code the provided users can still use to replace a TOTP code
*
* @param int $uid User ID
*
* @return int
* @throws \Exception
*/
public static function countValidForUser($uid)
public static function countValidForUser(int $uid): int
{
return DBA::count('2fa_recovery_codes', ['uid' => $uid, 'used' => null]);
}
@ -48,10 +49,11 @@ class RecoveryCode
*
* @param int $uid User ID
* @param string $code
*
* @return bool
* @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]);
}
@ -60,10 +62,11 @@ class RecoveryCode
* Returns a complete list of all recovery codes for the provided user, including the used status
*
* @param int $uid User ID
*
* @return array
* @throws \Exception
*/
public static function getListForUser($uid)
public static function getListForUser(int $uid): array
{
$codesStmt = DBA::select('2fa_recovery_codes', ['code', 'used'], ['uid' => $uid]);
@ -76,10 +79,11 @@ class RecoveryCode
*
* @param int $uid User ID
* @param string $code
*
* @return bool
* @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]);
@ -91,9 +95,11 @@ class RecoveryCode
* Generates 12 codes constituted of 2 blocks of 6 characters separated by a dash.
*
* @param int $uid User ID
* @return void
*
* @throws \Exception
*/
public static function generateForUser($uid)
public static function generateForUser(int $uid)
{
$Random = (new Random())->pattern('[a-z0-9]');
@ -120,9 +126,11 @@ class RecoveryCode
* Deletes all the recovery codes for the provided user.
*
* @param int $uid User ID
* @return void
*
* @throws \Exception
*/
public static function deleteForUser($uid)
public static function deleteForUser(int $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.
*
* @param int $uid User ID
* @return void
*
* @throws \Exception
*/
public static function regenerateForUser($uid)
public static function regenerateForUser(int $uid)
{
self::deleteForUser($uid);
self::generateForUser($uid);

View file

@ -143,6 +143,7 @@ class TrustedBrowser
/**
* @param int $local_user
*
* @return bool
*/
public function removeAllForUser(int $local_user): bool