Spec-Zone.ru › Laravel 5.5

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

класс Маршрутизатор реализует Регистратор, РегистраторСвязей (Просмотреть исходный код)

Трейты

Макрообъект

Свойства

статический защищенный массив $macros Зарегистрированные строковые макросы. из Макрообъект
защищенный ДиспечерСобытий $events Экземпляр диспечера событий.
защищенный Контейнер $container Экземпляр контейнера IoC.
защищенный КоллекцияМаршрутов $routes Экземпляр коллекции маршрутов.
защищенный Маршрут $current Текущий обработанный экземпляр маршрута.
защищенный Запрос $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)

Смешать другой объект в класс.

 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 $action = null)

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

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

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

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

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

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

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

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

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

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

Зарегистрировать новый маршрут с заданными глаголами.
void resources(array $resources)

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

Назначить ресурс контроллеру.
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|null $action)

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

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

Определить, ссылается ли действие на контроллер.
array convertToControllerAction(array|string $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)

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

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

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

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

Найти маршрут, соответствующий заданному запросу.
mixed 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)

Вызвать обработчик привязки для данного ключа.
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)

Зарегистрировать binder модели для подстановки значений.
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 $default = null)

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

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

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

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

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

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

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

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

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

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

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

Зарегистрировать типичные маршруты авторизации для приложения.
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)

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

Параметры

string $name
object|callable $macro

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

void

static void mixin(object $mixin)

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

Параметры

object $mixin

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

void

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

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

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

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

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

Параметры

Dispatcher $events
Container $container

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

void

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

Зарегистрировать новый маршрут GET в маршрутизаторе.

Параметры

string $uri
Closure|array|string $action

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

Route

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

Зарегистрировать новый маршрут POST в маршрутизаторе.

Параметры

string $uri
Closure|array|string $action

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

Route

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

Зарегистрировать новый маршрут PUT в маршрутизаторе.

Параметры

string $uri
Closure|array|string $action

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

Route

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

Зарегистрировать новый маршрут PATCH в маршрутизаторе.

Параметры

string $uri
Closure|array|string $action

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

Route

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

Зарегистрировать новый маршрут DELETE в маршрутизаторе.

Параметры

string $uri
Closure|array|string $action

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

Route

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

Зарегистрировать новый маршрут OPTIONS в маршрутизаторе.

Параметры

string $uri
Closure|array|string $action

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

Route

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

Зарегистрировать маршрут, отвечающий на все типы запросов.

Параметры

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

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

Route

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

Зарегистрировать маршрут по умолчанию в маршрутизаторе.

Параметры

Closure|array|string|null $action

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

Route

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

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

Параметры

string $uri
string $destination
int $status

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

Route

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

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

Параметры

string $uri
string $view
array $data

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

Route

Маршрут match(array|string $methods, string $uri, Closure|array|string $action = null)

Зарегистрировать новый маршрут с заданными глаголами.

Параметры

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

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

Маршрут

void resources(array $resources)

Зарегистрировать массив контроллеров ресурсов.

Параметры

array $resources

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

void

Ожидающая регистрация ресурса resource(string $name, string $controller, array $options = [])

Направить ресурс в контроллер.

Параметры

string $name
string $controller
array $options

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

Ожидающая регистрация ресурса

Ожидающая регистрация ресурса apiResource(string $name, string $controller, array $options = [])

Направить API-ресурс в контроллер.

Параметры

string $name
string $controller
array $options

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

Ожидающая регистрация ресурса

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

protected Маршрут addRoute(array|string $methods, string $uri, Closure|array|string|null $action)

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

Параметры

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

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

Маршрут

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)

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

Параметры

array|string $action

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

array

protected string prependGroupNamespace(string $class)

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

Параметры

string $class

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

string

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

Создать новый объект Route.

Параметры

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

mixed respondWithRoute(string $name)

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

Parameters

string $name

Return Value

mixed

Response|JsonResponse dispatch(Request $request)

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

