Маршрутизация¶

Элементы маршрута¶

Вы можете указать свои собственные элементы маршрута, и это даёт вам возможность определять места в URL-адресе, где должны находиться параметры для действий контроллера. Когда запрос сделан, значения для этих элементов маршрута находятся в $this->request->getParam() в контроллере. Когда вы определяете настраиваемый элемент маршрута, вы можете дополнительно указать регулярное выражение - это говорит CakePHP, как узнать, правильно ли сформирован URL-адрес. Если вы решите не предоставлять регулярное выражение, любой символ / будет рассматриваться как часть параметра:

$routes->connect(
    '/:controller/:id',
    ['action' => 'view']
)->setPatterns(['id' => '[0-9]+']);

// До 3.5 используйте массив опций
$routes->connect(
    '/:controller/:id',
    ['action' => 'view'],
    ['id' => '[0-9]+']
);

В приведённом выше примере показано, как создать быстрый способ просмотра моделей с любого контроллера, создав URL-адрес, который выглядит как /controllername/:id. URL, предоставленный connect(), указывает два элемента маршрута : :controller и :id. Элемент :controller является элементом маршрута по умолчанию CakePHP, поэтому маршрутизатор знает, как сопоставлять и идентифицировать имена контроллеров в URL-адресах. Элемент :id является настраиваемым элементом маршрута, и его необходимо уточнить, указав подходящее регулярное выражение в третьем параметре connect().

CakePHP автоматически не создаёт нижние и пунктирные URL-адреса при использовании параметра :controller. Если вам это нужно, приведённый выше пример можно переписать так:

use Cake\Routing\Route\DashedRoute;

// Создайте конструктор с другим классом маршрутов.
$routes->scope('/', function ($routes) {
    $routes->setRouteClass(DashedRoute::class);
    $routes->connect('/:controller/:id', ['action' => 'view'])
        ->setPatterns(['id' => '[0-9]+']);

    // До 3.5 использовать опцию array
    $routes->connect(
        '/:controller/:id',
        ['action' => 'view'],
        ['id' => '[0-9]+']
    );
});

Класс DashedRoute гарантирует, что параметры :controller и :plugin будут корректно приведены к строчному виду и разделены пунктиром.

Если для переноса из приложения CakePHP 2.x вам нужны нижние и подчеркнутые URL-адреса, вы можете вместо этого использовать класс InflectedRoute.

Как только этот маршрут определён, запрос /apples/5 вызовет метод view() ApplesController. Внутри метода view() вам нужно будет получить доступ к переданному идентификатору в $this->request->getParam('id').

Если в вашем приложении имеется один контроллер, и вы не хотите, чтобы имя контроллера отображалось в URL-адресе, вы можете сопоставить все URL-адреса с действиями в вашем контроллере. Например, чтобы сопоставить все URL-адреса с действиями контроллера home, например, иметь URL-адреса, такие как /demo вместо /home/demo, вы можете сделать следующее:

$routes->connect('/:action', ['controller' => 'Home']);

Если вы хотите указать нечувствительный к регистру URL-адрес, вы можете использовать регулярные выражения inline-модификаторов:

// До 3.5 используовался массив параметров вместо setPatterns()
$routes->connect(
    '/:userShortcut',
    ['controller' => 'Teachers', 'action' => 'profile', 1],
)->setPatterns(['userShortcut' => '(?i:principal)']);

Еще один пример, и вы будете профессионалом маршрутизации:

// До 3.5 используовался массив параметров вместо setPatterns()
$routes->connect(
    '/:controller/:year/:month/:day',
    ['action' => 'index']
)->setPatterns([
    'year' => '[12][0-9]{3}',
    'month' => '0[1-9]|1[012]',
    'day' => '0[1-9]|[12][0-9]|3[01]'
]);

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

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

Затем мы укажем некоторые значения по умолчанию. Независимо от контроллера, мы хотим вызвать экшен index().

