RouteCollectionBuilder
class RouteCollectionBuilder
Помогает добавлять и импортировать маршруты в RouteCollection.
Methods
| __construct(LoaderInterface $loader = null) | ||
| RouteCollectionBuilder | import(mixed $resource, string|null $prefix = '/', string $type = null) Импортирует внешний ресурс маршрутизации и возвращает RouteCollectionBuilder. | |
| Route | add(string $path, string $controller, string|null $name = null) Добавляет маршрут и возвращает его для дальнейшей модификации. | |
| RouteCollectionBuilder | createBuilder() Возвращает RouteCollectionBuilder, который можно настроить и затем добавить с помощью mount(). | |
| mount(string $prefix, RouteCollectionBuilder $builder) Добавляет RouteCollectionBuilder. | ||
| $this | addRoute(Route $route, string|null $name = null) Добавляет объект Route в билдер. | |
| $this | setHost(string $pattern) Устанавливает хост для всех вложенных маршрутов (если он еще не установлен). | |
| $this | setCondition(string $condition) Устанавливает условие для всех вложенных маршрутов (если оно еще не установлено). | |
| $this | setDefault(string $key, mixed $value) Устанавливает значение по умолчанию, которое будет добавлено ко всем вложенным маршрутам (если это значение по умолчанию еще не установлено). | |
| $this | setRequirement(string $key, mixed $regex) Устанавливает требование, которое будет добавлено ко всем вложенным маршрутам (если это требование еще не установлено). | |
| $this | setOption(string $key, mixed $value) Устанавливает опцию, которая будет добавлена ко всем вложенным маршрутам (если эта опция еще не установлена). | |
| $this | setSchemes(array|string $schemes) Устанавливает схемы для всех вложенных маршрутов (если они еще не установлены). | |
| $this | setMethods(array|string $methods) Устанавливает методы для всех вложенных маршрутов (если они еще не установлены). | |
| RouteCollection | build() Создает окончательную RouteCollection и возвращает ее. |
Details
__construct(LoaderInterface $loader = null)
Parameters
| LoaderInterface | $loader |
RouteCollectionBuilder import(mixed $resource, string|null $prefix = '/', string $type = null)
Импортирует внешний ресурс маршрутизации и возвращает RouteCollectionBuilder.
$routes->import('blog.yml', '/blog');
Parameters
| mixed | $resource | |
| string|null | $prefix | |
| string | $type |
Return Value
| RouteCollectionBuilder |
Exceptions
| FileLoaderLoadException |
Route add(string $path, string $controller, string|null $name = null)
Добавляет маршрут и возвращает его для дальнейшей модификации.
Parameters
| string | $path | Путь маршрута |
| string | $controller | Контроллер маршрута |
| string|null | $name | Имя маршрута |
Return Value
| Route |
RouteCollectionBuilder createBuilder()
Возвращает RouteCollectionBuilder, который можно настроить и затем добавить с помощью mount().
Return Value
| RouteCollectionBuilder |
mount(string $prefix, RouteCollectionBuilder $builder)
Добавляет RouteCollectionBuilder.
Parameters
| string | $prefix | |
| RouteCollectionBuilder | $builder |
$this addRoute(Route $route, string|null $name = null)
Добавляет объект Route в билдер.
Parameters
| Route | $route | |
| string|null | $name |
Return Value
| $this |
$this setHost(string $pattern)
Устанавливает хост для всех вложенных маршрутов (если он еще не установлен).
Parameters
| string | $pattern |
Return Value
| $this |
$this setCondition(string $condition)
Устанавливает условие для всех вложенных маршрутов (если оно еще не установлено).
Parameters
| string | $condition |
Return Value
| $this |
$this setDefault(string $key, mixed $value)
Устанавливает значение по умолчанию, которое будет добавлено ко всем вложенным маршрутам (если это значение по умолчанию еще не установлено).
Parameters
| string | $key | |
| mixed | $value |
Return Value
| $this |
$this setRequirement(string $key, mixed $regex)
Устанавливает требование, которое будет добавлено ко всем вложенным маршрутам (если это требование еще не установлено).
Parameters
| string | $key | |
| mixed | $regex |
Return Value
| $this |
$this setOption(string $key, mixed $value)
Устанавливает опцию, которая будет добавлена ко всем вложенным маршрутам (если эта опция еще не установлена).
Parameters
| string | $key | |
| mixed | $value |
Return Value
| $this |
$this setSchemes(array|string $schemes)
Устанавливает схемы для всех вложенных маршрутов (если они еще не установлены).
Parameters
| array|string | $schemes |
Return Value
| $this |
$this setMethods(array|string $methods)
Устанавливает методы для всех вложенных маршрутов (если они еще не установлены).
Parameters
| array|string | $methods |
Return Value
| $this |
RouteCollection build()
Создает окончательную RouteCollection и возвращает ее.
Return Value
| RouteCollection |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.3/Symfony/Component/Routing/RouteCollectionBuilder.html