1. trait
  2. Filament
  3. \
  4. Panel
  5. \
  6. Concerns
  7. \
  8. HasAuth

HasAuth

trait HasAuth (View source)

Properties

protected string|Closure $emailVerifiedMiddlewareName
protected string $emailVerificationRouteAction
protected string $emailVerificationPromptRouteSlug
protected string $emailVerificationRouteSlug
protected string $emailVerificationRoutePrefix
protected bool $isEmailVerificationRequired
protected string $loginRouteAction
protected string $loginRouteSlug
protected string $registrationRouteAction
protected string $registrationRouteSlug
protected string $requestPasswordResetRouteAction
protected string $requestPasswordResetRouteSlug
protected string $resetPasswordRouteAction
protected string $resetPasswordRouteSlug
protected string $resetPasswordRoutePrefix
protected string|null $profilePage
protected bool $isProfilePageSimple
protected string $authGuard
protected string|null $authPasswordBroker
protected bool|Closure $arePasswordsRevealable

Methods

HasAuth
emailVerification(string|Closure|array|null $promptAction = EmailVerificationPrompt::class, bool $isRequired = true)

No description

HasAuth
emailVerificationPromptRouteSlug(string $slug)

No description

HasAuth
emailVerificationRouteSlug(string $slug)

No description

HasAuth
emailVerificationRoutePrefix(string $prefix)

No description

HasAuth
emailVerifiedMiddlewareName(string|Closure $name)

No description

HasAuth
requiresEmailVerification(bool $condition = true)

No description

HasAuth
login(string|Closure|array|null $action = Login::class)

No description

HasAuth
loginRouteSlug(string $slug)

No description

HasAuth
passwordReset(string|Closure|array|null $requestAction = RequestPasswordReset::class, string|Closure|array|null $resetAction = ResetPassword::class)

No description

HasAuth
passwordResetRequestRouteSlug(string $slug)

No description

HasAuth
passwordResetRouteSlug(string $slug)

No description

HasAuth
passwordResetRoutePrefix(string $prefix)

No description

HasAuth
registration(string|Closure|array|null $action = Register::class)

No description

HasAuth
registrationRouteSlug(string $slug)

No description

HasAuth
profile(string|null $page = EditProfile::class, bool $isSimple = true)

No description

HasAuth
simpleProfilePage(bool $condition = true)

No description

Guard
auth()

No description

HasAuth
authGuard(string $guard)

No description

HasAuth
authPasswordBroker(string|null $broker = null)

No description

bool
isEmailVerificationRequired()

No description

bool
hasProfile()

No description

string|null
getProfilePage()

No description

bool
isProfilePageSimple()

No description

string|null
getEmailVerificationPromptUrl(array $parameters = [])

No description

string
getEmailVerificationPromptRouteName()

No description

string
getEmailVerifiedMiddleware()

No description

string|null
getLoginUrl(array $parameters = [])

No description

string|null
getRegistrationUrl(array $parameters = [])

No description

string|null
getRequestPasswordResetUrl(array $parameters = [])

No description

string
getVerifyEmailUrl(Authenticatable $user, array $parameters = [])

No description

string
getResetPasswordUrl(string $token, Authenticatable $user, array $parameters = [])

No description

string|null
getProfileUrl(array $parameters = [])

No description

string
getLogoutUrl(array $parameters = [])

No description

string
getEmailVerifiedMiddlewareName()

No description

string|Closure|array|null
getEmailVerificationPromptRouteAction()

No description

string
getEmailVerificationPromptRouteSlug()

No description

string
getEmailVerificationRouteSlug(string $suffix)

No description

string
getEmailVerificationRoutePrefix()

No description

string|Closure|array|null
getLoginRouteAction()

No description

string
getLoginRouteSlug()

No description

string|Closure|array|null
getRegistrationRouteAction()

No description

string
getRegistrationRouteSlug()

No description

string|Closure|array|null
getRequestPasswordResetRouteAction()

No description

string
getRequestPasswordResetRouteSlug()

No description

string|Closure|array|null
getResetPasswordRouteAction()

No description

string
getResetPasswordRouteSlug()

No description

string
getResetPasswordRoutePrefix()

No description

bool
hasEmailVerification()

No description

bool
hasLogin()

No description

bool
hasPasswordReset()

No description

bool
hasRegistration()

No description

string
getAuthGuard()

No description

string|null
getAuthPasswordBroker()

No description

HasAuth
revealablePasswords(bool|Closure $condition = true)

No description

bool
arePasswordsRevealable()

No description

Details

at line 80
HasAuth emailVerification(string|Closure|array|null $promptAction = EmailVerificationPrompt::class, bool $isRequired = true)

No description

Parameters

string|Closure|array|null $promptAction
bool $isRequired

Return Value

HasAuth

at line 88
HasAuth emailVerificationPromptRouteSlug(string $slug)

No description

Parameters

string $slug

Return Value

HasAuth

at line 95
HasAuth emailVerificationRouteSlug(string $slug)

No description

Parameters

string $slug

Return Value

HasAuth

at line 102
HasAuth emailVerificationRoutePrefix(string $prefix)

No description

Parameters

string $prefix

Return Value

HasAuth

at line 109
HasAuth emailVerifiedMiddlewareName(string|Closure $name)

