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

Constructor

Options

• routeClass - The default route class to use when adding routes.
• extensions - The extensions to connect when adding routes.
• namePrefix - The prefix to prepend to all route names.
• middleware - The names of the middleware routes should have applied.

Parameters

_makeRoute(Cake\Routing\Route\Route|string $route, array $defaults, array<string, mixed> $options): Cake\Routing\Route\Route

Create a route object, or return the provided object.

Parameters

Returns

Throws

_methodRoute(string $method, string $template, array|string $target, string|null $name): Cake\Routing\Route\Route

Helper to create routes that only respond to a single HTTP method.

Parameters

Returns

addExtensions(array<string>|string $extensions): $this

Add additional extensions to what is already in current scope

Parameters

Returns

applyMiddleware(string ...$names): $this

Apply a middleware to the current route scope.

Requires middleware to be registered via registerMiddleware()

Parameters

Returns

Throws

See Also

connect(Cake\Routing\Route\Route|string $route, array|string $defaults = [], array<string, mixed> $options = []): Cake\Routing\Route\Route

Connects a new Route.

Routes are a way of connecting request URLs to objects in your application. At their core routes are a set or regular expressions that are used to match requests to destinations.

Examples:

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

The first parameter will be used as a controller name while the second is used as the action name. The '/*' syntax makes this route greedy in that it will match requests like /posts/index as well as requests like /posts/edit/1/foo/bar.

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

The above shows the use of route parameter defaults. And providing routing parameters for a static route.

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

Shows connecting a route with custom route parameters as well as providing patterns for those parameters. Patterns for routing parameters do not need capturing groups, as one will be added for each route params.

$options offers several 'special' keys that have special meaning in the $options array.

• routeClass is used to extend and change how individual routes parse requests and handle reverse routing, via a custom routing class. Ex. 'routeClass' => 'SlugRoute'
• pass is used to define which of the routed parameters should be shifted into the pass array. Adding a parameter to pass will remove it from the regular route array. Ex. 'pass' => ['slug'].
• persist is used to define which route parameters should be automatically included when generating new URLs. You can override persistent parameters by redefining them in a URL or remove them by setting the parameter to false. Ex. 'persist' => ['lang']
• multibytePattern Set to true to enable multibyte pattern support in route parameter patterns.
• _name is used to define a specific name for routes. This can be used to optimize reverse routing lookups. If undefined a name will be generated for each connected route.
• _ext is an array of filename extensions that will be parsed out of the url if present. See {@link \Cake\Routing\RouteCollection::setExtensions()}.
• _method Only match requests with specific HTTP verbs.
• _host - Define the host name pattern if you want this route to only match specific host names. You can use .* and to create wildcard subdomains/hosts e.g. *.example.com matches all subdomains on example.com.
• '_port` - Define the port if you want this route to only match specific port number.

Example of using the _method condition:

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

The above route will only be matched for GET requests. POST requests will fail to match this route.

Parameters

Returns

Throws

delete(string $template, array|string $target, string|null $name = null): Cake\Routing\Route\Route

Create a route that only responds to DELETE requests.

Parameters

Returns

fallbacks(string|null $routeClass = null): $this

