HTTP Redirections

Sometimes, you need to redirect an old route to a new route. You have two methods to redirect route to another route.

With config

You can create a redirections.json file into your configuration directory and add a similar content:

{
  "berlioz": {
    "http": {
      "redirections": {
        "^/old$": "/new",
        "^/old-route/(.*)": "/new-route/$1",
        "^/another-old-route/": "/new/"
      }
    }
  }
}

The key berlioz.http.redirections is an JSON object. The key of property it's a regular expression to find, and the value is the replacement value.

In internal, Berlioz use preg_replace() PHP function. So you can use mask and replacement value with backreferences.

Examples for redirection with the config given in example above:

The default redirection HTTP status code is 301 Moved Permanently, so if you want specify another HTTP status code, it's possible with this config example:

{
  "berlioz": {
    "http": {
      "redirections": {
        "^/old$": {
          "url": "/new",
          "type": 302
        }
      }
    }
  }
}

In this example, the HTTP status code will be 302 Found.

With controller

You can create redirection with methods of controllers, to use redirection() helper, who redirect with 302 FoundHTTP status.

class MyController extends \Berlioz\Http\Core\Controller\AbstractController
{
    /**
     * @route( "/old-route" )
     */
    public function oldMethod(): Response
    {
        return $this->redirect('/new-route');
    }
}

If you can also generate the route from the router, like this:

use Berlioz\Http\Core\Attribute as Berlioz;
use Berlioz\Http\Core\Controller\AbstractController;
use Berlioz\Http\Message\Response;

class MyController extends AbstractController
{
    #[Berlioz\Route('/old-route')]
    public function oldMethod(): Response
    {
        return $this->redirect($this->getRouter()->generate('foo-route'));
    }

    #[Berlioz\Route('/new-route', name: 'foo-route')]
    public function newMethod(): Response
    {
        // ...
    }
}

If you want to specify the HTTP response code, pass it in the second parameter of redirect() method:

return $this->redirect('/new-route', 301);