class Auth extends Facade

Properties

static protected $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 
spy()

Convert the facade into a Mockery spy.

from  Facade
static 
partialMock()

Initiate a partial mock on the facade.

from  Facade
static 
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static 
expects()

Initiate a mock expectation on the facade.

from  Facade
static 
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static 
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 
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|null $name = null)

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 
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(mixed $app)

Set the application instance.

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

Handle dynamic, static calls to the object.

from  Facade
static StatefulGuard
guard(UnitEnum|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(UnitEnum|string|null $name)

No description

static void
setDefaultDriver(UnitEnum|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 void
clearUserCache(mixed $identifier, ?string $guard = 'null')

No description

static AuthManager
redirectGuestsTo(callable|string|null $redirect)

No description

static AuthManager
redirectUsersTo(callable|string $redirect)

No description

static AuthManager
redirectTo(callable|string|null $guests = 'null', callable|string|null $users = 'null')

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 array
getGuards()

No description

static AuthManager
setApplication(Container $app)

No description

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

No description

void
static()

?string getDefaultUserProvider()

static bool
check()

No description

static bool
guest()

No description

static Authenticatable|null
user()

No description

static string|int|null
id()

No description

static bool
validate(array $credentials = '[]')

No description

static bool
hasUser()

No description

static Guard
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|false
loginUsingId(mixed $id, bool $remember = 'false')

No description

static Authenticatable|false
onceUsingId(mixed $id)

No description

static bool
viaRemember()

No description

static void
logout()

No description

Details

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

Run a Closure when the facade has been resolved.

Boot-only. The callback is registered on the worker-global container and runs for every subsequent resolution of the facade accessor.

Parameters

Closure $callback

Return Value

void

in Facade at line 71
static spy()

Convert the facade into a Mockery spy.

in Facade at line 89
static partialMock()

Initiate a partial mock on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 105
static shouldReceive()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 121
static expects()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 135
static protected createFreshMockInstance()

Create a fresh mock instance for the given class.

in Facade at line 147
static protected createMock()

Create a fresh mock instance for the given class.

in Facade at line 157
static protected bool isMock()

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

Return Value

bool

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

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 184
static swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Tests only. Replaces the worker-wide resolved facade instance and container binding; runtime use races across coroutines and changes every subsequent facade call.

Parameters

mixed $instance

in Facade at line 196
static bool isFake()

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

Return Value

bool

in Facade at line 207
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 53
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 246
static void clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

Boot or tests only. Clears a worker-wide facade cache entry; concurrent coroutines may still hold the previous resolved instance.

Parameters

string|null $name

Return Value

void

in Facade at line 257
static void clearResolvedInstances()

Clear all of the resolved instances.

Boot or tests only. Clears the worker-wide facade cache; concurrent coroutines may still hold previously resolved instances.

Return Value

void

in Facade at line 265
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 324
static getFacadeApplication()

Get the application instance behind the facade.

in Facade at line 337
static void setFacadeApplication(mixed $app)

Set the application instance.

Tests only. Replaces the worker-wide facade application reference; runtime use races across coroutines and breaks every facade lookup.

Parameters

mixed $app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Exceptions

RuntimeException

at line 48
static StatefulGuard guard(UnitEnum|string|null $name = 'null')

No description

Parameters

UnitEnum|string|null $name

Return Value

StatefulGuard

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

No description

Parameters

string $name
array $config

Return Value

SessionGuard

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

No description

Parameters

string $name
array $config

Return Value

TokenGuard

at line 48
static string getDefaultDriver()

No description

Return Value

string

at line 48
static void shouldUse(UnitEnum|string|null $name)

No description

Parameters

UnitEnum|string|null $name

Return Value

void

at line 48
static void setDefaultDriver(UnitEnum|string $name)

No description

Parameters

UnitEnum|string $name

Return Value

void

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

No description

Parameters

string $driver
callable $callback

Return Value

AuthManager

at line 48
static Closure userResolver()

No description

Return Value

Closure

at line 48
static AuthManager resolveUsersUsing(Closure $userResolver)

No description

Parameters

Closure $userResolver

Return Value

AuthManager

at line 48
static void clearUserCache(mixed $identifier, ?string $guard = 'null')

No description

Parameters

mixed $identifier
?string $guard

Return Value

void

at line 48
static AuthManager redirectGuestsTo(callable|string|null $redirect)

No description

Parameters

callable|string|null $redirect

Return Value

AuthManager

at line 48
static AuthManager redirectUsersTo(callable|string $redirect)

No description

Parameters

callable|string $redirect

Return Value

AuthManager

at line 48
static AuthManager redirectTo(callable|string|null $guests = 'null', callable|string|null $users = 'null')

No description

Parameters

callable|string|null $guests
callable|string|null $users

Return Value

AuthManager

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

No description

Parameters

string $driver
Closure $callback

Return Value

AuthManager

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

No description

Parameters

string $name
Closure $callback

Return Value

AuthManager

at line 48
static bool hasResolvedGuards()

No description

Return Value

bool

at line 48
static AuthManager forgetGuards()

No description

Return Value

AuthManager

at line 48
static array getGuards()

No description

Return Value

array

at line 48
static AuthManager setApplication(Container $app)

No description

Parameters

Container $app

Return Value

AuthManager

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

No description

Parameters

string|null $provider

Return Value

UserProvider|null

at line 48
void static()

?string getDefaultUserProvider()

Return Value

void

at line 48
static bool check()

No description

Return Value

bool

at line 48
static bool guest()

No description

Return Value

bool

at line 48
static Authenticatable|null user()

No description

Return Value

Authenticatable|null

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

No description

Return Value

string|int|null

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

No description

Parameters

array $credentials

Return Value

bool

at line 48
static bool hasUser()

No description

Return Value

bool

at line 48
static Guard setUser(Authenticatable $user)

No description

Parameters

Authenticatable $user

Return Value

Guard

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

No description

Parameters

array $credentials
bool $remember

Return Value

bool

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

No description

Parameters

array $credentials

Return Value

bool

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

No description

Parameters

Authenticatable $user
bool $remember

Return Value

void

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

No description

Parameters

mixed $id
bool $remember

Return Value

Authenticatable|false

at line 48
static Authenticatable|false onceUsingId(mixed $id)

No description

Parameters

mixed $id

Return Value

Authenticatable|false

at line 48
static bool viaRemember()

No description

Return Value

bool

at line 48
static void logout()

No description

Return Value

void