Localized routing in CakePHP: How to redirect to default language

Question

Since 2012, this post appears to be the most definitive resource on how to do localized routes in CakePHP (code copied below).

It works great, with one exception: it doesn't redirect requests that are missing the language prefix. For example, http://example.com will show the same content as http://example.com/eng (if English is the default language). And similarly, if it's not the homepage: http://example.com/foo/bar/ => http://example.com/eng/foo/bar. There is some mention of this problem in the comments, but no conclusive solution, which is what I'm looking for.

Code.

// Step 1: app/Config/routes.php
Router::connect('/:language/:controller/:action/*',
                  array(),
                  array('language' => 'eng|fra'));

Router::connect('/:language/:controller',
                  array('action' => 'index'),
                  array('language' => 'eng|fra'));  

Router::connect('/:language',
                  array('controller' => 'welcome', 'action' => 'index'),
                  array('language' => 'eng|fra'));

//Step 2: app/Config/core.php
Configure::write('Config.language', 'eng');

//Step 3: create app/View/Helper/MyHtmlHelper.php
App::uses('HtmlHelper', 'View/Helper');
class MyHtmlHelper extends HtmlHelper {
    public function url($url = null, $full = false) {
        if(!isset($url['language']) && isset($this->params['language'])) {
          $url['language'] = $this->params['language'];
        }
        return parent::url($url, $full);
   }
}

//Step 4: app/Controller/AppController.php
class AppController extends Controller {
    public $components = array('Cookie','Session');
    //set an alias for the newly created helper: Html<->MyHtml
    public $helpers = array('Html' => array('className' => 'MyHtml'));

    public function beforeFilter() {
          $this->_setLanguage();
        }

    private function _setLanguage() {
    //if the cookie was previously set, and Config.language has not been set
    //write the Config.language with the value from the Cookie
        if ($this->Cookie->read('lang') && !$this->Session->check('Config.language')) {
            $this->Session->write('Config.language', $this->Cookie->read('lang'));
        } 
        //if the user clicked the language URL 
        else if (   isset($this->params['language']) && 
        ($this->params['language'] !=  $this->Session->read('Config.language'))
                ) {
            //then update the value in Session and the one in Cookie
            $this->Session->write('Config.language', $this->params['language']);
            $this->Cookie->write('lang', $this->params['language'], false, '20 days');
        }
    }

    //override redirect
    public function redirect( $url, $status = NULL, $exit = true ) {
        if (!isset($url['language']) && $this->Session->check('Config.language')) {
            $url['language'] = $this->Session->read('Config.language');
        }
        parent::redirect($url,$status,$exit);
    }
}

//add the links to the languages:
//Step 5: app/View/...
echo $this->Html->link('English', array('language'=>'eng')); 
echo $this->Html->link('Français', array('language'=>'fra'));

UPDATE 1

I tried the suggestion by user221931, but it doesn't seem to work. Here is what I added to my routes:

/* Add default language param */
Router::redirect('/:controller/:action/*', 
                    array('language' => 'fra'), 
                    array('persist' => false) );
Router::redirect('/:controller/', 
                    array('language' => 'fra'), 
                    array('persist' => false) );
Router::redirect('/', 
                    array('controller'=>'pages', 'action'=>'display', 'language' => 'fra', 'home'), 
                    array('persist' => false) );

It seems to have no effect. The following URLs are not redirected: http:example.com/, http://example.com/controller/, http://example.com/controller/action/

UPDATE 2 As requested, here is my complete routes file:

<?php
/**
 * Routes configuration
 *
 * In this file, you set up routes to your controllers and their actions.
 * Routes are very important mechanism that allows you to freely connect
 * different URLs to chosen controllers and their actions (functions).
 *
 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 * @link          http://cakephp.org CakePHP(tm) Project
 * @package       app.Config
 * @since         CakePHP(tm) v 0.2.9
 * @license       http://www.opensource.org/licenses/mit-license.php MIT License
 */

#http://book.cakephp.org/2.0/en/views/json-and-xml-views.html
Router::parseExtensions('json');

/**
 * Here, we are connecting '/' (base path) to controller called 'Pages',
 * its action called 'display', and we pass a param to select the view file
 * to use (in this case, /app/View/Pages/home.ctp)...
 */
    Router::connect('/', array('controller' => 'pages', 'action' => 'display', 'home'));
/**
 * ...and connect the rest of 'Pages' controller's URLs.
 */
    Router::connect('/pages/*', array('controller' => 'pages', 'action' => 'display'));


/**
 * LOCALIZED URLs
 * See: http://colorblindprogramming.com/multiple-languages-in-a-cakephp-2-application-in-5-steps
 */
Router::connect('/:language/:controller/:action/*',
                       array(),
                       array('language' => 'eng|fra'));

Router::connect('/:language/:controller',
                   array('action' => 'index'),
                   array('language' => 'eng|fra')); 

Router::connect('/:language',
                   array('controller' => 'pages', 'action' => 'display', 'home'),
                   array('language' => 'eng|fra'));

# prevent routing conflicts with plugins...
# http://www.omaroid.com/cakephp-locale-language-routing/
// make an array of loaded plugins
$loaded = CakePlugin::loaded();
array_walk($loaded, function(&$item,$key){
    $item = Inflector::underscore($item);
});
$loaded = implode('|', $loaded);

Router::connect('/:language/:plugin/:controller/:action/*', 
                    array(), 
                    array('language' => 'eng|fra','plugin' => "($loaded)"));

/* HIDE /index */
//Router::connect('/:controller/', array('action'=>'index') );
Router::connect('/:language/:controller/', array('action'=>'index') );

/**
 * Load all plugin routes. See the CakePlugin documentation on
 * how to customize the loading of plugin routes.
 */
    CakePlugin::routes();

/**
 * Load the CakePHP default routes. Only remove this if you do not want to use
 * the built-in default routes.
 */
    require CAKE . 'Config' . DS . 'routes.php';

bancer bancer · Accepted Answer · 2014-12-09T21:34:39

That is pretty simple to do from AppController.php:

const DEFAULT_LANGUAGE = 'eng';
public function beforeFilter() {
    parent::beforeFilter();
    if (empty($this->params['language'])) {
        $this->redirect(array('language' => self::DEFAULT_LANGUAGE));
    }
}

Localized routing in CakePHP: How to redirect to default language

2 Answers