Spec-Zone.ru › Laravel 5.8

Маршрутизатор

класс Router реализует Registrar, BindingRegistrar (Просмотреть исходный код)

Трейты

Macroable

Свойства

статический защищённый массив $macros Зарегистрированные строковые макросы. из Macroable
защищённый Dispatcher $events Экземпляр диспетчера событий.
защищённый Container $container Экземпляр контейнера IoC.
защищённый RouteCollection $routes Экземпляр коллекции маршрутов.
защищённый Route|null $current Текущий обработанный экземпляр маршрута.
защищённый Request $currentRequest Запрос, который в настоящее время обрабатывается.
защищённый массив $middleware Все псевдонимы ключей для middleware.
защищённый массив $middlewareGroups Все группы middleware.
массив $middlewarePriority Список middleware, отсортированный по приоритету.
защищённый массив $binders Зарегистрированные связыватели значений маршрутов.
защищённый массив $patterns Глобально доступные шаблоны параметров.
защищённый массив $groupStack Стек атрибутов группы маршрутов.
статический массив $verbs Все поддерживаемые маршрутизатором глаголы.

Методы

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

Зарегистрировать пользовательское макро.

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

Добавить другой объект в класс.

 from Macroable
static bool hasMacro(string $name)

Проверить, зарегистрировано ли макро.

 from Macroable
static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы к классу.

 from Macroable
mixed __call(string $method, array $parameters)

Динамически обработать вызовы в экземпляр маршрутизатора.
void __construct(Dispatcher $events, Container $container = null)

Создать новый экземпляр маршрутизатора.
Route get(string $uri, Closure|array|string|callable $action = null)

Зарегистрировать новый маршрут GET в маршрутизаторе.
Route post(string $uri, Closure|array|string|callable $action = null)

Зарегистрировать новый маршрут POST в маршрутизаторе.
Route put(string $uri, Closure|array|string|callable $action = null)

Зарегистрировать новый маршрут PUT в маршрутизаторе.
Route patch(string $uri, Closure|array|string|callable $action = null)

Зарегистрировать новый маршрут PATCH в маршрутизаторе.
Route delete(string $uri, Closure|array|string|callable $action = null)

Зарегистрировать новый маршрут DELETE в маршрутизаторе.
Route options(string $uri, Closure|array|string|callable $action = null)

Зарегистрировать новый маршрут OPTIONS в маршрутизаторе.
Route any(string $uri, Closure|array|string|callable|null $action = null)

Зарегистрировать новый маршрут, обрабатывающий все HTTP-методы.
Route fallback(Closure|array|string|callable|null $action)

Зарегистрировать новый fallback-маршрут.
Route redirect(string $uri, string $destination, int $status = 302)

Создать перенаправление с одного URI на другой.
Route permanentRedirect(string $uri, string $destination)

Создать постоянное перенаправление с одного URI на другой.
Route view(string $uri, string $view, array $data = [])

Зарегистрировать новый маршрут, возвращающий представление.
Route match(array|string $methods, string $uri, Closure|array|string|callable $action = null)

Зарегистрировать новый маршрут с указанными HTTP-методами.
void resources(array $resources, array $options = [])

Зарегистрировать массив контроллеров ресурсов.
PendingResourceRegistration resource(string $name, string $controller, array $options = [])

Маршрутизировать ресурс к контроллеру.
void apiResources(array $resources, array $options = [])

Зарегистрировать массив контроллеров API-ресурсов.
PendingResourceRegistration apiResource(string $name, string $controller, array $options = [])

Маршрутизировать API-ресурс к контроллеру.
void group(array $attributes, Closure|string $routes)

Создать группу маршрутов с общими атрибутами.
void updateGroupStack(array $attributes)

Обновить стек групп с заданными атрибутами.
array mergeWithLastGroup(array $new)

Объединить заданный массив со стеком последней группы.
void loadRoutes(Closure|string $routes)

Загрузить предоставленные маршруты.
string getLastGroupPrefix()

Получить префикс из последней группы в стеке.
Route addRoute(array|string $methods, string $uri, Closure|array|string|callable|null $action)

Добавить маршрут в базовый набор маршрутов.
Route createRoute(array|string $methods, string $uri, mixed $action)

Создать новый экземпляр маршрута.
bool actionReferencesController(array $action)

Определить, ссылается ли действие на контроллер.
array convertToControllerAction(array|string $action)

