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 = [])

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

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

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 Expectation expects()

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 protected bool isFake()

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

Return Value

bool

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(string $name)

Resolve the facade root instance from the container.

Parameters

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 Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

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 = [])

Parameters

array

$options

Return Value

void

Exceptions

RuntimeException

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

No description

Parameters

string|null

$name

Return Value

StatefulGuard

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

No description

Parameters

string	$name
array	$config

Return Value

SessionGuard

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

No description

Parameters

string	$name
array	$config

Return Value

TokenGuard

static string getDefaultDriver()

No description

Return Value

string

static void shouldUse(string $name)

No description

Parameters

string

$name

Return Value

void

static void setDefaultDriver(string $name)

No description

Parameters

string

$name

Return Value

void

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

No description

Parameters

string	$driver
callable	$callback

Return Value

AuthManager

static Closure userResolver()

No description

Return Value

Closure

static AuthManager resolveUsersUsing(Closure $userResolver)

No description

Parameters

Closure

$userResolver

Return Value

AuthManager

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 bool hasResolvedGuards()

No description

Return Value

bool

static AuthManager forgetGuards()

No description

Return Value

AuthManager

static AuthManager setApplication(Application $app)

No description

Parameters

Application

$app

Return Value

AuthManager

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

No description

Parameters

string|null

$provider

Return Value

UserProvider|null

static string getDefaultUserProvider()

No description

Return Value

string

static bool check()

No description

Return Value

bool

static bool guest()

No description

Return Value

bool

static Authenticatable|null user()

No description

Return Value

Authenticatable|null

static int|string|null id()

No description

Return Value

int|string|null

static bool validate(array $credentials = [])

No description

Parameters

array

$credentials

Return Value

bool

static bool hasUser()

No description

Return Value

bool

static void setUser(Authenticatable $user)

No description

Parameters

Authenticatable

$user

Return Value

void

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

No description

Parameters

array	$credentials
bool	$remember

Return Value

bool

static bool once(array $credentials = [])

No description

Parameters

array

$credentials

Return Value

bool

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

No description

Parameters

Authenticatable	$user
bool	$remember

Return Value

void

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

No description

Parameters

mixed	$id
bool	$remember

Return Value

Authenticatable|bool

static Authenticatable|bool onceUsingId(mixed $id)

No description

Parameters

mixed

$id

Return Value

Authenticatable|bool

static bool viaRemember()

No description

Return Value

bool

static void logout()

No description

Return Value

void

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

No description

Parameters

string	$field
array	$extraConditions

Return Value

Response|null

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

No description

Parameters

string	$field
array	$extraConditions

Return Value

Response|null

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

static void logoutCurrentDevice()

No description

Return Value

void

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

No description

Parameters

string	$password
string	$attribute

Return Value

Authenticatable|null

static void attempting(mixed $callback)

No description

Parameters

mixed

$callback

Return Value

void

static Authenticatable getLastAttempted()

No description

Return Value

Authenticatable

static string getName()

No description

Return Value

string

static string getRecallerName()

No description

Return Value

string

static SessionGuard setRememberDuration(int $minutes)

No description

Parameters

int

$minutes

Return Value

SessionGuard

static QueueingFactory getCookieJar()

No description

Return Value

QueueingFactory

static void setCookieJar(QueueingFactory $cookie)

No description

Parameters

QueueingFactory

$cookie

Return Value

void

static Dispatcher getDispatcher()

No description

Return Value

Dispatcher

static void setDispatcher(Dispatcher $events)

No description

Parameters

Dispatcher

$events

Return Value

void

static Session getSession()

No description

Return Value

Session

static Authenticatable|null getUser()

No description

Return Value

Authenticatable|null

static Request getRequest()

No description

Return Value

Request

static SessionGuard setRequest(Request $request)

No description

Parameters

Request

$request

Return Value

SessionGuard

static Timebox getTimebox()

No description

Return Value

Timebox

static Authenticatable authenticate()

No description

Return Value

Authenticatable

static SessionGuard forgetUser()

No description

Return Value

SessionGuard

static UserProvider getProvider()

No description

Return Value

UserProvider

static void setProvider(UserProvider $provider)

No description

Parameters

UserProvider

$provider

Return Value

void

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

No description

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

No description

Parameters

object	$mixin
bool	$replace

Return Value

void

static bool hasMacro(string $name)

No description

Parameters

string

$name

Return Value

bool

static void flushMacros()

No description

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Support/Facades/Auth.html