Наконец, мы указываем некоторые регулярные выражения, которые будут соответствовать годам, месяцам и дням в числовой форме. Обратите внимание, что скобки (группировка) не поддерживаются в регулярных выражениях. Вы всё же можете указать альтернативы, как указано выше, но не группировать их круглыми скобками.

После определения этот маршрут будет соответствовать /articles/2007/02/01, /articles/2004/11/16, передавая запросы в экшен index() их соответствующих контроллеров, с параметрами даты в $this->request->getParam().

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

• controller Используется для обозначения контроллера для маршрута.

• action Используется для обозначения действия(экшена) контроллера для маршрута.

• plugin Используется для обозначения плагина, в котором находится контроллер.

• prefix Используется для Префиксная маршрутизация

• _ext Используется для File extentions routing.

• _base Установите false, чтобы удалить базовый путь из сгенерированного URL. Если ваше приложение не находится в корневом каталоге, это может быть использовано для создания URL-адресов, которые являются „относительными кексами“.

• _scheme Установите для создания ссылок на разные схемы, такие как webcal или ftp. По умолчанию используется текущая схема.

• _host Установите хост для связи. По умолчанию используется текущий хост.

• _port Установите порт, если вам нужно создать ссылки на нестандартных портах.

• _full Если true, константа FULL_BASE_URL будет добавлена к сгенерированным URL-адресам.

• # Позволяет установить фрагменты хеша URL.

• _ssl Установите значение true, чтобы преобразовать сгенерированный URL-адрес в https или false, чтобы заставить http.

• _method Определите HTTP-глагол/метод для использования. Полезно при работе с Создание RESTful маршрутов.

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

Настройка параметров маршрута¶

Существует несколько параметров маршрута, которые могут быть установлены на каждом маршруте. После подключения маршрута вы можете использовать свои быстрые методы построения для дальнейшей настройки маршрута. Эти методы заменяют многие ключи в параметре $options метода connect():

$routes->connect(
    '/:lang/articles/:slug',
    ['controller' => 'Articles', 'action' => 'view'],
)
// Разрешить запросы GET и POST.
->setMethods(['GET', 'POST'])

// Только совпадение в субдомене блога.
->setHost('blog.example.com')

// Установите элементы маршрута, которые должны быть преобразованы
// в переданные аргументы
->setPass(['slug'])

// Установите соответствующие шаблоны для элементов маршрута
->setPatterns([
    'slug' => '[a-z0-9-_]+',
    'lang' => 'en|fr|es',
])

// Также разрешить расширения файлов JSON
->setExtensions(['json'])

// Установите lang как постоянный параметр
->setPersist(['lang']);

Передача параметров в действие(экшен)¶

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

// src/Controller/BlogsController.php
public function view($articleId = null, $slug = null)
{
    // Здесь код экшена
}

// config/routes.php
Router::scope('/', function ($routes) {
    $routes->connect(
        '/blog/:id-:slug', // Например /blog/3-CakePHP_Rocks
        ['controller' => 'Blogs', 'action' => 'view']
    )
    // Определите элементы маршрута в шаблоне маршрута для
    // передачи в качестве аргументов функции. Вопросы заказа,
    // так как это просто отобразит ":id" в $articleId в вашем действии
    ->setPass(['id', 'slug'])
    // Определите шаблон, который должен совпадать с идентификатором `id`.
    ->setPatterns([
        'id' => '[0-9]+',
    ]);
});

Теперь благодаря возможностям обратной маршрутизации вы можете перейти в массив URL, как показано ниже, и CakePHP будет знать, как формировать URL-адрес, определённый в маршрутах:

// view.ctp
// Это вернёт ссылку на /blog/3-CakePHP_Rocks
echo $this->Html->link('CakePHP Rocks', [
    'controller' => 'Blog',
    'action' => 'view',
    'id' => 3,
    'slug' => 'CakePHP_Rocks'
]);