Добавить действие контроллера в массив action.
string prependGroupNamespace(string $class)

Добавить префикс имени пространства имён последней группы к предложению использования.
Route newRoute(array|string $methods, string $uri, mixed $action)

Создать новый объект Route.
string prefix(string $uri)

Добавить префикс к заданному URI с использованием последнего префикса.
Route addWhereClausesToRoute(Route $route)

Добавить необходимые условия where к маршруту на основе его первоначальной регистрации.
void mergeGroupAttributesIntoRoute(Route $route)

Объединить стек групп с действием контроллера.
Response|JsonResponse respondWithRoute(string $name)

Возвратить ответ, возвращённый заданным маршрутом.
Response|JsonResponse dispatch(Request $request)

Обработать запрос в приложении.
Response|JsonResponse dispatchToRoute(Request $request)

Обработать запрос по маршруту и вернуть ответ.
Route findRoute(Request $request)

Найти маршрут, соответствующий заданному запросу.
Response|JsonResponse runRoute(Request $request, Route $route)

Возвратить ответ для заданного маршрута.
mixed runRouteWithinStack(Route $route, Request $request)

Выполнить заданный маршрут в рамках экземпляра стека "луковицы".
array gatherRouteMiddleware(Route $route)

Собрать middleware для заданного маршрута с разрешенными именами классов.
array sortMiddleware(Collection $middlewares)

Отсортировать заданный middleware по приоритету.
Response|JsonResponse prepareResponse(Request $request, mixed $response)

Создать экземпляр ответа из данного значения.
static Response|JsonResponse toResponse(Request $request, mixed $response)

Статическая версия prepareResponse.
Route substituteBindings(Route $route)

Подставить привязки маршрута в маршрут.
void substituteImplicitBindings(Route $route)

Подставить неявные привязки Eloquent модели к маршруту.
mixed performBinding(string $key, string $value, Route $route)

Вызвать callback привязки для данного ключа.
void matched(string|callable $callback)

Зарегистрировать обработчик события сопоставления маршрута.
array getMiddleware()

Получить все определенные middleware короткие имена.
$this aliasMiddleware(string $name, string $class)

Зарегистрировать короткое имя для middleware.
bool hasMiddlewareGroup(string $name)

Проверить, существует ли группа middleware с заданным именем.
array getMiddlewareGroups()

Получить все определенные группы middleware.
$this middlewareGroup(string $name, array $middleware)

Зарегистрировать группу middleware.
$this prependMiddlewareToGroup(string $group, string $middleware)

Добавить middleware в начало группы middleware.
$this pushMiddlewareToGroup(string $group, string $middleware)

Добавить middleware в конец группы middleware.
void bind(string $key, string|callable $binder)

Добавить новый binder параметра маршрута.
void model(string $key, string $class, Closure $callback = null)

Зарегистрировать привязку модели для подстановки.
Closure getBindingCallback(string $key)

Получить callback привязки для данной привязки.
array getPatterns()

Получить глобальные шаблоны "where".
void pattern(string $key, string $pattern)

Установить глобальный шаблон "where" для всех маршрутов.
void patterns(array $patterns)

Установить группу глобальных шаблонов "where" для всех маршрутов.
bool hasGroupStack()

Определить, есть ли у маршрутизатора текущий стек групп.
array getGroupStack()

Получить текущий стек групп для маршрутизатора.
mixed input(string $key, string|null $default = null)

Получить параметр маршрута для текущего маршрута.
Request getCurrentRequest()

Получить запрос, который в данный момент обрабатывается.
Route getCurrentRoute()

Получить текущий обработанный экземпляр маршрута.
Route|null current()

Получить текущий обработанный экземпляр маршрута.
bool has(string $name)

Проверить, существует ли маршрут с заданным именем.
string|null currentRouteName()

Получить имя текущего маршрута.
bool is(mixed ...$patterns)

Псевдоним метода "currentRouteNamed".
bool currentRouteNamed(mixed ...$patterns)

Определить, соответствует ли текущий маршрут шаблону.
string|null currentRouteAction()

Получить текущее действие маршрута.
bool uses(array ...$patterns)

Псевдоним метода "currentRouteUses".
bool currentRouteUses(string $action)

Определить, соответствует ли действие текущего маршрута заданному действию.
void auth(array $options = [])

