milesjohnson

Add the route class to your Lib/Route folder and import the class in your config/routes.php.

App::import('Lib', 'Route/RedirectRoute');

Once imported, you will use the Router::connect() method to setup your route.

The first and second arguments will be the old URL respectively (in CakePHP format). The third argument will be an array of options; the following values are accepted: routeClass, redirect, status (optional, defaults to 301), after (optional), before (optional). The routeClass option is required and should be set to RedirectRoute. The redirect option will be an array of controller and action values, or a literal URL string. The status option will be the HTTP status code (301, 302, 303, 304, 305, 307). Read below for information on the before and after callbacks.

Below are a few examples on redirecting pages:

// Redirect /users/login/ to /account/login/
Router::connect('/users/login/*', array('controller' => 'users', 'action' => 'login'), array(
	'routeClass' => 'RedirectRoute',
	'redirect' => array('controller' => 'account', 'action' => 'login'),
	'status' => 307
));
 
// Redirect /blog/archives/tags/ to /blog/tags/
Router::connect('/blog/archives/tags/*', array('controller' => 'blog', 'action' => 'archives', 'tags'), array(
	'routeClass' => 'RedirectRoute',
	'redirect' => array('controller' => 'blog', 'action' => 'tags')
));

If you are running PHP 5.3 you can use a Closure to define before and after callbacks (the first argument will be the route object). If you are not running 5.3, you can create a new class that extends RedirectRoute and overwrite the before() and after() methods.

Router::connect('/users/login/*', array('controller' => 'users', 'action' => 'login'), array(
	'routeClass' => 'RedirectRoute',
	'redirect' => array('controller' => 'account', 'action' => 'login'),
	'status' => 307,
	'before' => function($route) {
		$route->options['redirect'] = '/url';
	},
	'after' => function($route) {
		header('X-Framework: CakePHP');
	}
));

Finally, if you need to pass dynamic variables, you simply write your connect() methods like before. Anything you define in the pass array will be replaced in the URL string. In the example below, the :tag string will be replaced with the value parsed from the URL.

Router::connect('/blog/archives/tags/:tag', array('controller' => 'blog', 'action' => 'archives', 'tags'), array(
	'routeClass' => 'RedirectRoute',
	'redirect' => array('controller' => 'blog', 'action' => 'tags', ':tag'),
	'tag' => '[a-zA-Z0-9\-\_]+',
	'pass' => array('tag')
));