Fortify
class Fortify
Constants
| PASSWORD_UPDATED |
|
| PROFILE_INFORMATION_UPDATED |
|
| RECOVERY_CODES_GENERATED |
|
| TWO_FACTOR_AUTHENTICATION_CONFIRMED |
|
| TWO_FACTOR_AUTHENTICATION_DISABLED |
|
| TWO_FACTOR_AUTHENTICATION_ENABLED |
|
| VERIFICATION_LINK_SENT |
|
| private DEFAULT_REGISTERS_ROUTES |
|
Methods
Get the username used for authentication.
Get the name of the email address request variable / field.
Register a request-aware redirect resolver.
Register the views for Fortify using conventional names under the given namespace.
Register the views for Fortify using conventional names under the given prefix.
Specify which view should be used as the login view.
Specify which view should be used as the two factor authentication challenge view.
Specify which view should be used as the new password view.
Specify which view should be used as the registration view.
Specify which view should be used as the email verification prompt.
Specify which view should be used as the password confirmation prompt.
Specify which view should be used as the request password reset link view.
Register a callback that is responsible for building the authentication pipeline array.
Register a callback that is responsible for building the authentication pipeline array.
Get the configured authentication pipeline callback.
Register a callback that is responsible for validating incoming authentication credentials.
Get the configured credential authentication callback.
Register a class / callback that should be used to redirect users for two factor authentication.
Register a callback that is responsible for confirming existing user passwords as valid.
Get the configured password confirmation callback.
Register a class / callback that should be used to create new users.
Register a class / callback that should be used to update user profile information.
Register a class / callback that should be used to update user passwords.
Register a class / callback that should be used to reset user passwords.
Register a callback that should be used to generate recovery codes.
Get the configured recovery code generator.
Determine if Fortify is confirming two factor authentication configurations.
Set the encrypter instance that will be used to encrypt attributes.
Get the current encrypter being used by Fortify models.
Get the current authentication guard name.
Get the current stateful authentication guard.
Determine if Fortify routes should be registered.
Configure Fortify to not register its routes.
Flush all static state.
Details
at line 67
static string
username()
Get the username used for authentication.
at line 75
static string
email()
Get the name of the email address request variable / field.
at line 83
static string
redirects(string $redirect, mixed $default = null, Request|null $request = null)
Get a completion redirect path for a specific feature.
at line 105
static void
redirectUsing(string $redirect, callable|null $callback)
Register a request-aware redirect resolver.
The callback persists in static state for the worker lifetime and affects every subsequent response for the named Fortify redirect.
at line 122
static void
viewNamespace(string $namespace)
Register the views for Fortify using conventional names under the given namespace.
The response bindings persist in the container for the worker lifetime and affect every subsequent request.
at line 133
static void
viewPrefix(string $prefix)
Register the views for Fortify using conventional names under the given prefix.
The response bindings persist in the container for the worker lifetime and affect every subsequent request.
at line 150
static void
loginView(callable|string $view)
Specify which view should be used as the login view.
The response binding persists in the container for the worker lifetime and affects every subsequent request.
at line 161
static void
twoFactorChallengeView(callable|string $view)
Specify which view should be used as the two factor authentication challenge view.
The response binding persists in the container for the worker lifetime and affects every subsequent request.
at line 172
static void
resetPasswordView(callable|string $view)
Specify which view should be used as the new password view.
The response binding persists in the container for the worker lifetime and affects every subsequent request.
at line 183
static void
registerView(callable|string $view)
Specify which view should be used as the registration view.
The response binding persists in the container for the worker lifetime and affects every subsequent request.
at line 194
static void
verifyEmailView(callable|string $view)
Specify which view should be used as the email verification prompt.
The response binding persists in the container for the worker lifetime and affects every subsequent request.
at line 205
static void
confirmPasswordView(callable|string $view)
Specify which view should be used as the password confirmation prompt.
The response binding persists in the container for the worker lifetime and affects every subsequent request.
at line 216
static void
requestPasswordResetLinkView(callable|string $view)
Specify which view should be used as the request password reset link view.
The response binding persists in the container for the worker lifetime and affects every subsequent request.
at line 227
static void
loginThrough(callable $callback)
Register a callback that is responsible for building the authentication pipeline array.
The callback persists in static state for the worker lifetime and affects every subsequent login request.
at line 238
static void
authenticateThrough(callable $callback)
Register a callback that is responsible for building the authentication pipeline array.
The callback persists in static state for the worker lifetime and affects every subsequent login request.
at line 247
static Closure|null
authenticateThroughCallback()
Get the configured authentication pipeline callback.
at line 257
static void
authenticateUsing(callable $callback)
Register a callback that is responsible for validating incoming authentication credentials.
The callback persists in static state for the worker lifetime and affects every subsequent login request.
at line 266
static Closure|null
authenticateUsingCallback()
Get the configured credential authentication callback.
at line 276
static void
redirectUserForTwoFactorAuthenticationUsing(callable|string $callback)
Register a class / callback that should be used to redirect users for two factor authentication.
The scoped binding configuration persists for the worker lifetime and affects future requests.
at line 287
static void
confirmPasswordsUsing(callable $callback)
Register a callback that is responsible for confirming existing user passwords as valid.
The callback persists in static state for the worker lifetime and affects every subsequent password confirmation request.
at line 296
static Closure|null
confirmPasswordsUsingCallback()
Get the configured password confirmation callback.
at line 306
static void
createUsersUsing(callable|string $callback)
Register a class / callback that should be used to create new users.
The binding persists in the container for the worker lifetime and affects every subsequent registration request.
at line 317
static void
updateUserProfileInformationUsing(callable|string $callback)
Register a class / callback that should be used to update user profile information.
The binding persists in the container for the worker lifetime and affects every subsequent profile update request.
at line 328
static void
updateUserPasswordsUsing(callable|string $callback)
Register a class / callback that should be used to update user passwords.
The binding persists in the container for the worker lifetime and affects every subsequent password update request.
at line 339
static void
resetUserPasswordsUsing(callable|string $callback)
Register a class / callback that should be used to reset user passwords.
The binding persists in the container for the worker lifetime and affects every subsequent password reset request.
at line 350
static void
generateRecoveryCodesUsing(callable $callback)
Register a callback that should be used to generate recovery codes.
The callback persists in static state for the worker lifetime and affects every subsequent recovery code generation.
at line 359
static Closure|null
recoveryCodeGenerator()
Get the configured recovery code generator.
at line 367
static bool
confirmsTwoFactorAuthentication()
Determine if Fortify is confirming two factor authentication configurations.
at line 377
static Fortify
encryptUsing(Encrypter|null $encrypter)
Set the encrypter instance that will be used to encrypt attributes.
The encrypter persists in static state for the worker lifetime and affects every subsequent encrypted Fortify attribute.
at line 388
static Encrypter
currentEncrypter()
Get the current encrypter being used by Fortify models.
at line 396
static string
guardName()
Get the current authentication guard name.
at line 406
static StatefulGuard
guard()
Get the current stateful authentication guard.
at line 422
static bool
shouldRegisterRoutes()
Determine if Fortify routes should be registered.
at line 432
static Fortify
ignoreRoutes()
Configure Fortify to not register its routes.
The route registration flag persists in static state for the worker lifetime and affects route bootstrapping.
at line 467
static void
flushState()
Flush all static state.