Auth

класс Auth расширяет Facade (View source)

Свойства

статический защищённый Application\|null	$app	Экземпляр приложения, на котором базируется фейсад.	из Фейсада
статический защищённый массив	$resolvedInstance	Решённые экземпляры объекта.	из Фейсада
статический защищённый bool	$cached	Указывает, следует ли кешировать решённый экземпляр.	из Фейсада

Методы

static void	resolved(Closure $callback) Выполнить замыкание, когда фасад будет разрешен.	from Facade
static MockInterface	spy() Преобразовать фасад в шпион Mockery.	from Facade
static MockInterface	partialMock() Инициализировать частичный мок для фасада.	from Facade
static Expectation	shouldReceive() Инициализировать ожидание мока для фасада.	from Facade
static Expectation	expects() Инициализировать ожидание мока для фасада.	from Facade
static MockInterface	createFreshMockInstance() Создать свежий экземпляр мока для заданного класса.	from Facade
static MockInterface	createMock() Создать свежий экземпляр мока для заданного класса.	from Facade
static bool	isMock() Определяет, установлен ли мок в качестве экземпляра фасада.	from Facade
static string\|null	getMockableClass() Получить мокируемый класс для связанного экземпляра.	from Facade
static void	swap(mixed $instance) Обмен базового экземпляра за фасадом.	from Facade
static bool	isFake() Определяет, установлен ли "фиктивный" объект в качестве экземпляра фасада.	from Facade
static mixed	getFacadeRoot() Получить корневой объект за фасадом.	from Facade
static string	getFacadeAccessor() Получить зарегистрированное имя компонента.
static mixed	resolveFacadeInstance(string $name) Разрешить корневой экземпляр фасада из контейнера.	from Facade
static void	clearResolvedInstance(string $name) Очистить разрешенный экземпляр фасада.	from Facade
static void	clearResolvedInstances() Очистить все разрешенные экземпляры.	from Facade
static Collection	defaultAliases() Получить стандартные псевдонимы приложения.	from Facade
static Application\|null	getFacadeApplication() Получить экземпляр приложения за фасадом.	from Facade
static void	setFacadeApplication(Application\|null $app) Установить экземпляр приложения.	from Facade
static mixed	__callStatic(string $method, array $args) Обработка динамических статических вызовов объекта.	from Facade
static void	routes(array $options = []) Регистрация типичных маршрутов аутентификации для приложения.
static StatefulGuard	guard(string\|null $name = null) Без описания
static SessionGuard	createSessionDriver(string $name, array $config) Без описания
static TokenGuard	createTokenDriver(string $name, array $config) Без описания
static string	getDefaultDriver() Без описания
static void	shouldUse(string $name) Без описания
static void	setDefaultDriver(string $name) Без описания
static AuthManager	viaRequest(string $driver, callable $callback) Без описания
static Closure	userResolver() Без описания
static AuthManager	resolveUsersUsing(Closure $userResolver) Без описания
static AuthManager	extend(string $driver, Closure $callback) Без описания
static AuthManager	provider(string $name, Closure $callback) Без описания
static bool	hasResolvedGuards() Без описания
static AuthManager	forgetGuards() Без описания
static AuthManager	setApplication(Application $app) Без описания

static UserProvider\|null	createUserProvider(string\|null $provider = null) Нет описания
static string	getDefaultUserProvider() Нет описания
static bool	check() Нет описания
static bool	guest() Нет описания
static Authenticatable\|null	user() Нет описания
static int\|string\|null	id() Нет описания
static bool	validate(array $credentials = []) Нет описания
static bool	hasUser() Нет описания
static void	setUser(Authenticatable $user) Нет описания
static bool	attempt(array $credentials = [], bool $remember = false) Нет описания
static bool	once(array $credentials = []) Нет описания
static void	login(Authenticatable $user, bool $remember = false) Нет описания
static Authenticatable\|bool	loginUsingId(mixed $id, bool $remember = false) Нет описания
static Authenticatable\|bool	onceUsingId(mixed $id) Нет описания
static bool	viaRemember() Нет описания
static void	logout() Нет описания
static Response\|null	basic(string $field = 'email', array $extraConditions = []) Нет описания
static Response\|null	onceBasic(string $field = 'email', array $extraConditions = []) Нет описания
static bool	attemptWhen(array $credentials = [], array\|callable\|null $callbacks = null, bool $remember = false) Нет описания
static void	logoutCurrentDevice() Нет описания
static Authenticatable\|null	logoutOtherDevices(string $password, string $attribute = 'password') Нет описания
static void	attempting(mixed $callback) Нет описания
static Authenticatable	getLastAttempted() Нет описания
static string	getName() Нет описания
static string	getRecallerName() Нет описания
static SessionGuard	setRememberDuration(int $minutes) Нет описания
static QueueingFactory	getCookieJar() Нет описания
static void	setCookieJar(QueueingFactory $cookie) Нет описания
static Dispatcher	getDispatcher() Нет описания
static void	setDispatcher(Dispatcher $events) Нет описания
static Session	getSession() Нет описания
static Authenticatable\|null	getUser() Нет описания
static Request	getRequest() Нет описания
static SessionGuard	setRequest(Request $request) Нет описания
static Timebox	getTimebox() Нет описания
static Authenticatable	authenticate() Нет описания
static SessionGuard	forgetUser() Нет описания
static UserProvider	getProvider() Нет описания
static void	setProvider(UserProvider $provider) Нет описания
static void	macro(string $name, object\|callable $macro) Нет описания
static void	mixin(object $mixin, bool $replace = true) Нет описания
static bool	hasMacro(string $name) Нет описания
static void	flushMacros() Нет описания