Регистрация типичных маршрутов аутентификации для приложения.
void resetPassword()

Регистрация типичных маршрутов сброса пароля для приложения.
void emailVerification()

Регистрация типичных маршрутов проверки электронной почты для приложения.
void singularResourceParameters(bool $singular = true)

Установить неопределённые глобальные параметры ресурса в единственном числе.
void resourceParameters(array $parameters = [])

Установить глобальное сопоставление параметров ресурса.
array|null resourceVerbs(array $verbs = [])

Получить или установить глаголы, используемые в URI ресурсов.
RouteCollection getRoutes()

Получить базовую коллекцию маршрутов.
void setRoutes(RouteCollection $routes)

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

Подробности

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

Регистрация пользовательского макроса.

Parameters

string $name
object|callable $macro

Return Value

void

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

Добавление другого объекта в класс.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string $name

Return Value

bool

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

Динамическая обработка вызовов класса.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамическая обработка вызовов экземпляра маршрутизатора.

Parameters

string $method
array $parameters

Return Value

mixed

void __construct(Dispatcher $events, Container $container = null)

Создание нового экземпляра маршрутизатора.

Parameters

Dispatcher $events
Container $container

Return Value

void

Route get(string $uri, Closure|array|string|callable $action = null)

Регистрация нового маршрута GET в маршрутизаторе.

Parameters

string $uri
Closure|array|string|callable $action

Return Value

Route

Route post(string $uri, Closure|array|string|callable $action = null)

Регистрация нового маршрута POST в маршрутизаторе.

Parameters

string $uri
Closure|array|string|callable $action

Return Value

Route

Route put(string $uri, Closure|array|string|callable $action = null)

Регистрация нового маршрута PUT в маршрутизаторе.

Parameters

string $uri
Closure|array|string|callable $action

Return Value

Route

Route patch(string $uri, Closure|array|string|callable $action = null)

Регистрация нового маршрута PATCH в маршрутизаторе.

Parameters

string $uri
Closure|array|string|callable $action

Return Value

Route

Route delete(string $uri, Closure|array|string|callable $action = null)

Регистрация нового маршрута DELETE в маршрутизаторе.

Parameters

string $uri
Closure|array|string|callable $action

Return Value

Route

Route options(string $uri, Closure|array|string|callable $action = null)

Регистрация нового маршрута OPTIONS в маршрутизаторе.

Parameters

string $uri
Closure|array|string|callable $action

Return Value

Route

Route any(string $uri, Closure|array|string|callable|null $action = null)

Регистрация нового маршрута, отвечающего на все глаголы.

Параметры

string $uri
Closure|array|string|callable|null $action

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

Route

Route fallback(Closure|array|string|callable|null $action)

Регистрация нового маршрута по умолчанию с маршрутизатором.

Параметры

Closure|array|string|callable|null $action

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

Route

Route redirect(string $uri, string $destination, int $status = 302)

Создание перенаправления с одного URI на другой.

Параметры

string $uri
string $destination
int $status

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

Route

Route permanentRedirect(string $uri, string $destination)

Создание постоянного перенаправления с одного URI на другой.

Параметры

string $uri
string $destination

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

Route

Route view(string $uri, string $view, array $data = [])

Регистрация нового маршрута, возвращающего представление.

Параметры

string $uri
string $view
array $data

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

Route

Route match(array|string $methods, string $uri, Closure|array|string|callable $action = null)

Регистрация нового маршрута с заданными глаголами.

Параметры

array|string $methods
string $uri
Closure|array|string|callable $action

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

Route

void resources(array $resources, array $options = [])

Регистрация массива контроллеров ресурсов.

Параметры

array $resources
array $options

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

void

PendingResourceRegistration resource(string $name, string $controller, array $options = [])

Маршрутизация ресурса к контроллеру.

Параметры

string $name
string $controller
array $options

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

PendingResourceRegistration

void apiResources(array $resources, array $options = [])

Регистрация массива контроллеров API-ресурсов.

Параметры

array $resources
array $options

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

void

PendingResourceRegistration apiResource(string $name, string $controller, array $options = [])

Маршрутизация API-ресурса к контроллеру.

Параметры

string $name
string $controller
array $options

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

PendingResourceRegistration

void group(array $attributes, Closure|string $routes)

Создание группы маршрутов со связанными атрибутами.

Параметры

array $attributes
Closure|string $routes

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

void

