Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Added a simple Locale selector filter for using the preferred user la…
…nguage
- Loading branch information
Showing
1 changed file
with
67 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
<?php | ||
/** | ||
* 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 | ||
* @since 3.0.0 | ||
* @license http://www.opensource.org/licenses/mit-license.php MIT License | ||
*/ | ||
namespace Cake\Routing\Filter; | ||
|
||
use Cake\Event\Event; | ||
use Cake\Routing\DispatcherFilter; | ||
use Locale; | ||
|
||
/** | ||
* Sets the runtime default locale for the request based on the | ||
* Accept-Language header. The default will only be set if it | ||
* matches the list of passed valid locales. | ||
*/ | ||
class LocaleSelectorFilter extends DispatcherFilter { | ||
|
||
/** | ||
* List of valid locales for the request | ||
* | ||
* @var array | ||
*/ | ||
protected $_locales = []; | ||
|
||
/** | ||
* Constructor. | ||
* | ||
* @param array $config Settings for the filter. | ||
* @throws \Cake\Error\Exception When 'when' conditions are not callable. | ||
*/ | ||
public function __construct($config = []) { | ||
parent::__construct($config); | ||
if (!empty($config['locales'])) { | ||
$this->_locales = $config['locales']; | ||
} | ||
} | ||
|
||
/** | ||
* Inspects the request for the Accept-Langauge header and sets the default | ||
* Locale for the current runtime if it matches the list of valid locales | ||
* as passed in the configuration. | ||
* | ||
* @param \Cake\Event\Event $event The event instance. | ||
* @return void | ||
*/ | ||
public function beforeDispatch(Event $event) { | ||
$request = $event->data['request']; | ||
$locale = Locale::acceptFromHttp($request->header('Accept-Language')); | ||
|
||
if (!$locale || (!empty($this->_locales) && !in_array($locale, $this->_locales))) { | ||
return; | ||
} | ||
|
||
Locale::setDefault($locale); | ||
} | ||
|
||
} |