Класс RouteBuilder

__construct()source public

__construct( Cake\Routing\RouteCollection $collection , string $path , array $params [] , array $options [] )

Конструктор

Параметры

• routeClass - Класс маршрута по умолчанию, используемый при добавлении маршрутов.
• extensions - Расширения для подключения при добавлении маршрутов.
• namePrefix - Префикс, добавляемый ко всем именам маршрутов.

Параметры

Cake\Routing\RouteCollection $collection

Коллекция маршрутов, в которую следует добавлять маршруты.

string $path

Префикс пути области.

array $params optional []

Параметры маршрутизации области.

array $options optional []

Список параметров.

_makeRoute()source protected

_makeRoute( string|Cake\Routing\Route\Route $route , array $defaults , array $options )

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

Параметры

string|Cake\Routing\Route\Route $route

Шаблон маршрута или объект маршрута.

array $defaults

Параметры по умолчанию.

array $options

Дополнительные параметры.

Возвращает

Cake\Routing\Route\Route

Исключения

InvalidArgumentException
при некорректном классе или объекте маршрута.
BadMethodCallException
при конфликте создаваемого маршрута с текущей областью

addExtensions()source public

addExtensions( string|array $extensions )

Добавить дополнительные расширения к уже имеющимся в текущей области

Параметры

string|array $extensions

Одно или несколько расширений для добавления

connect()source public

connect( string $route , array $defaults [] , array $options [] )

Подключает новый маршрут.

Маршруты — способ соединения URL-адресов запросов с объектами в вашем приложении. В основе маршрутов лежит набор или регулярные выражения, используемые для сопоставления запросов с направлениями.

Примеры:

$routes->connect('/:controller/:action/*');