// Вы также можете использовать числовые индексированные параметры.
echo $this->Html->link('CakePHP Rocks', [
    'controller' => 'Blog',
    'action' => 'view',
    3,
    'CakePHP_Rocks'
]);

Использование именованных маршрутов¶

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

// Соедините маршрут с именем.
$routes->connect(
    '/login',
    ['controller' => 'Users', 'action' => 'login'],
    ['_name' => 'login']
);

// Назовите конкретный маршрут глагола (3.5.0+)
$routes->post(
    '/logout',
    ['controller' => 'Users', 'action' => 'logout'],
    'logout'
);

// Создайте URL-адрес, используя именованный маршрут.
$url = Router::url(['_name' => 'logout']);

// Создайте URL-адрес, используя именованный маршрут,
// с некоторыми аргументами строки запроса.
$url = Router::url(['_name' => 'login', 'username' => 'jimmy']);

Если ваш шаблон маршрута содержит какие-либо элементы маршрута, такие как :controller, вам нужно будет предоставить их как часть параметров для Router::url().

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

Router::scope('/api', ['_namePrefix' => 'api:'], function ($routes) {
    // Имя этого маршрута будет `api:ping`
    $routes->get('/ping', ['controller' => 'Pings'], 'ping');
});
// Создайте URL-адрес для маршрута пинга
Router::url(['_name' => 'api:ping']);

// Используйте namePrefix с plugin()
Router::plugin('Contacts', ['_namePrefix' => 'contacts:'], function ($routes) {
    // Подключите маршруты.
});

// Или с prefix()
Router::prefix('Admin', ['_namePrefix' => 'admin:'], function ($routes) {
    // Подключите маршруты.
});

Вы также можете использовать опцию _namePrefix внутри вложенных областей, и она работает так, как вы и ожидали:

Router::plugin('Contacts', ['_namePrefix' => 'contacts:'], function ($routes) {
    $routes->scope('/api', ['_namePrefix' => 'api:'], function ($routes) {
        // Имя этого маршрута будет `contacts:api:ping`
        $routes->get('/ping', ['controller' => 'Pings'], 'ping');
    });
});

// Создайте URL-адрес для маршрута пинга
Router::url(['_name' => 'contacts:api:ping']);

Маршруты, связанные в названных областях, будут иметь только имена, если маршрут также назван. Для безымянных маршрутов, _namePrefix применено к ним не будет.

Префиксная маршрутизация¶

static Cake\Routing\Router::prefix($name, $callback)¶

Для большинства приложений требуется раздел администрирования, в котором привилегированные пользователи могут вносить изменения. Это часто делается с помощью специального URL-адреса, такого как /admin/users/edit/5. В CakePHP префиксную маршрутизацию можно включить с помощью метода prefix() области видимости, в config/routes.php:

use Cake\Routing\Route\DashedRoute;

Router::prefix('admin', function (RouteBuilder $routes) {
    // Все маршруты здесь будут иметь префикс `/admin`,
    // и добавлять элемент prefix => admin маршрутизации.
    $routes->fallbacks(DashedRoute::class);
});

Префиксы сопоставляются с подпространствами имён в пространстве имён Controller вашего приложения. Имея префиксы в качестве отдельных контроллеров, вы можете создавать более мелкие и простые контроллеры. Поведение, которое является общим для префиксных и не префиксных контроллеров, может быть инкапсулировано с использованием наследования Компоненты или трейтов. Используя пример наших пользователей, доступ к URL-адресу /admin/users/edit/5 вызовет метод edit() нашего src/Controller/Admin/UsersController.php, передающий 5 в качестве первого параметра. Используемый файл просмотра будет src/Template/Admin/Users/edit.ctp.

Вы можете сопоставить URL /admin с вашим экшеном index() контроллера страниц, используя следующий маршрут:

Router::prefix('admin', function (RouteBuilder $routes) {
    // Поскольку вы находитесь в области администрирования,
    // вам не нужно включать префикс /admin или элемент маршрута admin.
    $routes->connect('/', ['controller' => 'Pages', 'action' => 'index']);
});

