CakePHP 中的本地化路由:如何重定向到默认语言


Localized routing in CakePHP: How to redirect to default language

自2012年以来,这篇文章似乎是关于如何在CakePHP中进行本地化路由的最权威的资源(代码复制如下(。

工作得很好,但有一个例外:它不会重定向缺少语言前缀的请求。例如,http://example.com 将显示与 http://example.com/eng 相同的内容(如果英语是默认语言(。同样,如果不是主页:http://example.com/foo/bar/=> http://example.com/eng/foo/bar。评论中提到了这个问题,但没有确凿的解决方案,这正是我正在寻找的。

法典。

// 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')); 

更新 1

我尝试了user221931的建议,但它似乎不起作用。以下是我添加到路线中的内容:

/* 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) );

似乎没有效果。以下 URL 不会被重定向:http:example.com/、http://example.com/controller/、http://example.com/controller/action/

更新 2根据要求,这是我的完整路由文件:

<?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';

从 AppController .php 中做到这一点非常简单:

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

您添加了非常具体的语言路由(如果url路径的第一部分是engfra(,但没有删除默认路由(Router::connect('/:controller/:action/*'(,因此如果找不到这两个单词,则更通用的/:controller/:action/*路由将匹配。

您可以执行以下三项操作之一:

  1. 删除默认路由,这将使/:controller/:action/*/:controller/*无法路由,并且没有人能够形成在没有语言的情况下访问内容的 URL。
  2. 添加重定向到eng的硬编码routes,即 /users -> /eng/users/posts/ -> /eng/posts 等(。这似乎需要做很多工作,但是虽然模式匹配对于开发来说是可以的,但硬编码可以显着提高路由速度,因此将来可能需要这样做。它的另一个优点是您可以添加一个persist规则,使浏览器记住重定向并且不再访问服务器。
  3. AppController中添加代码,该代码将检查路径中是否包含语言,如果没有,请尝试从浏览器设置中猜测用户的语言,以便重定向到最合适的 URL 或默认值。

数字 1 是最简单、最干净和最快的,但如果你的控制器不需要前面有语言,则可能不合适。

数字 2 不会让您选择重定向到哪种语言,因为它将被硬编码。根据应用程序的不同,它可能完全没问题。

从UX的角度来看,数字3是最优雅的解决方案,但是在每个页面加载中都会产生一些轻微的开销(通过检查语言(。