Маршрут
класс Маршрут (Просмотреть исходный код)
Трейты
| RouteDependencyResolverTrait |
Свойства
| protected string | $uri | Шаблон URI, к которому реагирует маршрут. | |
| protected array | $methods | HTTP-методы, к которым реагирует маршрут. | |
| protected array | $action | Массив действия маршрута. | |
| protected mixed | $controller | Экземпляр контроллера. | |
| protected array | $defaults | Значения по умолчанию для маршрута. | |
| protected array | $wheres | Требования к регулярному выражению. | |
| protected array | $parameters | Массив сопоставленных параметров. | |
| protected array|null | $parameterNames | Имена параметров для маршрута. | |
| protected CompiledRoute | $compiled | Компилированная версия маршрута. | |
| protected Router | $router | Экземпляр маршрутизатора, используемый маршрутом. | |
| protected Container | $container | Экземпляр контейнера, используемый маршрутом. | |
| static array | $validators | Вадидаторы, используемые маршрутами. |
Методы
| mixed | callWithDependencies(object $instance, string $method) Вызов метода класса с разрешёнными зависимостями. | from RouteDependencyResolverTrait |
| array | resolveClassMethodDependencies(array $parameters, object $instance, string $method) Разрешение зависимостей с типизированными указаниями для метода объекта. | from RouteDependencyResolverTrait |
| array | resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector) Разрешение зависимостей с типизированными указаниями для заданного метода. | from RouteDependencyResolverTrait |
| mixed | transformDependency(ReflectionParameter $parameter, array $parameters, array $originalParameters) Попытка преобразовать заданный параметр в экземпляр класса. | from RouteDependencyResolverTrait |
| bool | alreadyInParameters(string $class, array $parameters) Определение наличия объекта заданного класса в списке параметров. | from RouteDependencyResolverTrait |
| void | spliceIntoParameters(array $parameters, string $key, mixed $instance) Вставка заданного значения в список параметров. | from RouteDependencyResolverTrait |
| void | __construct(array|string $methods, string $uri, Closure|array $action) Создание нового экземпляра маршрута. | |
| mixed | run(Request $request) Запуск действия маршрута и возврат ответа. | |
| bool | isControllerAction() Проверка, является ли действие маршрута контроллером. | |
| mixed | runCallable() Запуск действия маршрута и возврат ответа. | |
| mixed | runController() Запуск действия маршрута и возврат ответа. | |
| mixed | getController() Получение экземпляра контроллера для маршрута. | |
| string | getControllerMethod() Получение метода контроллера, используемого для маршрута. | |
| bool | matches(Request $request, bool $includingMethod = true) Определение соответствия маршрута заданному запросу. | |
| void | compileRoute() Компиляция маршрута в экземпляр Symfony CompiledRoute. | |
| array | extractOptionalParameters() Получение необязательных параметров для маршрута. | |
| array | gatherMiddleware() Получение всего middleware, включая middleware из контроллера. | |
| $this|array | middleware(array|string|null $middleware = null) Получение или установка middleware, прикрепленных к маршруту. | |
| array | controllerMiddleware() Получение middleware для контроллера маршрута. | |
| array | signatureParameters(string|null $subClass = null) Получение параметров, перечисленных в сигнатуре маршрута/контроллера. | |
| bool | hasParameters() Определение наличия параметров у маршрута. | |
| bool | hasParameter(string $name) Определение существования заданного параметра в маршруте. | |
| string|object | getParameter(string $name, mixed $default = null) Получение заданного параметра из маршрута. | |
| string|object | parameter(string $name, mixed $default = null) Получение заданного параметра из маршрута. | |
| void | setParameter(string $name, mixed $value) Установка параметра с заданным значением. | |
| void | forgetParameter(string $name) Удаление параметра из маршрута, если он задан. | |
| array | parameters() Получение списка параметров маршрута (ключ/значение). | |
| array | parametersWithoutNulls() Получение списка параметров маршрута без нулевых значений. | |
| array | parameterNames() Получение всех имён параметров маршрута. | |
| array | compileParameterNames() Получение имён параметров маршрута. | |
| $this | bind(Request $request) Связывание маршрута с заданным запросом для выполнения. | |
| array | bindParameters(Request $request) Извлечение списка параметров из запроса. | |
| array | bindPathParameters(Request $request) Получение соответствий параметров для части пути URI. | |
| array | bindHostParameters(Request $request, array $parameters) Извлечение списка параметров из хостовой части запроса. | |
| array | matchToKeys(array $matches) Объединение набора соответствий параметров с ключами маршрута. | |
| array | replaceDefaults(array $parameters) Замена нулевых параметров на их значения по умолчанию. | |
| array | parseAction(callable|array|null $action) Разбор действия маршрута в стандартный массив. | |
| callable | findCallable(array $action) Поиск вызываемого объекта в массиве действий. | |
| string | makeInvokableAction(string $action) Создание действия для вызываемого контроллера. | |
| static array | getValidators() Получение валидаторов маршрута для экземпляра. |
| $this | defaults(string $key, mixed $value) Установить значение по умолчанию для маршрута. | |
| $this | where(array|string $name, string $expression = null) Установить требование регулярного выражения для маршрута. | |
| array | parseWhere(array|string $name, string $expression) Разбор аргументов метода where в массив. | |
| $this | whereArray(array $wheres) Установить список требований регулярных выражений для маршрута. | |
| $this | prefix(string $prefix) Добавить префикс к URI маршрута. | |
| string | getPath() Получить URI, связанный с маршрутом. | |
| string | uri() Получить URI, связанный с маршрутом. | |
| array | getMethods() Получить HTTP-глаголы, на которые реагирует маршрут. | |
| array | methods() Получить HTTP-глаголы, на которые реагирует маршрут. | |
| bool | httpOnly() Определить, реагирует ли маршрут только на HTTP-запросы. | |
| bool | httpsOnly() Определить, реагирует ли маршрут только на HTTPS-запросы. | |
| bool | secure() Определить, реагирует ли маршрут только на HTTPS-запросы. | |
| string|null | domain() Получить домен, определённый для маршрута. | |
| string | getUri() Получить URI, на который отвечает маршрут. | |
| $this | setUri(string $uri) Установить URI, на который отвечает маршрут. | |
| string | getPrefix() Получить префикс экземпляра маршрута. | |
| string | getName() Получить имя экземпляра маршрута. | |
| $this | name(string $name) Добавить или изменить имя маршрута. | |
| $this | uses(Closure|string $action) Установить обработчик для маршрута. | |
| string | addGroupNamespaceToStringUses(string $action) Разбор строки действия для флюэнт-метода "uses". | |
| string | getActionName() Получить имя действия для маршрута. | |
| array | getAction() Получить массив действий для маршрута. | |
| $this | setAction(array $action) Установить массив действий для маршрута. | |
| CompiledRoute | getCompiled() Получить скомпилированную версию маршрута. | |
| $this | setRouter(Router $router) Установить экземпляр маршрутизатора для маршрута. | |
| $this | setContainer(Container $container) Установить экземпляр контейнера для маршрута. | |
| void | prepareForSerialization() Подготовить экземпляр маршрута для сериализации. | |
| mixed | __get(string $key) Динамический доступ к параметрам маршрута. |
Подробности
protected mixed callWithDependencies(object $instance, string $method)
Вызов метода класса с разрешёнными зависимостями.
protected array resolveClassMethodDependencies(array $parameters, object $instance, string $method)
Разрешение зависимостей типа объекта для метода.
array resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector)
Разрешение зависимостей метода с указанием типов.
protected mixed transformDependency(ReflectionParameter $parameter, array $parameters, array $originalParameters)
Попытка преобразовать данный параметр в экземпляр класса.
protected bool alreadyInParameters(string $class, array $parameters)
Определить, присутствует ли объект данного класса в списке параметров.
protected void spliceIntoParameters(array $parameters, string $key, mixed $instance)
Вставить данное значение в список параметров.
void __construct(array|string $methods, string $uri, Closure|array $action)
Создать новый экземпляр Route.
mixed run(Request $request)
Выполнить действие маршрута и вернуть ответ.
protected bool isControllerAction()
Проверяет, является ли действие маршрута контроллером.
protected mixed runCallable()
Выполнить действие маршрута и вернуть ответ.
protected mixed runController()
Выполнить действие маршрута и вернуть ответ.
mixed getController()
Получить экземпляр контроллера для маршрута.
protected string getControllerMethod()
Получить метод контроллера, используемый для маршрута.
bool matches(Request $request, bool $includingMethod = true)
Определить, соответствует ли маршрут заданному запросу.
protected void compileRoute()
Скомпилировать маршрут в экземпляр Symfony CompiledRoute.
protected array extractOptionalParameters()
Получить необязательные параметры для маршрута.
array gatherMiddleware()
Получить все middleware, включая те, что из контроллера.
$this|array middleware(array|string|null $middleware = null)
Получить или установить middleware, прикрепленные к маршруту.
array controllerMiddleware()
Получить middleware для контроллера маршрута.
array signatureParameters(string|null $subClass = null)
Получить параметры, указанные в сигнатуре маршрута/контроллера.
bool hasParameters()
Определить, содержит ли маршрут параметры.
bool hasParameter(string $name)
Определить, существует ли заданный параметр в маршруте.
string|object getParameter(string $name, mixed $default = null)
Получить заданный параметр из маршрута.
string|object parameter(string $name, mixed $default = null)
Получить заданный параметр из маршрута.
void setParameter(string $name, mixed $value)
Установить параметр с заданным значением.
void forgetParameter(string $name)
Удалить параметр из маршрута, если он установлен.
array parameters()
Получить список параметров маршрута.
array parametersWithoutNulls()
Получить список параметров маршрута без нулевых значений.
array parameterNames()
Получить все имена параметров маршрута.
protected array compileParameterNames()
Получить имена параметров для маршрута.
$this bind(Request $request)
Связать маршрут с заданным запросом для выполнения.
массив bindParameters(Запрос $request)
Извлечь список параметров из запроса.
protected массив bindPathParameters(Запрос $request)
Получить соответствия параметров для части пути URI.
protected массив bindHostParameters(Запрос $request, массив $parameters)
Извлечь список параметров из части хоста запроса.
protected массив matchToKeys(массив $matches)
Объединить набор соответствий параметров с ключами маршрута.
protected массив replaceDefaults(массив $parameters)
Заменить параметры со значением null на их значения по умолчанию.
protected массив parseAction(вызываемый|массив|null $action)
Разбор действия маршрута в стандартный массив.
protected вызываемый findCallable(массив $action)
Найти вызываемый элемент в массиве действий.
protected строка makeInvokableAction(строка $action)
Создание действия для вызываемого контроллера.
static массив getValidators()
Получить валидаторы маршрута для экземпляра.
$this defaults(строка $key, смешанный $value)
Установить значение по умолчанию для маршрута.
$this where(массив|строка $name, строка $expression = null)
Установить требование по регулярному выражению для маршрута.
protected массив parseWhere(массив|строка $name, строка $expression)
Разбор аргументов метода where в массив.
protected $this whereArray(массив $wheres)
Установить список требований по регулярным выражениям для маршрута.
$this prefix(строка $prefix)
Добавить префикс к URI маршрута.
строка getPath()
Получить URI, связанный с маршрутом.
строка uri()
Получить URI, связанный с маршрутом.
массив getMethods()
Получить HTTP-глаголы, к которым реагирует маршрут.
массив methods()
Получить HTTP-глаголы, к которым реагирует маршрут.
булево httpOnly()
Определить, отвечает ли маршрут только на HTTP-запросы.
булево httpsOnly()
Определить, отвечает ли маршрут только на HTTPS-запросы.
булево secure()
Определить, отвечает ли маршрут только на HTTPS-запросы.
строка|null domain()
Получить домен, определённый для маршрута.
строка getUri()
Получить URI, к которому реагирует маршрут.
$this setUri(строка $uri)
Установить URI, к которому реагирует маршрут.
строка getPrefix()
Получить префикс экземпляра маршрута.
строка getName()
Получить имя экземпляра маршрута.
$this name(string $name)
Добавить или изменить имя маршрута.
$this uses(Closure|строка $action)
Установить обработчик для маршрута.
protected строка addGroupNamespaceToStringUses(строка $action)
Разбор строкового действия для флуэнт-метода "uses".
строка getActionName()
Получить имя действия для маршрута.
массив getAction()
Получить массив действий для маршрута.
$this setAction(массив $action)
Установить массив действий для маршрута.
CompiledRoute getCompiled()
Получить скомпилированную версию маршрута.
$this setRouter(Router $router)
Установить экземпляр маршрутизатора для маршрута.
$this setContainer(Container $container)
Установить экземпляр контейнера для маршрута.
пустое значение prepareForSerialization()
Подготовить экземпляр маршрута для сериализации.
смешанный тип __get(строка $key)
Динамический доступ к параметрам маршрута.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Routing/Route.html