Подробности

static void resolved(Closure $callback)

Выполнить замыкание, когда фасад будет разрешен.

Параметры

Closure

$callback

Возвращаемое значение

void

static MockInterface spy()

Преобразовать фасад в шпиона Mockery.

Возвращаемое значение

MockInterface

static MockInterface partialMock()

Инициализировать частичный макет на фасад.

Возвращаемое значение

MockInterface

static Expectation shouldReceive()

Инициализировать ожидание макета на фасад.

Возвращаемое значение

Expectation

static Expectation expects()

Инициализировать ожидание макета на фасад.

Возвращаемое значение

Expectation

static protected MockInterface createFreshMockInstance()

Создать новый экземпляр макета для данного класса.

Возвращаемое значение

MockInterface

static protected MockInterface createMock()

Создать новый экземпляр макета для данного класса.

Возвращаемое значение

MockInterface

static protected bool isMock()

Определяет, установлен ли макет в качестве экземпляра фасада.

Возвращаемое значение

bool

static protected string|null getMockableClass()

Получить имитируемый класс для связанного экземпляра.

Возвращаемое значение

string|null

static void swap(mixed $instance)

Переключить базовый экземпляр за фасадом.

Параметры

mixed

$instance

Возвращаемое значение

void

static protected bool isFake()

Определяет, установлен ли «фейк» в качестве экземпляра фасада.

Возвращаемое значение

bool

static mixed getFacadeRoot()

Получить корневой объект за фасадом.

Возвращаемое значение

mixed

static protected string getFacadeAccessor()

Получить зарегистрированное имя компонента.

Возвращаемое значение

string

static protected mixed resolveFacadeInstance(string $name)

Разрешить корневой экземпляр фасада из контейнера.

Параметры

string

$name

Возвращаемое значение

mixed

static void clearResolvedInstance(string $name)

Очистить разрешенный экземпляр фасада.

Параметры

string

$name

Возвращаемое значение

void

static void clearResolvedInstances()

Очистить все разрешенные экземпляры.

Возвращаемое значение

void

static Collection defaultAliases()

Получить стандартные псевдонимы приложения.

Возвращаемое значение

Collection

static Application|null getFacadeApplication()

Получить экземпляр приложения за фасадом.

Возвращаемое значение

Application|null

static void setFacadeApplication(Application|null $app)

Установить экземпляр приложения.

Параметры

Application|null

$app

Возвращаемое значение

void

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

Обработать динамические статические вызовы к объекту.

Параметры

string	$method
array	$args

Возвращаемое значение

mixed

Исключения

RuntimeException

static void routes(array $options = [])

Зарегистрировать типичные маршруты аутентификации для приложения.

Параметры

array

$options

Возвращаемое значение

void

Исключения

RuntimeException

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

Без описания

Параметры

string|null

$name

Возвращаемое значение

StatefulGuard

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

Без описания

Параметры

string	$name
array	$config

Возвращаемое значение

SessionGuard

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

Без описания

Параметры

string	$name
array	$config

Возвращаемое значение

TokenGuard

static string getDefaultDriver()

Без описания

Возвращаемое значение

string

static void shouldUse(string $name)

Без описания

Параметры

string

$name

Возвращаемое значение

void

static void setDefaultDriver(string $name)

Без описания

Параметры

string

$name

Возвращаемое значение

void

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

Без описания

Параметры

string	$driver
callable	$callback

Возвращаемое значение

AuthManager

static Closure userResolver()

Без описания

Возвращаемое значение

Closure

static AuthManager resolveUsersUsing(Closure $userResolver)

Без описания

Параметры

Closure

$userResolver

Возвращаемое значение

AuthManager

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

Без описания

Параметры

string	$driver
Closure	$callback

Возвращаемое значение

AuthManager

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

Без описания

Параметры

string	$name
Closure	$callback