Parameters

Request $request

Return Value

Response|JsonResponse

mixed dispatchToRoute(Request $request)

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

Parameters

Request $request

Return Value

mixed

protected Route findRoute(Request $request)

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

Parameters

Request $request

Return Value

Route

protected mixed runRoute(Request $request, Route $route)

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

Parameters

Request $request
Route $route

Return Value

mixed

protected mixed runRouteWithinStack(Route $route, Request $request)

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

Parameters

Route $route
Request $request

Return Value

mixed

array gatherRouteMiddleware(Route $route)

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

Parameters

Route $route

Return Value

array

protected array sortMiddleware(Collection $middlewares)

Отсортировать заданные middleware по приоритету.

Parameters

Collection $middlewares

Return Value

array

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

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

Parameters

Request $request
mixed $response

Return Value

Response|JsonResponse

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

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

Parameters

Request $request
mixed $response

Return Value

Response|JsonResponse

Route substituteBindings(Route $route)

Подставить привязки маршрута в маршрут.

Parameters

Route $route

Return Value

Route

void substituteImplicitBindings(Route $route)

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

Parameters

Route $route

Return Value

void

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

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

Parameters

string $key
string $value
Route $route

Return Value

mixed

void matched(string|callable $callback)

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

Parameters

string|callable $callback

Return Value

void

array getMiddleware()

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

Return Value

array

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

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

Parameters

string $name
string $class

Return Value

$this

bool hasMiddlewareGroup(string $name)

Проверить наличие middlewareGroup с заданным именем.

Parameters

string $name

Return Value

bool

массив getMiddlewareGroups()

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

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

массив

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

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

Параметры

строка $name
массив $middleware

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

$this

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

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

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

Параметры

строка $group
строка $middleware

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

$this

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

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

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

Параметры

строка $group
строка $middleware

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

$this

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

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

Параметры

строка $key
строка|вызываемый объект $binder

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

void

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

Зарегистрировать связующий элемент модели для подстановки.

Параметры

строка $key
строка $class
Closure $callback

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

void

Исключения

ModelNotFoundException

Closure getBindingCallback(string $key)

Получить вызываемый объект для связи по заданному ключу.

Параметры

строка $key

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

Closure

массив getPatterns()

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

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

массив

void pattern(string $key, string $pattern)

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

Параметры

строка $key
строка $pattern

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

void

void patterns(array $patterns)

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

Параметры

массив $patterns

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

void

логическое значение hasGroupStack()

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

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

логическое значение

массив getGroupStack()

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

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

массив

смешанное значение input(string $key, string $default = null)

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

Параметры

строка $key
строка $default

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

смешанное значение

Запрос getCurrentRequest()

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

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

Запрос

Маршрут getCurrentRoute()

Получить экземпляр текущего обрабатываемого маршрута.

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

Маршрут

Маршрут current()

Получить экземпляр текущего обрабатываемого маршрута.

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

Маршрут

логическое значение has(string $name)

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

Параметры

строка $name

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

логическое значение

строка|null currentRouteName()

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

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

строка|null

логическое значение is(dynamic $patterns)

Псевдоним для метода "currentRouteNamed".

Параметры

динамический $patterns

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

логическое значение

логическое значение currentRouteNamed(dynamic $patterns)

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

Параметры

динамический $patterns

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

логическое значение

строка|null currentRouteAction()

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

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

строка|null

логическое значение uses(array $patterns)

Псевдоним для метода "currentRouteUses".

Параметры

массив $patterns

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

логическое значение

логическое значение currentRouteUses(string $action)

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

Параметры

строка $action

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

логическое значение

void auth()

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

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

void

void singularResourceParameters(bool $singular = true)

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

Параметры

bool $singular

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

void

void resourceParameters(array $parameters = [])

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

Параметры

array $parameters

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

void

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

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

Параметры

array $verbs

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

array|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.5/Illuminate/Routing/Router.html

Spec-Zone.ru

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