Auth
extends Facade
in package
Tags
Table of Contents
- $app : Application
- The application instance being facaded.
- $resolvedInstance : array<string|int, mixed>
- The resolved object instances.
- __callStatic() : mixed
- Handle dynamic, static calls to the object.
- attempt() :
- check() :
- clearResolvedInstance() : void
- Clear a resolved facade instance.
- clearResolvedInstances() : void
- Clear all of the resolved instances.
- getFacadeApplication() : Application
- Get the application instance behind the facade.
- getFacadeRoot() : mixed
- Get the root object behind the facade.
- guard() :
- guest() :
- id() :
- login() :
- loginUsingId() :
- logout() :
- once() :
- onceUsingId() :
- routes() : void
- Register the typical authentication routes for an application.
- setFacadeApplication() : void
- Set the application instance.
- setUser() :
- shouldReceive() : Expectation
- Initiate a mock expectation on the facade.
- shouldUse() :
- spy() : void
- Convert the facade into a Mockery spy.
- swap() : void
- Hotswap the underlying instance behind the facade.
- user() :
- validate() :
- viaRemember() :
- createFreshMockInstance() : Expectation
- Create a fresh mock instance for the given class.
- createMock() : MockInterface
- Create a fresh mock instance for the given class.
- getFacadeAccessor() : string
- Get the registered name of the component.
- getMockableClass() : string|null
- Get the mockable class for the bound instance.
- isMock() : bool
- Determines whether a mock is set as the instance of the facade.
- resolveFacadeInstance() : mixed
- Resolve the facade root instance from the container.
Properties
$app
The application instance being facaded.
protected
static Application
$app
$resolvedInstance
The resolved object instances.
protected
static array<string|int, mixed>
$resolvedInstance
Methods
__callStatic()
Handle dynamic, static calls to the object.
public
static __callStatic(string $method, array<string|int, mixed> $args) : mixed
Parameters
- $method : string
- $args : array<string|int, mixed>
Tags
Return values
mixed —attempt()
public
static attempt(array<string|int, mixed> $credentials = [], bool $remember = false) :
Parameters
- $credentials = [] : array<string|int, mixed>
- $remember = false : bool
Return values
—check()
public
static check() :
Return values
—clearResolvedInstance()
Clear a resolved facade instance.
public
static clearResolvedInstance(string $name) : void
Parameters
- $name : string
Return values
void —clearResolvedInstances()
Clear all of the resolved instances.
public
static clearResolvedInstances() : void
Return values
void —getFacadeApplication()
Get the application instance behind the facade.
public
static getFacadeApplication() : Application
Return values
Application —getFacadeRoot()
Get the root object behind the facade.
public
static getFacadeRoot() : mixed
Return values
mixed —guard()
public
static guard(string|null $name = null) :
Parameters
- $name = null : string|null
Return values
—guest()
public
static guest() :
Return values
—id()
public
static id() :
Return values
—login()
public
static login(Authenticatable $user, bool $remember = false) :
Parameters
- $user : Authenticatable
- $remember = false : bool
Return values
—loginUsingId()
public
static loginUsingId(mixed $id, bool $remember = false) :
Parameters
- $id : mixed
- $remember = false : bool
Return values
—logout()
public
static logout() :
Return values
—once()
public
static once(array<string|int, mixed> $credentials = []) :
Parameters
- $credentials = [] : array<string|int, mixed>
Return values
—onceUsingId()
public
static onceUsingId(mixed $id) :
Parameters
- $id : mixed
Return values
—routes()
Register the typical authentication routes for an application.
public
static routes() : void
Return values
void —setFacadeApplication()
Set the application instance.
public
static setFacadeApplication(Application $app) : void
Parameters
- $app : Application
Return values
void —setUser()
public
static setUser(Authenticatable $user) :
Parameters
- $user : Authenticatable
Return values
—shouldReceive()
Initiate a mock expectation on the facade.
public
static shouldReceive() : Expectation
Return values
Expectation —shouldUse()
public
static shouldUse(string $name) :
;
Parameters
- $name : string
Return values
—spy()
Convert the facade into a Mockery spy.
public
static spy() : void
Return values
void —swap()
Hotswap the underlying instance behind the facade.
public
static swap(mixed $instance) : void
Parameters
- $instance : mixed
Return values
void —user()
public
static user() :
Return values
—validate()
public
static validate(array<string|int, mixed> $credentials = []) :
Parameters
- $credentials = [] : array<string|int, mixed>
Return values
—viaRemember()
public
static viaRemember() :
Return values
—createFreshMockInstance()
Create a fresh mock instance for the given class.
protected
static createFreshMockInstance() : Expectation
Return values
Expectation —createMock()
Create a fresh mock instance for the given class.
protected
static createMock() : MockInterface
Return values
MockInterface —getFacadeAccessor()
Get the registered name of the component.
protected
static getFacadeAccessor() : string
Return values
string —getMockableClass()
Get the mockable class for the bound instance.
protected
static getMockableClass() : string|null
Return values
string|null —isMock()
Determines whether a mock is set as the instance of the facade.
protected
static isMock() : bool
Return values
bool —resolveFacadeInstance()
Resolve the facade root instance from the container.
protected
static resolveFacadeInstance(string|object $name) : mixed
Parameters
- $name : string|object