protected void updateGroupStack(array $attributes)

Обновление стека групп заданными атрибутами.

Параметры

array $attributes

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

void

array mergeWithLastGroup(array $new)

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

Параметры

array $new

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

array

protected void loadRoutes(Closure|string $routes)

Загрузка предоставленных маршрутов.

Параметры

Closure|string $routes

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

void

string getLastGroupPrefix()

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

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

string

Route addRoute(array|string $methods, string $uri, Closure|array|string|callable|null $action)

Добавление маршрута в базовый набор маршрутов.

Параметры

array|string $methods
string $uri
Closure|array|string|callable|null $action

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

Route
END_OF_DOCUMENT_MARKER

protected Маршрут createRoute(array|string $methods, string $uri, mixed $action)

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

Параметры

array|string $methods
string $uri
mixed $action

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

Маршрут

protected bool actionReferencesController(array $action)

Определить, ссылается ли действие на контроллер.

Параметры

array $action

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

bool

protected array convertToControllerAction(array|string $action)

Добавить действие маршрута, основанное на контроллере, в массив действий.

Параметры

array|string $action

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

array

protected string prependGroupNamespace(string $class)

Добавить последний групповой псевдоним к классу.

Параметры

string $class

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

string

protected Маршрут newRoute(array|string $methods, string $uri, mixed $action)

Создать новый объект маршрута.

Параметры

array|string $methods
string $uri
mixed $action

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

Маршрут

protected string prefix(string $uri)

Добавить префикс к URI.

Параметры

string $uri

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

string

protected Маршрут addWhereClausesToRoute(Маршрут $route)

Добавить необходимые условия where к маршруту на основе его первоначальной регистрации.

Параметры

Маршрут $route

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

Маршрут

protected void mergeGroupAttributesIntoRoute(Маршрут $route)

Объединить групповые атрибуты со страницей контроллера.

Параметры

Маршрут $route

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

void

Ответ|ОтветJSON respondWithRoute(string $name)

Возвратить ответ, возвращенный данным маршрутом.

Параметры

string $name

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

Ответ|ОтветJSON

Ответ|ОтветJSON dispatch(Запрос $request)

Отправить запрос в приложение.

Параметры

Запрос $request

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

Ответ|ОтветJSON

Ответ|ОтветJSON dispatchToRoute(Запрос $request)

Отправить запрос на маршрут и вернуть ответ.

Параметры

Запрос $request

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

Ответ|ОтветJSON

protected Маршрут findRoute(Запрос $request)

Найти маршрут, соответствующий данному запросу.

Параметры

Запрос $request

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

Маршрут

protected Ответ|ОтветJSON runRoute(Запрос $request, Маршрут $route)

Возвратить ответ для данного маршрута.

Параметры

Запрос $request
Маршрут $route

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

Ответ|ОтветJSON

protected mixed runRouteWithinStack(Маршрут $route, Запрос $request)

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

Параметры

Маршрут $route
Запрос $request

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

mixed

array gatherRouteMiddleware(Маршрут $route)

Собрать middleware для данного маршрута с разрешенными именами классов.

Параметры

Маршрут $route

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

array

protected array sortMiddleware(Коллекция $middlewares)

Отсортировать middleware по приоритету.

Параметры

Коллекция $middlewares

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

array

Response|JsonResponse prepareResponse(Request $request, mixed $response)

Создать экземпляр ответа из заданного значения.

Параметры

Request $request
mixed $response

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

Response|JsonResponse

static Response|JsonResponse toResponse(Request $request, mixed $response)

Статический вариант prepareResponse.

Параметры

Request $request
mixed $response

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

Response|JsonResponse

Route substituteBindings(Route $route)

Заменить привязки маршрута на маршрут.

Параметры

Route $route

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

Route

Исключения

ModelNotFoundException

void substituteImplicitBindings(Route $route)

Заменить неявные привязки модели Eloquent для маршрута.

Параметры

Route $route

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

void

Исключения

ModelNotFoundException

protected mixed performBinding(string $key, string $value, Route $route)

Вызвать обратный вызов привязки для заданного ключа.

Параметры

string $key
string $value
Route $route

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

mixed

Исключения

ModelNotFoundException

void matched(string|callable $callback)

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

Параметры

string|callable $callback

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

void

array getMiddleware()

Получить все определенные имена middleware в сокращенном формате.

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

array

