W3cubDocs

/CakePHP 3.8

Class RouteBuilder

Provides features for building routes inside scopes.

Gives an easy to use way to build routes and append them into a route collection.

Namespace: Cake\Routing
Location: Routing/RouteBuilder.php

Constants summary

  • string

    ID
    '[0-9]+'
  • string

    UUID
    '[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}'

Properties summary

  • $_collection protected
    Cake\Routing\RouteCollection
    The route collection routes should be added to.
  • $_extensions protected
    array
    The extensions that should be set into the routes connected.
  • $_namePrefix protected
    string
    Name prefix for connected routes.
  • $_params protected
    array
    The scope parameters if there are any.
  • $_path protected
    string
    The path prefix scope that this collection uses.
  • $_resourceMap protected static
    array
    Default HTTP request method => controller action map.
  • $_routeClass protected
    string
    Default route class to use if none is provided in connect() options.
  • $middleware protected
    array

    The list of middleware that routes in this builder get added during construction.

Method Summary

  • __construct() public
    Constructor
  • _makeRoute() protected
    Create a route object, or return the provided object.
  • _methodRoute() protected
    Helper to create routes that only respond to a single HTTP method.
  • Add additional extensions to what is already in current scope
  • Apply a middleware to the current route scope.
  • connect() public
    Connects a new Route.
  • delete() public
    Create a route that only responds to DELETE requests.
  • extensions() public deprecated
    Get or set the extensions in this route builder's scope.
  • fallbacks() public
    Connect the /:controller and /:controller/:action/* fallback routes.
  • get() public
    Create a route that only responds to GET requests.
  • Get the extensions in this route builder's scope.
  • Get default route class.
  • head() public
    Create a route that only responds to HEAD requests.
  • loadPlugin() public
    Load routes from a plugin.
  • Apply a set of middleware to a group
  • nameExists() public
    Checks if there is already a route with a given name.
  • namePrefix() public
    Get/set the name prefix for this scope.
  • options() public
    Create a route that only responds to OPTIONS requests.
  • params() public
    Get the parameter names/values for this scope.
  • parseDefaults() protected static
    Parse the defaults if they're a string
  • patch() public
    Create a route that only responds to PATCH requests.
  • path() public
    Get the path this scope is for.
  • plugin() public
    Add plugin routes.
  • post() public
    Create a route that only responds to POST requests.
  • prefix() public
    Add prefixed routes.
  • put() public
    Create a route that only responds to PUT requests.
  • redirect() public
    Connects a new redirection Route in the router.
  • Register a middleware with the RouteCollection.
  • resources() public
    Generate REST resource routes for the given controller(s).
  • routeClass() public deprecated
    Get or set default route class.
  • scope() public
    Create a new routing scope.
  • Set the extensions in this route builder's scope.
  • Set default route class.

Method Detail

__construct()source public

__construct( Cake\Routing\RouteCollection $collection , string $path , array $params = [] , array $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

Cake\Routing\RouteCollection $collection
The route collection to append routes into.
string $path
The path prefix the scope is for.
array $params optional []
The scope's routing parameters.
array $options optional []
Options list.

_makeRoute()source protected

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

Create a route object, or return the provided object.

Parameters

string|Cake\Routing\Route\Route $route
The route template or route object.
array $defaults
Default parameters.
array $options
Additional options parameters.

Returns

Cake\Routing\Route\Route

Throws

InvalidArgumentException
when route class or route object is invalid.
BadMethodCallException
when the route to make conflicts with the current scope

_methodRoute()source protected

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

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

Parameters

string $method
The HTTP method name to match.
string $template
The URL template to use.
array $target

An array describing the target route parameters. These parameters should indicate the plugin, prefix, controller, and action that this route points to.

string $name
The name of the route.

Returns

Cake\Routing\Route\Route

addExtensions()source public

addExtensions( string|array $extensions )

Add additional extensions to what is already in current scope

Parameters

string|array $extensions
One or more extensions to add

applyMiddleware()source public

applyMiddleware( ... $names )

Apply a middleware to the current route scope.

Requires middleware to be registered via registerMiddleware()

Parameters

... $names
$names The names of the middleware to apply to the current scope.

Returns


$this

See

\Cake\Routing\RouteCollection::addMiddlewareToScope()

connect()source public

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

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 \Cake\Routing\RouteCollection::setExtensions().
  • _method Only match requests with specific HTTP verbs.

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

string $route
A string describing the template of the route
array|string $defaults optional []

An array describing the default route parameters. These parameters will be used by default and can supply routing parameters that are not dynamic. See above.

array $options optional []

An array matching the named elements in the route to regular expressions which that element should match. Also contains additional parameters such as which routed parameters should be shifted into the passed arguments, supplying patterns for routing parameters and supplying the name of a custom routing class.

Returns

Cake\Routing\Route\Route

Throws

InvalidArgumentException
BadMethodCallException

delete()source public

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

Create a route that only responds to DELETE requests.

Parameters

string $template
The URL template to use.
array $target

An array describing the target route parameters. These parameters should indicate the plugin, prefix, controller, and action that this route points to.

string $name optional null
The name of the route.

Returns

Cake\Routing\Route\Route

extensions()source public deprecated

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

Get or 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.

Deprecated

3.5.0 Use getExtensions/setExtensions instead.

Parameters

null|string|array $extensions optional null
Either the extensions to use or null.

Returns

array|null

fallbacks()source public

fallbacks( string|null $routeClass = null )

Connect the /:controller and /:controller/:action/* fallback routes.

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

Parameters

string|null $routeClass optional null

the route class to use, uses the default routeClass if not specified

get()source public

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

Create a route that only responds to GET requests.

Parameters

string $template
The URL template to use.
array $target

An array describing the target route parameters. These parameters should indicate the plugin, prefix, controller, and action that this route points to.

string $name optional null
The name of the route.

Returns

Cake\Routing\Route\Route

getExtensions()source public

getExtensions( )

Get the extensions in this route builder's scope.

Returns

array

getRouteClass()source public

getRouteClass( )

Get default route class.

Returns

string

head()source public

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

Create a route that only responds to HEAD requests.

Parameters

string $template
The URL template to use.
array $target

An array describing the target route parameters. These parameters should indicate the plugin, prefix, controller, and action that this route points to.

string $name optional null
The name of the route.

Returns

Cake\Routing\Route\Route

loadPlugin()source public

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

Load routes from a plugin.

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

Parameters

string $name
The plugin name
string $file optional 'routes.php'

The routes file to load. Defaults to routes.php. This parameter is deprecated and will be removed in 4.0

Throws

Cake\Core\Exception\MissingPluginException
When the plugin has not been loaded.
InvalidArgumentException
When the plugin does not have a routes file.

middlewareGroup()source public

middlewareGroup( string $name , array $middlewareNames )

Apply a set of middleware to a group

Parameters

string $name
Name of the middleware group
array $middlewareNames
Names of the middleware

Returns


$this

nameExists()source public

nameExists( string $name )

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

Parameters

string $name
Name.

Returns

boolean

namePrefix()source public

namePrefix( string|null $value = null )

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

string|null $value optional null
Either the value to set or null.

Returns

string

options()source public

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

Create a route that only responds to OPTIONS requests.

Parameters

string $template
The URL template to use.
array $target

An array describing the target route parameters. These parameters should indicate the plugin, prefix, controller, and action that this route points to.

string $name optional null
The name of the route.

Returns

Cake\Routing\Route\Route

params()source public

params( )

Get the parameter names/values for this scope.

Returns

array

parseDefaults()source protected static

parseDefaults( string|array $defaults )

Parse the defaults if they're a string

Parameters

string|array $defaults
Defaults array from the connect() method.

Returns

string|array

patch()source public

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

Create a route that only responds to PATCH requests.

Parameters

string $template
The URL template to use.
array $target

An array describing the target route parameters. These parameters should indicate the plugin, prefix, controller, and action that this route points to.

string $name optional null
The name of the route.

Returns

Cake\Routing\Route\Route

path()source public

path( )

Get the path this scope is for.

Returns

string

plugin()source public

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

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.

Parameters

string $name
The plugin name to build routes for
array|callable $options optional []
Either the options to use, or a callback
callable|null $callback optional null

The callback to invoke that builds the plugin routes Only required when $options is defined.

post()source public

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

Create a route that only responds to POST requests.

Parameters

string $template
The URL template to use.
array $target

An array describing the target route parameters. These parameters should indicate the plugin, prefix, controller, and action that this route points to.

string $name optional null
The name of the route.

Returns

Cake\Routing\Route\Route

prefix()source public

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

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

string $name
The prefix name to use.
array|callable $params optional []

An array of routing defaults to add to each connected route. If you have no parameters, this argument can be a callable.

callable $callback optional null
The callback to invoke that builds the prefixed routes.

Throws

InvalidArgumentException
If a valid callback is not passed

put()source public

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

Create a route that only responds to PUT requests.

Parameters

string $template
The URL template to use.
array $target

An array describing the target route parameters. These parameters should indicate the plugin, prefix, controller, and action that this route points to.

string $name optional null
The name of the route.

Returns

Cake\Routing\Route\Route

redirect()source public

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

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

string $route
A string describing the template of the route
array|string $url
A URL to redirect to. Can be a string or a Cake array-based URL
array $options optional []

An array matching the named elements in the route to regular expressions which that element should match. Also contains additional parameters such as which routed parameters should be shifted into the passed arguments. As well as supplying patterns for routing parameters.

Returns

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

registerMiddleware()source public

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

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

string $name
The name of the middleware. Used when applying middleware to a scope.
callable|string $middleware
The middleware callable or class name to register.

Returns


$this

See

\Cake\Routing\RouteCollection

resources()source public

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

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 lower_case underscored 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 lower_case underscored 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' => 'dasherize']);

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 'underscore'.
  • '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

string $name
A controller name to connect resource routes for.
array|callable $options optional []
Options to use when generating REST routes, or a callback.
callable|null $callback optional null

An optional callback to be executed in a nested scope. Nested scopes inherit the existing path and 'id' parameter.

routeClass()source public deprecated

routeClass( string|null $routeClass = null )

Get or set default route class.

Deprecated

3.5.0 Use getRouteClass/setRouteClass instead.

Parameters

string|null $routeClass optional null
Class name.

Returns

string|null

scope()source public

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

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.

Parameters

string $path
The path to create a scope for.
array|callable $params
Either the parameters to add to routes, or a callback.
callable|null $callback optional null

The callback to invoke that builds the plugin routes. Only required when $params is defined.

Throws

InvalidArgumentException
when there is no callable parameter.

setExtensions()source public

setExtensions( string|array $extensions )

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

string|array $extensions
The extensions to set.

Returns


$this

setRouteClass()source public

setRouteClass( string $routeClass )

Set default route class.

Parameters

string $routeClass
Class name.

Returns


$this

Properties detail

$_collectionsource

protected Cake\Routing\RouteCollection

The route collection routes should be added to.

$_extensionssource

protected array

The extensions that should be set into the routes connected.

[]

$_namePrefixsource

protected string

Name prefix for connected routes.

''

$_paramssource

protected array

The scope parameters if there are any.

$_pathsource

protected string

The path prefix scope that this collection uses.

$_resourceMapsource

protected static array

Default HTTP request method => controller action map.

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

$_routeClasssource

protected string

Default route class to use if none is provided in connect() options.

'Cake\Routing\Route\Route'

$middlewaresource

protected array

The list of middleware that routes in this builder get added during construction.

[]

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.8/class-Cake.Routing.RouteBuilder.html