Маршрут
класс Route (Просмотреть исходный код)
Трейты
| RouteDependencyResolverTrait |
Свойства
| protected string | $uri | Шаблон URI, к которому отвечает маршрут. | |
| protected array | $methods | HTTP-методы, к которым отвечает маршрут. | |
| protected array | $action | Массив действий маршрута. | |
| protected array | $defaults | Значения по умолчанию для маршрута. | |
| protected array | $wheres | Требования к регулярным выражениям. | |
| protected array | $parameters | Массив сопоставленных параметров. | |
| protected array|null | $parameterNames | Имена параметров для маршрута. | |
| protected CompiledRoute | $compiled | Компилированная версия маршрута. | |
| 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 | vacantEloquentParameter(ReflectionClass $class, array $parameters) Определить, является ли указанный тип класса неявной привязкой Eloquent. | from RouteDependencyResolverTrait |
| mixed | extractModelIdentifier(ReflectionParameter $parameter, 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 $methods, string $uri, Closure|array $action) Создать новый экземпляр Route. | |
| mixed | run(Request $request) Запустить действие маршрута и вернуть ответ. | |
| mixed | runCallable(Request $request) Запустить действие маршрута и вернуть ответ. | |
| mixed | runController(Request $request) Запустить действие маршрута и вернуть ответ. | |
| bool | customDispatcherIsBound() Определить, связан ли пользовательский диспетчер маршрутов в контейнере. | |
| mixed | runWithCustomDispatcher(Request $request) Отправить запрос и маршрут в пользовательского диспетчера для обработки. | |
| bool | matches(Request $request, bool $includingMethod = true) Определить, соответствует ли маршрут заданному запросу. | |
| void | compileRoute() Скомпилировать маршрут в экземпляр Symfony CompiledRoute. | |
| array | extractOptionalParameters() Получить необязательные параметры для маршрута. | |
| $this|array | middleware(array|string|null $middleware = null) Получить или установить установленные для маршрута middleware. | |
| array | beforeFilters() deprecated Получить фильтры "before" для маршрута. | |
| array | afterFilters() deprecated Получить фильтры "after" для маршрута. | |
| static array | parseFilters(string $filters) deprecated Разделить строку фильтров. | |
| static array | explodeFilters(array|string $filters) Преобразовать фильтры в массив, если это не массив. | |
| static array | explodeArrayFilters(array $filters) Распаковать массив объявлений фильтров. | |
| static array | parseFilter(string $filter) deprecated Разделить заданный фильтр на имя и параметры. | |
| static array | parseParameterFilter(string $filter) Разделить фильтр с параметрами. | |
| 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) Извлечь список параметров из запроса. |
| массив | bindPathParameters(Request $request) Получить соответствия параметров для части пути URI. | |
| массив | bindHostParameters(Request $request, массив $parameters) Извлечь список параметров из хост-части запроса. | |
| массив | matchToKeys(массив $matches) Объединить набор соответствий параметров с ключами маршрута. | |
| массив | replaceDefaults(массив $parameters) Заменить нулевые параметры их значениями по умолчанию. | |
| массив | parseAction(вызываемый|массив $action) Разбор действия маршрута в стандартный массив. | |
| вызываемый | findCallable(массив $action) Найти вызываемый объект в массиве действий. | |
| статический массив | getValidators() Получить валидаторы маршрута для экземпляра. | |
| $this | before(строка $filters) deprecated Добавить фильтры перед маршрутом. | |
| $this | after(строка $filters) deprecated Добавить фильтры после маршрута. | |
| $this | addFilters(строка $type, строка $filters) Добавить заданные фильтры к маршруту по типу. | |
| $this | defaults(строка $key, смешанный $value) Установить значение по умолчанию для маршрута. | |
| $this | where(массив|строка $name, строка $expression = null) Установить требование регулярного выражения для маршрута. | |
| массив | parseWhere(массив|строка $name, строка $expression) Разбор аргументов метода where в массив. | |
| $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, на который реагирует маршрут. | |
| Route | setUri(строка $uri) Установить URI, на который реагирует маршрут. | |
| строка | getPrefix() Получить префикс экземпляра маршрута. | |
| строка | getName() Получить имя экземпляра маршрута. | |
| $this | name(строка $name) Добавить или изменить имя маршрута. | |
| строка | getActionName() Получить имя действия для маршрута. | |
| массив | getAction() Получить массив действий для маршрута. | |
| $this | setAction(массив $action) Установить массив действий для маршрута. | |
| CompiledRoute | getCompiled() Получить скомпилированную версию маршрута. | |
| $this | setContainer(Container $container) Установить экземпляр контейнера для маршрута. | |
| void | prepareForSerialization() Подготовить экземпляр маршрута для сериализации. | |
| смешанный | __get(строка $key) Динамический доступ к параметрам маршрута. |
Подробности
protected смешанный callWithDependencies(объект $instance, строка $method)
Вызов метода класса с разрешенными зависимостями.
protected массив resolveClassMethodDependencies(массив $parameters, объект $instance, строка $method)
Разрешить зависимости метода класса с указанием типов.
массив resolveMethodDependencies(массив $parameters, ReflectionFunctionAbstract $reflector)
Разрешить зависимости данного метода с указанием типов.
protected смешанный transformDependency(ReflectionParameter $parameter, массив $parameters, массив $originalParameters)
Попытка преобразовать данный параметр в экземпляр класса.
protected bool vacantEloquentParameter(ReflectionClass $class, array $parameters)
Определить, является ли указанный тип класса неявной привязкой Eloquent.
Не должно быть уже разрешено в списке параметров явной привязкой модели.
protected mixed extractModelIdentifier(ReflectionParameter $parameter, array $originalParameters)
Извлечь ключ неявной привязки модели из списка параметров.
protected bool alreadyInParameters(string $class, array $parameters)
Определить, присутствует ли объект данного класса в списке параметров.
protected void spliceIntoParameters(array $parameters, string $key, mixed $instance)
Вставить заданное значение в список параметров.
void __construct(array $methods, string $uri, Closure|array $action)
Создать новый экземпляр Route.
mixed run(Request $request)
Выполнить действие маршрута и вернуть ответ.
protected mixed runCallable(Request $request)
Выполнить действие маршрута и вернуть ответ.
protected mixed runController(Request $request)
Выполнить действие маршрута и вернуть ответ.
protected bool customDispatcherIsBound()
Определить, связана ли в контейнере пользовательская диспетчерская служба маршрутов.
protected mixed runWithCustomDispatcher(Request $request)
Отправить запрос и маршрут для обработки пользовательскому диспетчеру.
bool matches(Request $request, bool $includingMethod = true)
Определить, соответствует ли маршрут данному запросу.
protected void compileRoute()
Скомпилировать маршрут в экземпляр Symfony CompiledRoute.
protected array extractOptionalParameters()
Получить необязательные параметры для маршрута.
$this|array middleware(array|string|null $middleware = null)
Получить или установить установленные для маршрута фильтры.
array beforeFilters() deprecated
deprecated
Получить фильтры «до» для маршрута.
array afterFilters() deprecated
deprecated
Получить фильтры «после» для маршрута.
static array parseFilters(string $filters) deprecated
deprecated
Обработать строку фильтров.
static protected array explodeFilters(array|string $filters)
Преобразовать фильтры в массив, если это не массив.
static protected array explodeArrayFilters(array $filters)
Распаковать массив объявлений фильтров.
static array parseFilter(string $filter) deprecated
deprecated
Разбирает заданный фильтр на имя и параметры.
static protected array parseParameterFilter(string $filter)
Разбирает фильтр с параметрами.
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)
Привязывает маршрут к заданному запросу для выполнения.
array bindParameters(Request $request)
Извлекает список параметров из запроса.
protected array bindPathParameters(Request $request)
Получает соответствия параметров для части пути URI.
protected array bindHostParameters(Request $request, array $parameters)
Извлекает список параметров из части хоста запроса.
protected array matchToKeys(array $matches)
Объединяет набор соответствий параметров с ключами маршрута.
protected array replaceDefaults(array $parameters)
Заменяет нулевые параметры их значениями по умолчанию.
protected array parseAction(callable|array $action)
Разбирает действие маршрута в стандартный массив.
protected callable findCallable(array $action)
Находит вызываемый элемент в массиве действий.
static array getValidators()
Получает валидаторы маршрута для экземпляра.
$this before(string $filters) deprecated
deprecated
Добавляет фильтры перед маршрутом.
$this after(string $filters) deprecated
deprecated
Добавить фильтры после маршрута.
protected $this addFilters(string $type, string $filters)
Добавить указанные фильтры в маршрут по типу.
$this defaults(string $key, mixed $value)
Установить значение по умолчанию для маршрута.
$this where(array|string $name, string $expression = null)
Установить требование регулярного выражения для маршрута.
protected array parseWhere(array|string $name, string $expression)
Разбор аргументов метода where в массив.
protected $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, на который отвечает маршрут.
Route setUri(string $uri)
Установить URI, на который отвечает маршрут.
string getPrefix()
Получить префикс экземпляра маршрута.
string getName()
Получить имя экземпляра маршрута.
$this name(string $name)
Добавить или изменить имя маршрута.
string getActionName()
Получить имя действия для маршрута.
array getAction()
Получить массив действий для маршрута.
$this setAction(array $action)
Установить массив действий для маршрута.
CompiledRoute getCompiled()
Получить скомпилированную версию маршрута.
$this setContainer(Container $container)
Установить экземпляр контейнера для маршрута.
void prepareForSerialization()
Подготовить экземпляр маршрута для сериализации.
mixed __get(string $key)
Динамический доступ к параметрам маршрута.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.1/Illuminate/Routing/Route.html