При создании префиксных маршрутов вы можете установить дополнительные параметры маршрута с помощью аргумента $options:

Router::prefix('admin', ['param' => 'value'], function ($routes) {
    // Маршруты, связанные здесь, имеют
    // префикс '/admin' и имеют набор ключей 'param'.
    $routes->connect('/:controller');
});

Вы также можете определить префиксы внутри областей плагинов:

Router::plugin('DebugKit', function ($routes) {
    $routes->prefix('admin', function ($routes) {
        $routes->connect('/:controller');
    });
});

Вышеизложенное создало бы шаблон маршрута, например /debug_kit/admin/:controller. На связанном маршруте будут установлены элементы маршрута plugin и prefix.

При определении префиксов вы можете, при необходимости, вложить несколько префиксов:

Router::prefix('manager', function ($routes) {
    $routes->prefix('admin', function ($routes) {
        $routes->connect('/:controller');
    });
});

Вышеизложенное создало бы шаблон маршрута, например /manager/admin/:controller. Связанный маршрут будет иметь элемент маршрута prefix, заданный manager/admin.

Текущий префикс будет доступен из методов контроллера через $this->request->getParam('prefix').

При использовании префиксных маршрутов важно установить префиксную опцию. Вот как построить эту ссылку с помощью HTML-помощника:

// Перейдите в префиксный маршрут.
echo $this->Html->link(
    'Manage articles',
    ['prefix' => 'manager', 'controller' => 'Articles', 'action' => 'add']
);

// Оставить префикс
echo $this->Html->link(
    'View Post',
    ['prefix' => false, 'controller' => 'Articles', 'action' => 'view', 5]
);

Маршрутизация плагинов¶

static Cake\Routing\Router::plugin($name, $options = [], $callback)¶

Маршруты для Плагины должны создаваться с использованием метода plugin(). Этот метод создаёт новую область маршрутизации для маршрутов плагина:

Router::plugin('DebugKit', function ($routes) {
    // Маршруты, связанные здесь, имеют префикс '/debug_kit' и
    // имеют элемент маршрута плагина, установленный в 'DebugKit'.
    $routes->connect('/:controller');
});

При создании областей плагинов вы можете настроить элемент пути, используемый с опцией path:

Router::plugin('DebugKit', ['path' => '/debugger'], function ($routes) {
    // Маршруты, связанные здесь, имеют префикс '/debugger' и
    // имеют элемент маршрута плагина, установленный в 'DebugKit'.
    $routes->connect('/:controller');
});

При использовании областей видимости вы можете вставлять области плагинов в области префикса:

Router::prefix('admin', function ($routes) {
    $routes->plugin('DebugKit', function ($routes) {
        $routes->connect('/:controller');
    });
});

Вышеизложенное создало бы маршрут, который выглядит как /admin/debug_kit/:controller. Он будет иметь элементы prefix и plugin. Раздел Маршрутизация плагина содержит дополнительную информацию о построении маршрутов плагинов.

Создание ссылок на плагины¶

Вы можете создавать ссылки, указывающие на плагин, добавляя ключ плагина к вашему массиву URL:

echo $this->Html->link(
    'New todo',
    ['plugin' => 'Todo', 'controller' => 'TodoItems', 'action' => 'create']
);

И наоборот, если активный запрос является запросом плагина, и вы хотите создать ссылку, у которой нет плагина, вы можете сделать следующее:

echo $this->Html->link(
    'New todo',
    ['plugin' => null, 'controller' => 'Users', 'action' => 'profile']
);

Установив 'plugin' => null, вы указываете маршрутизатору, что хотите создать ссылку, которая не является частью плагина.

Маршрутизация, ориентированная на SEO¶

Некоторые разработчики предпочитают использовать тире в URL-адресах, так как они воспринимаются как лучший рейтинг в поисковых системах. Класс DashedRoute может использоваться в вашем приложении с возможностью маршрутизации плагинов, контроллеров „верблюжьих“ имён в пунктирный URL.

