1. Documentation
  2. API
  3. Library
  4. Auth
  5. Concerns
  6. HasGuard

October\Rain\Auth\Concerns\HasGuard

Overview

HasGuard defines all methods to satisfy the Laravel contract

Public Methods

public check()

public check(): bool

check to see if the user is logged in and activated, and hasn't been banned or suspended.

public guest()

public guest(): bool

guest determines if the current user is a guest.

public hasUser()

public hasUser(): bool

hasUser determines if the guard has a user instance.

public id()

public id(): int|null

id for the currently authenticated user.

public setUser()

public setUser($user): void

setUser will set the current user.

public user()

public user(): Illuminate\Contracts\Auth\Authenticatable|null

user will return the currently authenticated user.

public validate()

public validate($credentials = []): bool

validate a user's credentials.