Первый параметр будет использоваться как имя контроллера, а второй — как имя действия. Синтаксис «/*» делает этот маршрут жадным, то есть он будет соответствовать запросам, таким как /posts/index, а также запросам, таким как /posts/edit/1/foo/bar.

$routes->connect('/home-page', ['controller' => 'Pages', 'action' => 'display', 'home']);

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

$routes->connect(
  '/:lang/:controller/:action/:id',
  [],
  ['id' => '[0-9]+', 'lang' => '[a-z]{3}']
);

Показывается подключение маршрута с пользовательскими параметрами маршрута, а также предоставление шаблонов для этих параметров. Шаблоны для параметров маршрутизации не нуждаются в группах захвата, так как для каждого параметра маршрута будет добавлена одна.

$options предлагает несколько «специальных» ключей, которые имеют особое значение в массиве $options.

• pass используется для определения, какие параметры маршрутизации должны быть перенесены в массив pass. Добавление параметра в pass удалит его из обычного массива маршрута. Пример: 'pass' => ['slug'].
• routeClass используется для расширения и изменения того, как отдельные маршруты анализируют запросы и обрабатывают обратную маршрутизацию с помощью пользовательского класса маршрутизации. Пример: 'routeClass' => 'SlugRoute'
• persist используется для определения, какие параметры маршрута должны автоматически включаться при генерации новых URL-адресов. Вы можете переопределять постоянные параметры, переопределяя их в URL-адресе, или удалять их, установив параметр в false. Пример: 'persist' => ['lang']
• multibytePattern Установите в значение true, чтобы включить поддержку многобайтовых шаблонов в шаблонах параметров маршрута.
• _name используется для определения определенного имени для маршрутов. Это может быть использовано для оптимизации обратных запросов по маршрутам. Если не определено, для каждого подключенного маршрута будет сгенерировано имя.
• _ext — массив расширений файлов, которые будут извлекаться из URL, если они присутствуют. См. ScopedRouteCollection::extensions().
• _method Сопоставлять только запросы с определенными HTTP-методами.

Пример использования условия _method:

$routes->connect('/tasks', ['controller' => 'Tasks', 'action' => 'index', '_method' => 'GET']);

Этот маршрут будет сопоставляться только для запросов GET. POST-запросы не будут соответствовать этому маршруту.

Параметры

string $route

Строка, описывающая шаблон маршрута

array $defaults optional []

Массив, описывающий параметры маршрута по умолчанию. Эти параметры будут использоваться по умолчанию и могут предоставить параметры маршрутизации, которые не являются динамическими. См. выше.

array $options optional []

Массив, сопоставляющий именованные элементы в маршруте с регулярными выражениями, которым этот элемент должен соответствовать. Также содержит дополнительные параметры, такие как параметры маршрута, которые следует перенести в переданные аргументы, предоставление шаблонов для параметров маршрута и предоставление имени пользовательского класса маршрутизации.

Исключения

InvalidArgumentException
BadMethodCallException

extensions()source public

extensions( null|string|array $extensions null )

Получить или установить расширения в области действия этого маршрутизатора.

Будущие маршруты, подключенные через этого билдера, будут иметь применённые подключенные расширения. Однако, установка расширений не изменяет существующие маршруты.

Параметры

null|string|array $extensions необязательно null

Расширения для использования или null.

Возвращает

array|null

fallbacks()source public

fallbacks( string|null $routeClass null )

Подключить /:controller и /:controller/:action/* fallback маршруты.

Это метод-короткая запись для подключения fallback маршрутов в заданной области видимости.

Параметры

string|null $routeClass необязательно null

класс маршрута для использования, использует по умолчанию routeClass, если не указан

namePrefix()source public

namePrefix( string|null $value null )

Получить/установить префикс имени для этой области видимости.

Изменение префикса имени изменит только префикс, используемый для маршрутов, подключенных после изменения префикса.

Параметры

string|null $value необязательно null

Значение для установки или null.

Возвращает

string

params()source public

params( )

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

Возвращает

string

path()source public

path( )

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

Возвращает

string

plugin()source public

plugin( string $name , array|callable $options [] , callable|null $callback null )

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

Этот метод создаёт новую область видимости для маршрутов, включающую соответствующую информацию о плагине.

Имя плагина будет склонено в нижний регистр с подчеркиванием для создания пути маршрутизации. Если вы хотите пользовательское имя пути, используйте параметр path.

Маршруты, подключенные в области видимости, будут иметь корректный сегмент пути в префиксе и сопоставленный ключ маршрутизации плагина.

Параметры

string $name

Имя плагина для создания маршрутов

array|callable $options необязательно []

Опции для использования или обратный вызов

callable|null $callback необязательно null

Обратный вызов для вызова, который строит маршруты плагина. Требуется только, когда определён $options.

prefix()source public

prefix( string $name , callable $callback )

Добавить маршруты с префиксом.

Этот метод создает область видимости для маршрутов, содержащую соответствующую информацию о префиксе.

Параметр пути используется для генерации имени параметра маршрутизации. Например, путь admin приведет к применению 'prefix' => 'admin' ко всем подключенным маршрутам.

Вы можете повторно открыть префикс столько раз, сколько необходимо, а также вложенные префиксы. Вложенные префиксы приведут к значениям префиксов, таким как admin/api, что соответствует пространству имён Controller\Admin\Api\.

Параметры

string $name

Имя префикса для использования.

callable $callback

Обратный вызов для вызова, который строит маршруты с префиксом.

redirect()source public

redirect( string $route , array $url , array $options [] )

Подключает новый маршрут перенаправления в маршрутизаторе.

Маршруты перенаправления отличаются от обычных маршрутов тем, что выполняют фактическое перенаправление заголовка, если совпадение найдено. Перенаправление может происходить внутри вашего приложения или перенаправлять на внешний ресурс.

Примеры:

$routes->redirect('/home/*', ['controller' => 'posts', 'action' => 'view']);

Перенаправляет /home/* на /posts/view и передает параметры в /posts/view. Использование массива в качестве пункта назначения перенаправления позволяет использовать другие маршруты для определения, куда должна быть перенаправлена строка URL.

$routes->redirect('/posts/*', 'http://google.com', ['status' => 302]);

Перенаправляет /posts/* на http://google.com со статусом HTTP 302.

Опции:

• status Устанавливает статус HTTP (по умолчанию 301)
• persist Передает параметры перенаправленному маршруту, если это возможно. Это полезно для жадных маршрутов, маршруты, заканчивающиеся на * являются жадными. Так как вы можете переназначить URL и не потерять переданные аргументы.

Параметры

string $route

Строка, описывающая шаблон маршрута

array $url

URL для перенаправления. Может быть строкой или URL Cake, основанным на массиве.

array $options необязательно []

Массив, сопоставляющий именованные элементы в маршруте с регулярными выражениями, которым должен соответствовать элемент. Также содержит дополнительные параметры, такие как которые параметры маршрута должны быть перенесены в переданные аргументы. А также предоставляет шаблоны для параметров маршрутизации.

resources()source public

resources( string $name , array|callable $options [] , callable|null $callback null )

Генерировать маршруты REST-ресурсов для заданных контроллеров.

Быстрый способ сгенерировать маршруты по умолчанию для набора REST-ресурсов (контроллеров).

Использование

Подключение маршрутов ресурсов для контроллера приложения:

$routes->resources('Posts');

Подключение маршрутов ресурсов для контроллера Comments в плагине Comments:

Router::plugin('Comments', function ($routes) {
  $routes->resources('Comments');
});

Плагины создадут маршруты ресурсов с подчеркиванием в нижнем регистре. например /comments/comments

Подключение маршрутов ресурсов для контроллера Articles в префиксе Admin:

Router::prefix('admin', function ($routes) {
  $routes->resources('Articles');
});

Префиксы создадут маршруты ресурсов с подчеркиванием в нижнем регистре. например /admin/posts

Можно создать вложенные ресурсы, передав обратный вызов в:

$routes->resources('Articles', function ($routes) {
  $routes->resources('Comments');
});

Вышеупомянутое сгенерирует маршруты ресурсов как для /articles, так и для /articles/:article_id/comments. Можно использовать опцию map для подключения дополнительных методов ресурсов:

$routes->resources('Articles', [
  'map' => ['deleteAll' => ['action' => 'deleteAll', 'method' => 'DELETE']]
]);

В дополнение к маршрутам по умолчанию, это также подключит маршрут для /articles/delete_all. По умолчанию сегмент пути соответствует имени ключа. Можно настроить имя пути с помощью ключа "path" в определении ресурса.

Можно использовать опцию inflect для изменения способа генерации сегментов пути:

$routes->resources('PaymentTypes', ['inflect' => 'dasherize']);

Сгенерирует маршруты, такие как /payment-types вместо /payment_types

Опции:

• 'id' - фрагмент регулярного выражения для использования при сопоставлении идентификаторов. По умолчанию соответствует целочисленным значениям и UUID.
• 'inflect' - выбрать метод склонения, используемый для имени ресурса. По умолчанию 'underscore'.
• 'only' - подключить только указанный список действий.
• 'actions' - переопределить имена методов, используемые для подключения действий.
• 'map' - дополнительные маршруты ресурсов, которые следует подключить. Если вы определяете 'only' и 'map', убедитесь, что ваши сопоставленные методы также находятся в списке 'only'.

Параметры

string $name

Имя контроллера для подключения маршрутов ресурсов.

array|callable $options необязательно []

Опции для использования при генерации маршрутов REST или обратный вызов.

callable|null $callback необязательно null

Необязательный обратный вызов, который выполняется в области видимости вложенного уровня. Вложенные области видимости наследуют существующий путь и параметр 'id'.

routeClass()source public

routeClass( string|null $routeClass null )

Получить или установить класс маршрута по умолчанию.

Параметры

string|null $routeClass необязательно null

Имя класса.

Возвращает

string|null

scope()source public

scope( string $path , array|callable $params , callable|null $callback null )

Создать новую область видимости маршрутизации.

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

Параметры

string $path

Путь для создания области видимости.

array|callable $params

Параметры для добавления к маршрутам или обратный вызов.

callable|null $callback необязательно null

Обратный вызов для вызова, который строит маршруты плагина. Требуется только, если $params определён.

Исключение

InvalidArgumentException
при отсутствии параметра обратного вызова.

[]

''

[
    'index' => ['action' => 'index', 'method' => 'GET', 'path' => ''],
    'create' => ['action' => 'add', 'method' => 'POST', 'path' => ''],
    'view' => ['action' => 'view', 'method' => 'GET', 'path' => ':id'],
    'update' => ['action' => 'edit', 'method' => ['PUT', 'PATCH'], 'path' => ':id'],
    'delete' => ['action' => 'delete', 'method' => 'DELETE', 'path' => ':id'],
]

'Cake\Routing\Route\Route'