Возвращаемое значение

AuthManager

static bool hasResolvedGuards()

Без описания

Возвращаемое значение

bool

static AuthManager forgetGuards()

Без описания

Возвращаемое значение

AuthManager

static AuthManager setApplication(Application $app)

Без описания

Параметры

Application

$app

Возвращаемое значение

AuthManager

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

Без описания

Параметры

string|null

$provider

Возвращаемое значение

UserProvider|null

static string getDefaultUserProvider()

Без описания

Возвращаемое значение

string

static bool check()

Без описания

Возвращаемое значение

bool

static bool guest()

Без описания

Возвращаемое значение

bool

static Authenticatable|null user()

Без описания

Возвращаемое значение

Authenticatable|null

static int|string|null id()

Без описания

Возвращаемое значение

int|string|null

static bool validate(array $credentials = [])

Без описания

Параметры

array

$credentials

Возвращаемое значение

bool

static bool hasUser()

Без описания

Возвращаемое значение

bool

static void setUser(Authenticatable $user)

Без описания

Параметры

Authenticatable

$user

Возвращаемое значение

void

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

Без описания

Параметры

Массив	$credentials
Булево	$remember

Возвращаемое значение

Булево

static bool once(array $credentials = [])

Без описания

Параметры

Массив

$credentials

Возвращаемое значение

Булево

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

Без описания

Параметры

Authenticatable	$user
Булево	$remember

Возвращаемое значение

void

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

Без описания

Параметры

mixed	$id
Булево	$remember

Возвращаемое значение

Authenticatable|bool

static Authenticatable|bool onceUsingId(mixed $id)

Без описания

Параметры

mixed

$id

Возвращаемое значение

Authenticatable|bool

static bool viaRemember()

Без описания

Возвращаемое значение

Булево

static void logout()

Без описания

Возвращаемое значение

void

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

Без описания

Параметры

Строка	$field
Массив	$extraConditions

Возвращаемое значение

Response|null

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

Без описания

Параметры

Строка	$field
Массив	$extraConditions

Возвращаемое значение

Response|null

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

Без описания

Параметры

Массив	$credentials
Массив\|вызываемый объект\|null	$callbacks
Булево	$remember

Возвращаемое значение

Булево

static void logoutCurrentDevice()

Без описания

Возвращаемое значение

void

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

Без описания

Параметры

Строка	$password
Строка	$attribute

Возвращаемое значение

Authenticatable|null

static void attempting(mixed $callback)

Без описания

Параметры

mixed

$callback

Возвращаемое значение

void

static Authenticatable getLastAttempted()

Без описания

Возвращаемое значение

Authenticatable

static string getName()

Без описания

Возвращаемое значение

Строка

static string getRecallerName()

Без описания

Возвращаемое значение

Строка

static SessionGuard setRememberDuration(int $minutes)

Без описания

Параметры

Целое число

$minutes

Возвращаемое значение

SessionGuard

static QueueingFactory getCookieJar()

Без описания

Возвращаемое значение

QueueingFactory

static void setCookieJar(QueueingFactory $cookie)

Без описания

Параметры

QueueingFactory

$cookie

Возвращаемое значение

void

static Dispatcher getDispatcher()

Без описания

Возвращаемое значение

Dispatcher

static void setDispatcher(Dispatcher $events)

Без описания

Параметры

Dispatcher

$events

Возвращаемое значение

void

static Сессия getSession()

Описание отсутствует

Возвращаемое значение

Сессия

static Пользователь|null getUser()

Описание отсутствует

Возвращаемое значение

Пользователь|null

static Запрос getRequest()

Описание отсутствует

Возвращаемое значение

Запрос

static SessionGuard setRequest(Запрос $request)

Описание отсутствует

Параметры

Запрос

$request

Возвращаемое значение

SessionGuard

static Блок времени getTimebox()

Описание отсутствует

Возвращаемое значение

Блок времени

static Проверяемый authenticate()

Описание отсутствует

Возвращаемое значение

Проверяемый

static SessionGuard forgetUser()

Описание отсутствует

Возвращаемое значение

SessionGuard

static Поставщик пользователей getProvider()

Описание отсутствует

Возвращаемое значение

Поставщик пользователей

static void setProvider(Поставщик пользователей $provider)

Описание отсутствует

Параметры

Поставщик пользователей

$provider

Возвращаемое значение

void

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

Описание отсутствует

Параметры

string	$name
object\|callable	$macro

Возвращаемое значение

void

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

Описание отсутствует

Параметры

object	$mixin
bool	$replace

Возвращаемое значение

void

static bool hasMacro(string $name)

Описание отсутствует

Параметры

string

$name

Возвращаемое значение

bool

static void flushMacros()

Описание отсутствует

Возвращаемое значение

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