Например, если у вас есть плагин ToDo, с контроллером TodoItems и экшеном showItems(), его можно получить в разделе /to-do/todo-items/show-items со следующим подключением маршрутизатора:

use Cake\Routing\Route\DashedRoute;

Router::plugin('ToDo', ['path' => 'to-do'], function ($routes) {
    $routes->fallbacks(DashedRoute::class);
});

Соответствие определенным HTTP-методам¶

Маршруты могут соответствовать определенным HTTP-методам с помощью методов HTTP-хелпера:

Router::scope('/', function($routes) {
    // Этот маршрут соответствует только POST запросам.
    $routes->post(
        '/reviews/start',
        ['controller' => 'Reviews', 'action' => 'start']
    );

    // Сопоставьте несколько глаголов.
    // До 3.5 используйте $options['_method'] для установки метода
    $routes->connect(
        '/reviews/start',
        [
            'controller' => 'Reviews',
            'action' => 'start',
        ]
    )->setMethods(['POST', 'PUT']);
});

Вы можете сопоставить несколько методов HTTP с помощью массива. Поскольку параметр _method является ключом маршрутизации, он участвует как в разборе URL, так и в генерации URL. Чтобы генерировать URL-адреса для маршрутов, специфичных для метода, вам нужно включить ключ _method при создании URL:

$url = Router::url([
    'controller' => 'Reviews',
    'action' => 'start',
    '_method' => 'POST',
]);

Соответствие определённым именам хостов¶

Маршруты могут использовать опцию _host только для соответствия определенным хостам. Вы можете использовать подстановочный знак *. для соответствия любому поддомену:

Router::scope('/', function($routes) {
    // Этот маршрут встречается только на http://images.example.com
    // До 3.5 использовалась только опция _host
    $routes->connect(
        '/images/default-logo.png',
        ['controller' => 'Images', 'action' => 'default']
    )->setHost('images.example.com');

    // Этот маршрут соответствует только http: //*.example.com.
    $routes->connect(
        '/images/old-log.png',
        ['controller' => 'Images', 'action' => 'oldLogo']
    )->setHost('*.example.com');
});

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

// Если у вас есть этот маршрут
$routes->connect(
    '/images/old-log.png',
    ['controller' => 'Images', 'action' => 'oldLogo']
)->setHost('images.example.com');

// Вам необходимо создать такой URL
echo Router::url([
    'controller' => 'Images',
    'action' => 'oldLogo',
    '_host' => 'images.example.com',
]);

Расширения файлов маршрутизации¶

static Cake\Routing\Router::extensions(string|array|null $extensions, $merge = true)¶

Чтобы обрабатывать различные расширения файлов с помощью ваших маршрутов, вы можете определять расширения как на глобальном, так и на уровне охвата. Определение глобальных расширений может быть достигнуто с помощью метода Router::extensions():

Router::extensions(['json', 'xml']);
// ...

Это повлияет на все маршруты, которые подключаются после этого, независимо от их объема.

Чтобы ограничить расширения конкретными областями, вы можете определить их, используя метод Cake\Routing\RouteBuilder::setExtensions():

Router::scope('/', function ($routes) {
    // До 3.5.0 использовать `extensions()`
    $routes->setExtensions(['json', 'xml']);
});

Это позволит использовать именованные расширения для всех маршрутов, которые подключаются в этой области после вызова setExtensions(), включая те, которые подключены во вложенных областях. Подобно глобальному Router::extensions(), любые маршруты, подключенные до вызова, не будут наследовать расширения.

Используя расширения, вы указываете маршрутизатору удалить любые соответствующие расширения файлов, а затем проанализировать, что осталось. Если вы хотите создать URL-адрес, такой как /page/title-of-page.html, вам нужно создать свой маршрут, используя:

