1. class
  2. Illuminate
  3. \
  4. Support
  5. \
  6. Facades
  7. \
  8. Auth

Auth

class Auth extends Facade (View source)

Properties

static protected Application $app

The application instance being facaded.

 from  Facade
static protected array $resolvedInstance

The resolved object instances.

 from  Facade
static protected bool $cached

Indicates if the resolved instance should be cached.

 from  Facade

Methods

static void
resolved(Closure $callback)

Run a Closure when the facade has been resolved.

from  Facade
static MockInterface
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static Expectation
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static Expectation
expects()

Initiate a mock expectation on the facade.

from  Facade
static MockInterface
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static MockInterface
createMock()

Create a fresh mock instance for the given class.

from  Facade
static bool
isMock()

Determines whether a mock is set as the instance of the facade.

from  Facade
static string|null
getMockableClass()

Get the mockable class for the bound instance.

from  Facade
static void
swap(mixed $instance)

Hotswap the underlying instance behind the facade.

from  Facade
static bool
isFake()

Determines whether a "fake" has been set as the facade instance.

from  Facade
static mixed
getFacadeRoot()

Get the root object behind the facade.

from  Facade
static string
getFacadeAccessor()

Get the registered name of the component.

static mixed
resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

from  Facade
static void
clearResolvedInstance(string $name)

Clear a resolved facade instance.

from  Facade
static void
clearResolvedInstances()

Clear all of the resolved instances.

from  Facade
static Collection
defaultAliases()

Get the application default aliases.

from  Facade
static Application
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Application $app)

Set the application instance.

from  Facade
static mixed
__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from  Facade
static void
routes(array $options = [])

Register the typical authentication routes for an application.

static StatefulGuard
guard(string|null $name = null)

No description

static SessionGuard
createSessionDriver(string $name, array $config)

No description

static TokenGuard
createTokenDriver(string $name, array $config)

No description

static string
getDefaultDriver()

No description

static void
shouldUse(string $name)

No description

static void
setDefaultDriver(string $name)

No description

static AuthManager
viaRequest(string $driver, callable $callback)

No description

static Closure
userResolver()

No description

static AuthManager
resolveUsersUsing(Closure $userResolver)

No description

static AuthManager
extend(string $driver, Closure $callback)

No description

static AuthManager
provider(string $name, Closure $callback)

No description

static bool
hasResolvedGuards()

No description

static AuthManager
forgetGuards()

No description

static AuthManager
setApplication(Application $app)

No description

static UserProvider|null
createUserProvider(string|null $provider = null)

No description

static string
getDefaultUserProvider()

No description

static bool
check()

No description

static bool
guest()

No description

static Authenticatable|null
user()

No description

static int|string|null
id()

No description

static bool
validate(array $credentials = [])

No description

static bool
hasUser()

No description

static void
setUser(Authenticatable $user)

No description

static bool
attempt(array $credentials = [], bool $remember = false)

No description

static bool
once(array $credentials = [])

No description

static void
login(Authenticatable $user, bool $remember = false)

No description

static Authenticatable|bool
loginUsingId(mixed $id, bool $remember = false)

No description

static Authenticatable|bool
onceUsingId(mixed $id)

No description

static bool
viaRemember()

No description

static void
logout()

No description

static Response|null
basic(string $field = 'email', array $extraConditions = [])

No description

static Response|null
onceBasic(string $field = 'email', array $extraConditions = [])

No description

static bool
attemptWhen(array $credentials = [], array|callable|null $callbacks = null, bool $remember = false)

No description

static void
logoutCurrentDevice()

No description

static Authenticatable|null
logoutOtherDevices(string $password, string $attribute = 'password')

No description

static void
attempting(mixed $callback)

No description

static Authenticatable
getLastAttempted()

No description

static string
getName()

No description

static string
getRecallerName()

No description

static SessionGuard
setRememberDuration(int $minutes)

No description

static QueueingFactory
getCookieJar()

No description

static void
setCookieJar(QueueingFactory $cookie)

No description

static Dispatcher
getDispatcher()

No description

static void
setDispatcher(Dispatcher $events)

No description

static Session
getSession()

No description

static Authenticatable|null
getUser()

No description

static Request
getRequest()

No description

static SessionGuard
setRequest(Request $request)

No description

static Timebox
getTimebox()

No description

static Authenticatable
authenticate()

No description

static SessionGuard
forgetUser()

No description

static UserProvider
getProvider()

No description

static void
setProvider(UserProvider $provider)

No description

static void
macro(string $name, object|callable $macro)

No description

static void
mixin(object $mixin, bool $replace = true)

No description

static bool
hasMacro(string $name)

No description

static void
flushMacros()

No description

Details

in Facade at line 44
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

in Facade at line 62
static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

in Facade at line 78
static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

in Facade at line 94
static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 110
static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 126
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 140
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 152
static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

in Facade at line 165
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 178
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

in Facade at line 192
static protected bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

in Facade at line 205
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 77
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

in Facade at line 228
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 249
static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

in Facade at line 259
static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

in Facade at line 269
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 320
static Application getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application

in Facade at line 331
static void setFacadeApplication(Application $app)

Set the application instance.

Parameters

Application $app

Return Value

void

in Facade at line 345
static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

at line 90
static void routes(array $options = [])

Register the typical authentication routes for an application.

Parameters

array $options

Return Value

void

Exceptions

RuntimeException

at line 70
static StatefulGuard guard(string|null $name = null)

No description

Parameters

string|null $name

Return Value

StatefulGuard

at line 70
static SessionGuard createSessionDriver(string $name, array $config)

No description

