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

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 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 mixed
getFacadeRoot()

Get the root object behind the facade.

from  Facade
static string
getFacadeAccessor()

Get the registered name of the component.

static mixed
resolveFacadeInstance(object|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 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 AuthManager
extend(string $driver, Closure $callback)

No description

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

No description

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

No description

static Authenticatable|null
user()

No description

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

No description

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

No description

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

No description

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

No description

static bool
check()

No description

static bool
guest()

No description

static bool
once(array $credentials = [])

No description

static bool
onceUsingId(mixed $id)

No description

static bool
validate(array $credentials = [])

No description

static bool
viaRemember()

No description

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

No description

static int|string|null
id()

No description

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

No description

static void
logout()

No description

static void
logoutCurrentDevice()

No description

static void
setUser(Authenticatable $user)

No description

static void
shouldUse(string $name)

;

Details

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected bool isMock()

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

Return Value

bool

static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

static protected mixed resolveFacadeInstance(object|string $name)

Resolve the facade root instance from the container.

Parameters

object|string $name

Return Value

mixed

static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

static Application getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application

static void setFacadeApplication(Application $app)

Set the application instance.

Parameters

Application $app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

static void routes(array $options = [])

Register the typical authentication routes for an application.

Parameters

array $options

Return Value

void

Exceptions

RuntimeException

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

No description

Parameters

string $driver
Closure $callback

Return Value

AuthManager

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

No description

Parameters

string $name
Closure $callback

Return Value

AuthManager

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

No description

Parameters

mixed $id
bool $remember

Return Value

Authenticatable

static Authenticatable|null user()

No description

Return Value

Authenticatable|null

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

No description

Parameters

string|null $name

Return Value

StatefulGuard

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

No description

Parameters

string $provider

Return Value

UserProvider|null

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

No description

Parameters

string $field
array $extraConditions

Return Value

Response|null

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

No description

Parameters

array $credentials
bool $remember

Return Value

bool

static bool check()

No description

Return Value

bool

static bool guest()

No description

Return Value

bool

static bool once(array $credentials = [])

No description

Parameters

array $credentials

Return Value

bool

static bool onceUsingId(mixed $id)

No description

Parameters

mixed $id

Return Value

bool

static bool validate(array $credentials = [])

No description

Parameters

array $credentials

Return Value

bool

static bool viaRemember()

No description

Return Value

bool

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

No description

Parameters

string $password
string $attribute

Return Value

bool|null

static int|string|null id()

No description

Return Value

int|string|null

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

No description

Parameters

Authenticatable $user
bool $remember

Return Value

void

static void logout()

No description

Return Value

void

static void logoutCurrentDevice()

No description

Return Value

void

static void setUser(Authenticatable $user)

No description

Parameters

Authenticatable $user

Return Value

void

static void shouldUse(string $name)

;

Parameters

string $name

Return Value

void