Connect the /{controller} and /{controller}/{action}/* fallback routes.

This is a shortcut method for connecting fallback routes in a given scope.

Parameters

Returns

get(string $template, array|string $target, string|null $name = null): Cake\Routing\Route\Route

Create a route that only responds to GET requests.

Parameters

Returns

getExtensions(): array<string>

Get the extensions in this route builder's scope.

Returns

getMiddleware(): array

Get the middleware that this builder will apply to routes.

Returns

getRouteClass(): string

Get default route class.

Returns

head(string $template, array|string $target, string|null $name = null): Cake\Routing\Route\Route

Create a route that only responds to HEAD requests.

Parameters

Returns

loadPlugin(string $name): $this

Load routes from a plugin.

The routes file will have a local variable named $routes made available which contains the current RouteBuilder instance.

Parameters

Returns

Throws

middlewareGroup(string $name, array<string> $middlewareNames): $this

Apply a set of middleware to a group

Parameters

Returns

nameExists(string $name): bool

Checks if there is already a route with a given name.

Parameters

Returns

namePrefix(string|null $value = null): string

Get/set the name prefix for this scope.

Modifying the name prefix will only change the prefix used for routes connected after the prefix is changed.

Parameters

Returns

options(string $template, array|string $target, string|null $name = null): Cake\Routing\Route\Route

Create a route that only responds to OPTIONS requests.

Parameters

Returns

params(): array

Get the parameter names/values for this scope.

Returns

parseDefaults(array|string $defaults): array

Parse the defaults if they're a string

Parameters

Returns

patch(string $template, array|string $target, string|null $name = null): Cake\Routing\Route\Route

Create a route that only responds to PATCH requests.

Parameters

Returns

path(): string

Get the path this scope is for.

Returns

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

Add plugin routes.

This method creates a new scoped route collection that includes relevant plugin information.

The plugin name will be inflected to the underscore version to create the routing path. If you want a custom path name, use the path option.

Routes connected in the scoped collection will have the correct path segment prepended, and have a matching plugin routing key set.

Options

• path The path prefix to use. Defaults to Inflector::dasherize($name).
• _namePrefix Set a prefix used for named routes. The prefix is prepended to the name of any route created in a scope callback.

Parameters

Returns

post(string $template, array|string $target, string|null $name = null): Cake\Routing\Route\Route

Create a route that only responds to POST requests.

Parameters

Returns

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

Add prefixed routes.

This method creates a scoped route collection that includes relevant prefix information.

The $name parameter is used to generate the routing parameter name. For example a path of admin would result in 'prefix' => 'admin' being applied to all connected routes.

You can re-open a prefix as many times as necessary, as well as nest prefixes. Nested prefixes will result in prefix values like admin/api which translates to the Controller\Admin\Api\ namespace.

If you need to have prefix with dots, eg: '/api/v1.0', use 'path' key for $params argument:

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

Parameters

Returns

Throws

put(string $template, array|string $target, string|null $name = null): Cake\Routing\Route\Route

Create a route that only responds to PUT requests.

Parameters

Returns

redirect(string $route, array|string $url, array<string, mixed> $options = []): Cake\Routing\Route\RouteCake\Routing\Route\RedirectRoute

Connects a new redirection Route in the router.

Redirection routes are different from normal routes as they perform an actual header redirection if a match is found. The redirection can occur within your application or redirect to an outside location.

Examples:

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

Redirects /home/* to /posts/view and passes the parameters to /posts/view. Using an array as the redirect destination allows you to use other routes to define where a URL string should be redirected to.

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

Redirects /posts/* to http://google.com with a HTTP status of 302

Options:

• status Sets the HTTP status (default 301)
• persist Passes the params to the redirected route, if it can. This is useful with greedy routes, routes that end in * are greedy. As you can remap URLs and not lose any passed args.

Parameters

Returns

registerMiddleware(string $name, Psr\Http\Server\MiddlewareInterfaceClosure|string $middleware): $this

Register a middleware with the RouteCollection.

Once middleware has been registered, it can be applied to the current routing scope or any child scopes that share the same RouteCollection.

Parameters

Returns

See Also

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

Generate REST resource routes for the given controller(s).

A quick way to generate a default routes to a set of REST resources (controller(s)).

Usage

Connect resource routes for an app controller:

$routes->resources('Posts');

Connect resource routes for the Comments controller in the Comments plugin:

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

Plugins will create lowercase dasherized resource routes. e.g /comments/comments

Connect resource routes for the Articles controller in the Admin prefix:

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

Prefixes will create lowercase dasherized resource routes. e.g /admin/posts

You can create nested resources by passing a callback in:

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

The above would generate both resource routes for /articles, and /articles/{article_id}/comments. You can use the map option to connect additional resource methods:

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

In addition to the default routes, this would also connect a route for /articles/delete_all. By default, the path segment will match the key name. You can use the 'path' key inside the resource definition to customize the path name.

You can use the inflect option to change how path segments are generated:

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

Will generate routes like /payment-types instead of /payment_types

Options:

• 'id' - The regular expression fragment to use when matching IDs. By default, matches integer values and UUIDs.
• 'inflect' - Choose the inflection method used on the resource name. Defaults to 'dasherize'.
• 'only' - Only connect the specific list of actions.
• 'actions' - Override the method names used for connecting actions.
• 'map' - Additional resource routes that should be connected. If you define 'only' and 'map', make sure that your mapped methods are also in the 'only' list.
• 'prefix' - Define a routing prefix for the resource controller. If the current scope defines a prefix, this prefix will be appended to it.
• 'connectOptions' - Custom options for connecting the routes.
• 'path' - Change the path so it doesn't match the resource name. E.g ArticlesController is available at /posts

Parameters

Returns

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

Create a new routing scope.

Scopes created with this method will inherit the properties of the scope they are added to. This means that both the current path and parameters will be appended to the supplied parameters.

Special Keys in $params

• _namePrefix Set a prefix used for named routes. The prefix is prepended to the name of any route created in a scope callback.

Parameters

Returns

Throws

setExtensions(array<string>|string $extensions): $this

Set the extensions in this route builder's scope.

Future routes connected in through this builder will have the connected extensions applied. However, setting extensions does not modify existing routes.

Parameters

Returns

setRouteClass(string $routeClass): $this

Set default route class.

Parameters

Returns