类 RouteBuilder

构造函数

选项

• routeClass - 添加路由时要使用的默认路由类。
• extensions - 添加路由时要连接的扩展名。
• namePrefix - 要添加到所有路由名称之前的首缀。
• middleware - 路由应该应用的中间件名称。

参数

创建路由对象，或返回提供的对象。

参数

返回值

抛出

创建仅响应单个 HTTP 方法的路由的助手。

参数

返回值

将其他扩展名添加到当前作用域中已有的扩展名中

参数

返回值

将一个或多个中间件应用于当前路由作用域。

要求通过registerMiddleware()注册中间件。

参数

返回值

抛出

另请参阅

连接新的路由。

路由是将请求 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 中解析出来。请参阅 {@link \Cake\Routing\RouteCollection::setExtensions()}。
• _method 仅匹配使用特定 HTTP 动词的请求。
• _host - 如果您希望此路由仅匹配特定主机名，请定义主机名模式。您可以使用 .* 和 来创建通配符子域/主机，例如 *.example.com 匹配 example.com 上的所有子域。
• '_port` - 如果您希望此路由仅匹配特定端口号，请定义端口。

使用 _method 条件的示例

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

上面的路由将仅匹配 GET 请求。POST 请求将无法匹配此路由。

参数

返回值

抛出

创建一个仅响应 DELETE 请求的路由。

参数

返回值

连接/{controller}和/{controller}/{action}/*回退路由。

这是在给定范围内连接回退路由的快捷方法。

参数

返回值

创建一个仅响应 GET 请求的路由。

参数

返回值

获取此路由构建器作用域中的扩展名。

返回值

获取此构建器将应用于路由的中间件。

返回值

获取默认路由类。

返回值

创建一个仅响应 HEAD 请求的路由。

参数

返回值

从插件加载路由。

路由文件将有一个名为 $routes 的局部变量可用，该变量包含当前的 RouteBuilder 实例。

参数

返回值

抛出

将一组中间件应用于组

参数

返回值

检查是否已存在具有给定名称的路由。

参数

返回值

获取/设置此作用域的名称前缀。

修改名称前缀只会更改在更改前缀后连接的路由使用的前缀。

参数

返回值

创建一个仅响应 OPTIONS 请求的路由。

参数

返回值

获取此作用域的参数名称/值。

返回值

如果它们是字符串，则解析默认值

参数

返回值

创建一个仅响应 PATCH 请求的路由。

参数

返回值

获取此作用域所在的路径。

返回值

添加插件路由。

此方法创建一个新的作用域路由集合，其中包含相关的插件信息。

插件名称将被变位为下划线版本以创建路由路径。如果您想要自定义路径名称，请使用 path 选项。

在作用域集合中连接的路由将具有正确的路径段前缀，并具有匹配的插件路由键设置。

选项

• path 要使用的路径前缀。默认为 Inflector::dasherize($name)。
• _namePrefix 为命名路由设置前缀。该前缀将附加到在作用域回调中创建的任何路由的名称之前。

参数

返回值

创建一个仅响应 POST 请求的路由。

参数

返回值

添加带前缀的路由。

此方法创建一个新的作用域路由集合，其中包含相关的前缀信息。

$name 参数用于生成路由参数名称。例如，admin 的路径会导致 'prefix' => 'admin' 应用于所有连接的路由。

您可以根据需要重新打开前缀，以及嵌套前缀。嵌套前缀将导致类似 admin/api 的前缀值，这将转换为 Controller\Admin\Api\ 命名空间。

如果您需要带有点的前缀，例如：'/api/v1.0'，请为 $params 参数使用 'path' 键

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

参数

返回值

抛出

创建一个仅响应 PUT 请求的路由。

参数

返回值

在路由器中连接新的重定向路由。

重定向路由与普通路由不同，因为如果找到匹配项，它们会执行实际的标头重定向。重定向可以在您的应用程序内发生，也可以重定向到外部位置。

示例

$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 并且不会丢失任何传递的参数。

参数

返回值

使用 RouteCollection 注册中间件。

注册中间件后，可以将其应用于当前路由范围或任何共享相同 RouteCollection 的子范围。

参数

返回值

另请参阅

为给定的控制器生成 REST 资源路由。

一种快速生成一组 REST 资源（控制器）的默认路由的方法。

用法

为应用程序控制器连接资源路由

$routes->resources('Posts');

为 Comments 插件中的 Comments 控制器连接资源路由

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

插件将创建小写短横线分隔的资源路由。例如 /comments/comments

为 Admin 前缀中的 Articles 控制器连接资源路由

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' => 'underscore']);

将生成类似 /payment-types 而不是 /payment_types 的路由

选项

• 'id' - 匹配 ID 时使用的正则表达式片段。默认情况下，匹配整数和 UUID。
• 'inflect' - 选择用于资源名称的词形变化方法。默认为 'dasherize'。
• 'only' - 仅连接特定操作列表。
• 'actions' - 覆盖用于连接操作的方法名称。
• 'map' - 应连接的额外资源路由。如果您定义了 'only' 和 'map'，请确保您映射的方法也包含在 'only' 列表中。
• 'prefix' - 为资源控制器定义路由前缀。如果当前范围定义了前缀，则此前缀将附加到该前缀。
• 'connectOptions' - 连接路由的自定义选项。
• 'path' - 更改路径，使其不匹配资源名称。例如 ArticlesController 在 /posts 中可用

参数

返回值

创建一个新的路由作用域。

使用此方法创建的范围将继承其添加到的范围的属性。这意味着当前路径和参数都将附加到提供的参数中。

$params 中的特殊键

• _namePrefix 为命名路由设置前缀。该前缀将附加到在作用域回调中创建的任何路由的名称之前。

参数

返回值

抛出

设置此路由构建器作用域中的扩展名。

通过此构建器连接的未来路由将应用连接的扩展。但是，设置扩展不会修改现有路由。

参数

返回值

设置默认路由类。

参数

返回值