Класс RouteBuilder

__construct()source public

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

Конструктор

Параметры

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

Параметры

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
если создаваемый маршрут конфликтует с текущей областью

_methodRoute()source protected

_methodRoute( string $method , string $template , array $target , string $name )

Вспомогательная функция для создания маршрутов, которые реагируют только на один HTTP-метод.

Параметры

строка $method

Имя HTTP-метода для сопоставления.

строка $template

Шаблон URL для использования.

массив $target

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

строка $name

Имя маршрута.

Возвращает

Cake\Routing\Route\Route

addExtensions()source public

addExtensions( string|array $extensions )

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

Параметры

строка или массив $extensions

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

applyMiddleware()source public

applyMiddleware( ... $names )

Применить мидлваер к текущему диапазону маршрутов.

Требуется, чтобы мидлваер был зарегистрирован через registerMiddleware()

Параметры

... $names

$names Имена мидлвеаров, которые нужно применить к текущему диапазону.

Возвращает

$this

См. также

\Cake\Routing\RouteCollection::addMiddlewareToScope()

connect()source public

connect( string $route , array|string $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.

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

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

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

Вышеуказанный маршрут будет соответствовать только запросам GET. Запросы POST не будут соответствовать этому маршруту.

Параметры

строка $route

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

массив или строка $defaults необязательно []

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

массив $options необязательно []

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

Возвращает

Cake\Routing\Route\Route

Вызывает исключения

InvalidArgumentException
BadMethodCallException

delete()source public

delete( string $template , array $target , string $name = null )

Создать маршрут, который реагирует только на запросы DELETE.

Параметры

строка $template

Шаблон URL для использования.

массив $target

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

строка $name необязательно null

Имя маршрута.

Возвращает

Cake\Routing\Route\Route

extensions()source public deprecated

extensions( null|string|array $extensions = null )

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

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

Устарело

3.5.0 Используйте getExtensions/setExtensions вместо этого.

Параметры

null|строка|массив $extensions необязательно null

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

Возвращает

массив|null

fallbacks()source public

fallbacks( string|null $routeClass = null )

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

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

Параметры

строка|null $routeClass необязательно null

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

get()source public

get( string $template , array $target , string $name = null )

Создать маршрут, который реагирует только на запросы GET.

Параметры

строка $template

Шаблон URL для использования.

массив $target

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

строка $name необязательно null

Имя маршрута.

Возвращает

Cake\Routing\Route\Route

getExtensions()source public

getExtensions( )

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

Возвращает

массив

getRouteClass()source public

getRouteClass( )

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

Возвращает

строка

head()source public

head( string $template , array $target , string $name = null )

Создать маршрут, который реагирует только на запросы HEAD.

Параметры

строка $template

Шаблон URL для использования.

массив $target

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

строка $name необязательно null

Имя маршрута.

Возвращает

Cake\Routing\Route\Route

loadPlugin()source public

loadPlugin( string $name , string $file = 'routes.php' )

Загрузить маршруты из плагина.

Файл маршрутов будет иметь локальную переменную с именем $routes, которая содержит текущий экземпляр RouteBuilder.

Параметры

строка $name

Имя плагина

строка $file необязательный 'routes.php'

Файл маршрутов для загрузки. По умолчанию routes.php. Этот параметр устарел и будет удален в версии 4.0

Исключения

Cake\Core\Exception\MissingPluginException
При отсутствии загруженного плагина.
InvalidArgumentException
При отсутствии файла маршрутов в плагине.

middlewareGroup()source public

middlewareGroup( string $name , array $middlewareNames )

Применить набор middleware к группе

Параметры

строка $name

Имя группы middleware

массив $middlewareNames

Имена middleware

Возвращает

$this

nameExists()source public

nameExists( string $name )

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

Параметры

строка $name

Имя.

Возвращает

boolean

namePrefix()source public

namePrefix( string|null $value = null )

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

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

Параметры

строка|null $value необязательный null

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

Возвращает

строка

options()source public

options( string $template , array $target , string $name = null )

Создать маршрут, который отвечает только на запросы OPTIONS.

Параметры

строка $template

Шаблон URL для использования.

массив $target

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

строка $name необязательный null

Имя маршрута.

Возвращает

Cake\Routing\Route\Route

params()source public

params( )

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

Возвращает

массив

parseDefaults()source protected static

parseDefaults( string|array $defaults )

Обработать значения по умолчанию, если они являются строкой

Параметры

строка|массив $defaults

Массив значений по умолчанию из метода connect().

Возвращает

строка|массив

patch()source public

patch( string $template , array $target , string $name = null )

Создать маршрут, который отвечает только на запросы PATCH.

Параметры

строка $template

Шаблон URL для использования.

массив $target

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

строка $name необязательный null

Имя маршрута.

Возвращает

Cake\Routing\Route\Route

path()source public

path( )

Получить путь для этой области видимости.

Возвращает

строка

plugin()source public

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

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

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

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

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

Параметры

строка $name

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

массив|обратный вызов $options необязательный []

Либо параметры для использования, либо обратный вызов

обратный вызов|null $callback необязательный null

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

post()source public

post( string $template , array $target , string $name = null )

Создать маршрут, который отвечает только на запросы POST.

Параметры

строка $template

Шаблон URL для использования.

массив $target

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

строка $name необязательный null

Имя маршрута.

Возвращает

Cake\Routing\Route\Route

prefix()source public

prefix( string $name , array|callable $params = [] , callable $callback = null )

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

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

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

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

Если вам нужно использовать префикс с точками, например: '/api/v1.0', используйте ключ 'path' для аргумента $params:

$route->prefix('api', function($route) {
    $route->prefix('v10', ['path' => '/v1.0'], function($route) {
        // Translates to `Controller\Api\V10\` namespace
    });
});

Параметры

строка $name

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

массив|обратный вызов $params необязательный []

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

обратный вызов $callback необязательный null

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

Исключения

InvalidArgumentException
Если не передан допустимый обратный вызов

put()source public

put( string $template , array $target , string $name = null )

Создать маршрут, который отвечает только на запросы PUT.

Параметры

строка $template

Шаблон URL для использования.

массив $target

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

строка $name необязательный null

Имя маршрута.

Возвращает

Cake\Routing\Route\Route

redirect()source public

redirect( string $route , array|string $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|string $url

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

array $options опционально []

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

Возвращает

Cake\Routing\Route\Route|Cake\Routing\Route\RedirectRoute

registerMiddleware()source public

registerMiddleware( string $name , callable|string $middleware )

Регистрирует middleware в RouteCollection.

После регистрации middleware его можно применить к текущей области маршрутизации или любым дочерним областям, которые используют ту же RouteCollection.

Параметры

string $name

Название middleware. Используется при применении middleware к области.

callable|string $middleware

Вызываемый объект или имя класса middleware для регистрации.

Возвращает

$this

См. также

\Cake\Routing\RouteCollection

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'.
• 'prefix' - определение префикса маршрутизации для контроллера ресурсов. Если текущая область определяет префикс, этот префикс будет добавлен к нему.
• 'connectOptions' - пользовательские параметры для подключения маршрутов.
• 'path' - изменить путь так, чтобы он не соответствовал имени ресурса. Например, ArticlesController доступен по адресу /posts

Параметры

string $name

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

array|callable $options опционально []

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

callable|null $callback опционально null

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

routeClass()source public устаревший

routeClass( string|null $routeClass = null )

Получить или установить стандартный класс маршрута.

Устаревший

3.5.0 Используйте getRouteClass/setRouteClass вместо этого.

Параметры

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
если параметр обратного вызова отсутствует.

setExtensions()source public

setExtensions( string|array $extensions )

Устанавливает расширения в области этого билдера маршрутов.

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

Параметры

string|array $extensions

Расширения для установки.

Возвращает

$this

setRouteClass()source public

setRouteClass( string $routeClass )

Устанавливает стандартный класс маршрута.

Параметры

string $routeClass

Имя класса.

Возвращает

$this

[]

''

[
    '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'

[]