From e5310aa6999a5a812676028d569ea0780fa04e43 Mon Sep 17 00:00:00 2001 From: Marco Date: Thu, 14 Mar 2024 13:57:50 +0100 Subject: [PATCH] Document methods supposed to throw 'SecondFactorRequiredException' --- src/Auth.php | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/Auth.php b/src/Auth.php index 338d0a9..4e49213 100644 --- a/src/Auth.php +++ b/src/Auth.php @@ -291,6 +291,7 @@ final class Auth extends UserManager { * @throws InvalidPasswordException if the password was invalid * @throws EmailNotVerifiedException if the email address has not been verified yet via confirmation email * @throws AttemptCancelledException if the attempt has been cancelled by the supplied callback that is executed before success + * @throws SecondFactorRequiredException if a second factor needs to be provided for authentification * @throws TooManyRequestsException if the number of allowed attempts/requests has been exceeded * @throws AuthError if an internal problem occurred (do *not* catch) */ @@ -316,6 +317,7 @@ final class Auth extends UserManager { * @throws InvalidPasswordException if the password was invalid * @throws EmailNotVerifiedException if the email address has not been verified yet via confirmation email * @throws AttemptCancelledException if the attempt has been cancelled by the supplied callback that is executed before success + * @throws SecondFactorRequiredException if a second factor needs to be provided for authentification * @throws TooManyRequestsException if the number of allowed attempts/requests has been exceeded * @throws AuthError if an internal problem occurred (do *not* catch) */ @@ -723,6 +725,7 @@ final class Auth extends UserManager { * @throws InvalidSelectorTokenPairException if either the selector or the token was not correct * @throws TokenExpiredException if the token has already expired * @throws UserAlreadyExistsException if an attempt has been made to change the email address to a (now) occupied address + * @throws SecondFactorRequiredException if a second factor needs to be provided for authentification * @throws TooManyRequestsException if the number of allowed attempts/requests has been exceeded * @throws AuthError if an internal problem occurred (do *not* catch) */ @@ -1035,6 +1038,7 @@ final class Auth extends UserManager { * @throws InvalidPasswordException if the password was invalid * @throws EmailNotVerifiedException if the email address has not been verified yet via confirmation email * @throws AttemptCancelledException if the attempt has been cancelled by the supplied callback that is executed before success + * @throws SecondFactorRequiredException if a second factor needs to be provided for authentification * @throws TooManyRequestsException if the number of allowed attempts/requests has been exceeded * @throws AuthError if an internal problem occurred (do *not* catch) */ @@ -1324,6 +1328,7 @@ final class Auth extends UserManager { * @throws TokenExpiredException if the token has already expired * @throws ResetDisabledException if the user has explicitly disabled password resets for their account * @throws InvalidPasswordException if the new password was invalid + * @throws SecondFactorRequiredException if a second factor needs to be provided for authentification * @throws TooManyRequestsException if the number of allowed attempts/requests has been exceeded * @throws AuthError if an internal problem occurred (do *not* catch) *