Router::scope('/page', function ($routes) {
    // До 3.5.0 использовать `extensions()`
    $routes->setExtensions(['json', 'xml', 'html']);
    $routes->connect(
        '/:title',
        ['controller' => 'Pages', 'action' => 'view']
    )->setPass(['title']);
});

Затем для создания ссылок, которые вернутся к маршрутам, просто используйте:

$this->Html->link(
    'Link title',
    ['controller' => 'Pages', 'action' => 'view', 'title' => 'super-article', '_ext' => 'html']
);

Расширения файлов используются Обработка запроса для автоматического переключения вида на основе типов контента.

Соединение с областью Middleware (промежуточного ПО)¶

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

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

// в config/routes.php
use Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Http\Middleware\EncryptedCookieMiddleware;

Router::scope('/', function ($routes) {
    $routes->registerMiddleware('csrf', new CsrfProtectionMiddleware());
    $routes->registerMiddleware('cookies', new EncryptedCookieMiddleware());
});

После регистрации промежуточное ПО может быть применено к определенным областям:

$routes->scope('/cms', function ($routes) {
    // Включим CSRF & cookies middleware
    $routes->applyMiddleware('csrf', 'cookies');
    $routes->get('/articles/:action/*', ['controller' => 'Articles'])
});

В ситуациях, когда у вас есть вложенные области, внутренние области наследуют промежуточное ПО, применяемое в области содержимого:

$routes->scope('/api', function ($routes) {
    $routes->applyMiddleware('ratelimit', 'auth.api');
    $routes->scope('/v1', function ($routes) {
        $routes->applyMiddleware('v1compat');
        // Здесь определите маршруты.
    });
});

В приведённом выше примере маршруты, определенные в /v1, будут иметь промежуточное ПО „ratelimit“, „auth.api“ и „v1compat“. Если вы повторно откроете область действия, промежуточное ПО, применяемое к маршрутам в каждой области, будет изолировано:

$routes->scope('/blog', function ($routes) {
    $routes->applyMiddleware('auth');
    // Подключите аутентифицированные действия для этого блога.
});
$routes->scope('/blog', function ($routes) {
    // Подключите здесь публичные действия для блога.
});

В приведённом выше примере два использования области /blog не используют промежуточное ПО. Однако обе эти области будут наследовать промежуточное ПО, определённое в их областях видимости.

Группировка промежуточного ПО¶

Чтобы сохранить код маршрута DRY промежуточное ПО может быть объединено в группы. Когда объединённые группы могут применяться как промежуточное ПО, возможно:

$routes->registerMiddleware('cookie', new EncryptedCookieMiddleware());
$routes->registerMiddleware('auth', new AuthenticationMiddleware());
$routes->registerMiddleware('csrf', new CsrfProtectionMiddleware());
$routes->middlewareGroup('web', ['cookie', 'auth', 'csrf']);

// Применить группу
$routes->applyMiddleware('web');

Создание маршрутов вложенных ресурсов (под-ресурсов)¶

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

Router::scope('/api', function ($routes) {
    $routes->resources('Articles', function ($routes) {
        $routes->resources('Comments');
    });
});

Будет генерировать маршруты ресурсов для articles и comments. Маршруты комментариев будут выглядеть так:

/api/articles/:article_id/comments
/api/articles/:article_id/comments/:id

Вы можете получить article_id в CommentController:

$this->request->getParam('article_id');

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

Router::scope('/api', function ($routes) {
    $routes->resources('Articles', function ($routes) {
        $routes->resources('Comments', ['prefix' => 'articles']);
    });
});

Вышеописанное отобразило бы ресурс „Comments“ в App\Controller\Articles\CommentsController. Наличие отдельных контроллеров позволяет упростить логику контроллера. Префиксы, созданные таким образом, совместимы с Префиксная маршрутизация.

Ограничение созданных маршрутов¶

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

$routes->resources('Articles', [
    'only' => ['index', 'view']
]);

Создал бы маршруты ресурсов только для чтения. Имена маршрутов: create, update, view, index, и delete.