$this aliasMiddleware(string $name, string $class)

Зарегистрировать сокращенное имя middleware.

Параметры

string $name
string $class

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

$this

bool hasMiddlewareGroup(string $name)

Проверить, существует ли middlewareGroup с данным именем.

Параметры

string $name

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

bool

array getMiddlewareGroups()

Получить все определенные группы middleware.

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

array

$this middlewareGroup(string $name, array $middleware)

Зарегистрировать группу middleware.

Параметры

string $name
array $middleware

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

$this

$this prependMiddlewareToGroup(string $group, string $middleware)

Добавить middleware в начало группы middleware.

Если middleware уже находится в группе, он не будет добавлен повторно.

Параметры

string $group
string $middleware

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

$this

$this pushMiddlewareToGroup(string $group, string $middleware)

Добавить middleware в конец группы middleware.

Если middleware уже находится в группе, он не будет добавлен повторно.

Параметры

string $group
string $middleware

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

$this

void bind(string $key, string|callable $binder)

Добавить новый привязыватель параметров маршрута.

Параметры

string $key
string|callable $binder

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

void

void model(string $key, string $class, Closure $callback = null)

Зарегистрировать привязыватель модели для подстановки.

Параметры

string $key
string $class
Closure $callback

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

void

Closure getBindingCallback(string $key)

Получить обратный вызов привязки для заданной привязки.

Параметры

string $key

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

Closure

array getPatterns()

Получить глобальные шаблоны "where".

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

array

void pattern(string $key, string $pattern)

Установить глобальный шаблон where для всех маршрутов.

Параметры

string $key
string $pattern

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

void

void patterns(array $patterns)

Установить группу глобальных шаблонов для всех маршрутов.

Параметры

Массив $patterns

Значение возврата

void

bool hasGroupStack()

Определить, есть ли в настоящее время стек групп маршрутизации.

Значение возврата

bool

array getGroupStack()

Получить текущий стек групп маршрутизации.

Значение возврата

Массив

mixed input(string $key, string|null $default = null)

Получить параметр маршрута для текущего маршрута.

Параметры

Строка $key
Строка|null $default

Значение возврата

mixed

Request getCurrentRequest()

Получить запрос, который в настоящее время обрабатывается.

Значение возврата

Request

Route getCurrentRoute()

Получить текущую обработанную инстанцию маршрута.

Значение возврата

Route

Route|null current()

Получить текущую обработанную инстанцию маршрута.

Значение возврата

Route|null

bool has(string $name)

Проверить, существует ли маршрут с заданным именем.

Параметры

Строка $name

Значение возврата

bool

string|null currentRouteName()

Получить имя текущего маршрута.

Значение возврата

Строка|null

bool is(mixed ...$patterns)

Псевдоним метода «currentRouteNamed».

Параметры

mixed ...$patterns

Значение возврата

bool

bool currentRouteNamed(mixed ...$patterns)

Определить, соответствует ли текущий маршрут шаблону.

Параметры

mixed ...$patterns

Значение возврата

bool

string|null currentRouteAction()

Получить действие текущего маршрута.

Значение возврата

Строка|null

bool uses(array ...$patterns)

Псевдоним метода «currentRouteUses».

Параметры

Массив ...$patterns

Значение возврата

bool

bool currentRouteUses(string $action)

Определить, соответствует ли действие текущего маршрута заданному действию.

Параметры

Строка $action

Значение возврата

bool

void auth(array $options = [])

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

Параметры

Массив $options

Значение возврата

void

void resetPassword()

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

Значение возврата

void

void emailVerification()

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

Значение возврата

void

void singularResourceParameters(bool $singular = true)

Установить параметры глобальных ресурсов без сопоставления в единственном числе.

Параметры

bool $singular

Значение возврата

void

void resourceParameters(array $parameters = [])

Установить сопоставление глобальных параметров ресурсов.

Параметры

Массив $parameters

Значение возврата

void

array|null resourceVerbs(array $verbs = [])

Получить или установить глаголы, используемые в URI ресурсов.

Параметры

Массив $verbs

Значение возврата

Массив|null

RouteCollection getRoutes()

Получить базовую коллекцию маршрутов.

Значение возврата

RouteCollection

void setRoutes(RouteCollection $routes)

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

Параметры

RouteCollection $routes

Значение возврата

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.8/Illuminate/Routing/Router.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API