No description

Parameters

string|Closure $name

Return Value

HasAuth

at line 116
HasAuth requiresEmailVerification(bool $condition = true)

No description

Parameters

bool $condition

Return Value

HasAuth

at line 126
HasAuth login(string|Closure|array|null $action = Login::class)

No description

Parameters

string|Closure|array|null $action

Return Value

HasAuth

at line 133
HasAuth loginRouteSlug(string $slug)

No description

Parameters

string $slug

Return Value

HasAuth

at line 144
HasAuth passwordReset(string|Closure|array|null $requestAction = RequestPasswordReset::class, string|Closure|array|null $resetAction = ResetPassword::class)

No description

Parameters

string|Closure|array|null $requestAction
string|Closure|array|null $resetAction

Return Value

HasAuth

at line 152
HasAuth passwordResetRequestRouteSlug(string $slug)

No description

Parameters

string $slug

Return Value

HasAuth

at line 159
HasAuth passwordResetRouteSlug(string $slug)

No description

Parameters

string $slug

Return Value

HasAuth

at line 166
HasAuth passwordResetRoutePrefix(string $prefix)

No description

Parameters

string $prefix

Return Value

HasAuth

at line 176
HasAuth registration(string|Closure|array|null $action = Register::class)

No description

Parameters

string|Closure|array|null $action

Return Value

HasAuth

at line 183
HasAuth registrationRouteSlug(string $slug)

No description

Parameters

string $slug

Return Value

HasAuth

at line 190
HasAuth profile(string|null $page = EditProfile::class, bool $isSimple = true)

No description

Parameters

string|null $page
bool $isSimple

Return Value

HasAuth

at line 198
HasAuth simpleProfilePage(bool $condition = true)

No description

Parameters

bool $condition

Return Value

HasAuth

at line 205
Guard auth()

No description

Return Value

Guard

at line 210
HasAuth authGuard(string $guard)

No description

Parameters

string $guard

Return Value

HasAuth

at line 217
HasAuth authPasswordBroker(string|null $broker = null)

No description

Parameters

string|null $broker

Return Value

HasAuth

at line 224
bool isEmailVerificationRequired()

No description

Return Value

bool

at line 229
bool hasProfile()

No description

Return Value

bool

at line 234
string|null getProfilePage()

No description

Return Value

string|null

at line 239
bool isProfilePageSimple()

No description

Return Value

bool

at line 247
string|null getEmailVerificationPromptUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

at line 256
string getEmailVerificationPromptRouteName()

No description

Return Value

string

at line 261
string getEmailVerifiedMiddleware()

No description

Return Value

string

at line 269
string|null getLoginUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

at line 281
string|null getRegistrationUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

at line 293
string|null getRequestPasswordResetUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

at line 305
string getVerifyEmailUrl(Authenticatable $user, array $parameters = [])

No description

Parameters

Authenticatable $user
array $parameters

Return Value

string

at line 321
string getResetPasswordUrl(string $token, Authenticatable $user, array $parameters = [])

No description

Parameters

string $token
Authenticatable $user
array $parameters

Return Value

string

at line 336
string|null getProfileUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

at line 348
string getLogoutUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string

at line 353
string getEmailVerifiedMiddlewareName()

No description

Return Value

string

at line 361
string|Closure|array|null getEmailVerificationPromptRouteAction()

No description

Return Value

string|Closure|array|null

| Closure | array<class-string, string> | null

at line 366
string getEmailVerificationPromptRouteSlug()

No description

Return Value

string

at line 371
string getEmailVerificationRouteSlug(string $suffix)

No description

Parameters

string $suffix

Return Value

string

at line 376
string getEmailVerificationRoutePrefix()

No description

Return Value

string

at line 384
string|Closure|array|null getLoginRouteAction()

No description

Return Value

string|Closure|array|null

| Closure | array<class-string, string> | null

at line 389
string getLoginRouteSlug()

No description

Return Value

string

at line 397
string|Closure|array|null getRegistrationRouteAction()

No description

Return Value

string|Closure|array|null

| Closure | array<class-string, string> | null

at line 402
string getRegistrationRouteSlug()

No description

Return Value

string

at line 410
string|Closure|array|null getRequestPasswordResetRouteAction()

No description

Return Value

string|Closure|array|null

| Closure | array<class-string, string> | null

at line 415
string getRequestPasswordResetRouteSlug()

No description

Return Value

string

at line 423
string|Closure|array|null getResetPasswordRouteAction()

No description

Return Value

string|Closure|array|null

| Closure | array<class-string, string> | null

at line 428
string getResetPasswordRouteSlug()

No description

Return Value

string

at line 433
string getResetPasswordRoutePrefix()

No description

Return Value

string

at line 438
bool hasEmailVerification()

No description

Return Value

bool

at line 443
bool hasLogin()

No description

Return Value

bool

at line 448
bool hasPasswordReset()

No description

Return Value

bool

at line 453
bool hasRegistration()

No description

Return Value

bool

at line 458
string getAuthGuard()

No description

Return Value

string

at line 463
string|null getAuthPasswordBroker()

No description

Return Value

string|null

at line 468
HasAuth revealablePasswords(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasAuth

at line 475
bool arePasswordsRevealable()

No description

Return Value

bool