Изменение используемых экшенов контроллера¶

Возможно, у вас возникнет необходимость изменить имена экшенов контроллера, которые используются при подключении маршрутов. Например, если ваше действие edit() называется put(), вы можете использовать ключ actions для переименования используемых экшенов:

$routes->resources('Articles', [
    'actions' => ['update' => 'put', 'create' => 'add']
]);

Вышеизложенное будет использовать put() для экшена edit() и add() вместо create().

Сопоставление дополнительных маршрутов ресурсов¶

Вы можете сопоставить дополнительные методы ресурсов, используя опцию map:

$routes->resources('Articles', [
   'map' => [
       'deleteAll' => [
           'action' => 'deleteAll',
           'method' => 'DELETE'
       ]
   ]
]);
// Это соединило бы /articles/deleteAll

В дополнение к маршрутам по умолчанию, это также свяжет маршрут для /articles/delete_all. По умолчанию сегмент пути будет соответствовать имени ключа. Вы можете использовать ключ „path“ внутри определения ресурса для настройки имени пути:

$routes->resources('Articles', [
    'map' => [
        'updateAll' => [
            'action' => 'updateAll',
            'method' => 'DELETE',
            'path' => '/update_many'
        ],
    ]
]);
// Это соединило бы /articles/update_many

Если вы определяете „only“ и „map“, убедитесь, что ваши сопоставленные методы также находятся в списке „only“.

Пользовательские классы маршрутов для маршрутов ресурсов¶

Вы можете предоставить ключ connectOptions в массиве $options для resources() для предоставления настраиваемых параметров, используемых connect():

Router::scope('/', function ($routes) {
    $routes->resources('Books', [
        'connectOptions' => [
            'routeClass' => 'ApiRoute',
        ]
    ];
});

URL-инфлексия для ресурсных маршрутов¶

По умолчанию фрагменты URL многоуровневых контроллеров являются подчеркнутой формой имени контроллера. Например, фрагмент URL-адреса BlogPostsController будет /blog_posts.

Вы можете указать альтернативный тип инфлексии, используя опцию `` inflect``:

Router::scope('/', function ($routes) {
    $routes->resources('BlogPosts', [
        'inflect' => 'dasherize' // Буду использовать ``Inflector::dasherize()``
    ]);
});

Вышеизложенное приведёт к созданию URL-адресов, таких как: /blog-posts.

Изменение пути элемента¶

По умолчанию в маршрутах ресурсов используется измененная форма имени ресурса для сегмента URL. Вы можете настроить собственный сегмент URL с опцией path:

Router::scope('/', function ($routes) {
    $routes->resources('BlogPosts', ['path' => 'posts']);
});

Класс маршрута по умолчанию¶

static Cake\Routing\Router::defaultRouteClass($routeClass = null)¶

Если вы хотите использовать альтернативный класс маршрута для всех своих маршрутов, помимо Route, который определён по умолчанию, вы можете сделать это, вызвав Router::defaultRouteClass() перед настройкой любых маршрутов и не указывать опцию routeClass для каждого маршрута. Например:

use Cake\Routing\Route\InflectedRoute;

Router::defaultRouteClass(InflectedRoute::class);

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

Метод откатов¶

Cake\Routing\Router::fallbacks($routeClass = null)¶

Метод fallbacks - это простой ярлык для определения маршрутов по умолчанию. Метод использует пройденный класс маршрутизации для определённых правил или если класс не указан, используется класс, возвращаемый Router::defaultRouteClass().

Вызов таких резервов:

use Cake\Routing\Route\DashedRoute;

$routes->fallbacks(DashedRoute::class);

Является эквивалентом следующих явных вызовов:

use Cake\Routing\Route\DashedRoute;

$routes->connect('/:controller', ['action' => 'index'], ['routeClass' => DashedRoute::class]);
$routes->connect('/:controller/:action/*', [], ['routeClass' => DashedRoute::class]);