Parameters

string $name
array $config

Return Value

SessionGuard

at line 70
static TokenGuard createTokenDriver(string $name, array $config)

No description

Parameters

string $name
array $config

Return Value

TokenGuard

at line 70
static string getDefaultDriver()

No description

Return Value

string

at line 70
static void shouldUse(string $name)

No description

Parameters

string $name

Return Value

void

at line 70
static void setDefaultDriver(string $name)

No description

Parameters

string $name

Return Value

void

at line 70
static AuthManager viaRequest(string $driver, callable $callback)

No description

Parameters

string $driver
callable $callback

Return Value

AuthManager

at line 70
static Closure userResolver()

No description

Return Value

Closure

at line 70
static AuthManager resolveUsersUsing(Closure $userResolver)

No description

Parameters

Closure $userResolver

Return Value

AuthManager

at line 70
static AuthManager extend(string $driver, Closure $callback)

No description

Parameters

string $driver
Closure $callback

Return Value

AuthManager

at line 70
static AuthManager provider(string $name, Closure $callback)

No description

Parameters

string $name
Closure $callback

Return Value

AuthManager

at line 70
static bool hasResolvedGuards()

No description

Return Value

bool

at line 70
static AuthManager forgetGuards()

No description

Return Value

AuthManager

at line 70
static AuthManager setApplication(Application $app)

No description

Parameters

Application $app

Return Value

AuthManager

at line 70
static UserProvider|null createUserProvider(string|null $provider = null)

No description

Parameters

string|null $provider

Return Value

UserProvider|null

at line 70
static string getDefaultUserProvider()

No description

Return Value

string

at line 70
static bool check()

No description

Return Value

bool

at line 70
static bool guest()

No description

Return Value

bool

at line 70
static Authenticatable|null user()

No description

Return Value

Authenticatable|null

at line 70
static int|string|null id()

No description

Return Value

int|string|null

at line 70
static bool validate(array $credentials = [])

No description

Parameters

array $credentials

Return Value

bool

at line 70
static bool hasUser()

No description

Return Value

bool

at line 70
static void setUser(Authenticatable $user)

No description

Parameters

Authenticatable $user

Return Value

void

at line 70
static bool attempt(array $credentials = [], bool $remember = false)

No description

Parameters

array $credentials
bool $remember

Return Value

bool

at line 70
static bool once(array $credentials = [])

No description

Parameters

array $credentials

Return Value

bool

at line 70
static void login(Authenticatable $user, bool $remember = false)

No description

Parameters

Authenticatable $user
bool $remember

Return Value

void

at line 70
static Authenticatable|bool loginUsingId(mixed $id, bool $remember = false)

No description

Parameters

mixed $id
bool $remember

Return Value

Authenticatable|bool

at line 70
static Authenticatable|bool onceUsingId(mixed $id)

No description

Parameters

mixed $id

Return Value

Authenticatable|bool

at line 70
static bool viaRemember()

No description

Return Value

bool

at line 70
static void logout()

No description

Return Value

void

at line 70
static Response|null basic(string $field = 'email', array $extraConditions = [])

No description

Parameters

string $field
array $extraConditions

Return Value

Response|null

at line 70
static Response|null onceBasic(string $field = 'email', array $extraConditions = [])

No description

Parameters

string $field
array $extraConditions

Return Value

Response|null

at line 70
static bool attemptWhen(array $credentials = [], array|callable|null $callbacks = null, bool $remember = false)

No description

Parameters

array $credentials
array|callable|null $callbacks
bool $remember

Return Value

bool

at line 70
static void logoutCurrentDevice()

No description

Return Value

void

at line 70
static Authenticatable|null logoutOtherDevices(string $password, string $attribute = 'password')

No description

Parameters

string $password
string $attribute

Return Value

Authenticatable|null

at line 70
static void attempting(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 70
static Authenticatable getLastAttempted()

No description

Return Value

Authenticatable

at line 70
static string getName()

No description

Return Value

string

at line 70
static string getRecallerName()

No description

Return Value

string

at line 70
static SessionGuard setRememberDuration(int $minutes)

No description

Parameters

int $minutes

Return Value

SessionGuard

at line 70
static QueueingFactory getCookieJar()

No description

Return Value

QueueingFactory

at line 70
static void setCookieJar(QueueingFactory $cookie)

No description

Parameters

QueueingFactory $cookie

Return Value

void

at line 70
static Dispatcher getDispatcher()

No description

Return Value

Dispatcher

at line 70
static void setDispatcher(Dispatcher $events)

No description

Parameters

Dispatcher $events

Return Value

void

at line 70
static Session getSession()

No description

Return Value

Session

at line 70
static Authenticatable|null getUser()

No description

Return Value

Authenticatable|null

at line 70
static Request getRequest()

No description

Return Value

Request

at line 70
static SessionGuard setRequest(Request $request)

No description

Parameters

Request $request

Return Value

SessionGuard

at line 70
static Timebox getTimebox()

No description

Return Value

Timebox

at line 70
static Authenticatable authenticate()

No description

Return Value

Authenticatable

at line 70
static SessionGuard forgetUser()

No description

Return Value

SessionGuard

at line 70
static UserProvider getProvider()

No description

Return Value

UserProvider

at line 70
static void setProvider(UserProvider $provider)

No description

Parameters

UserProvider $provider

Return Value

void

at line 70
static void macro(string $name, object|callable $macro)

No description

Parameters

string $name
object|callable $macro

Return Value

void

at line 70
static void mixin(object $mixin, bool $replace = true)

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 70
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 70
static void flushMacros()

No description

Return Value

void