1: <?php
 2: /**
 3:  * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
 4:  * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 5:  *
 6:  * Licensed under The MIT License
 7:  * For full copyright and license information, please see the LICENSE.txt
 8:  * Redistributions of files must retain the above copyright notice.
 9:  *
10:  * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
11:  * @link          https://cakephp.org CakePHP(tm) Project
12:  * @since         3.0.0
13:  * @license       https://opensource.org/licenses/mit-license.php MIT License
14:  */
15: namespace Cake\Routing\Filter;
16: 
17: use Cake\Event\Event;
18: use Cake\I18n\I18n;
19: use Cake\Routing\DispatcherFilter;
20: use Locale;
21: 
22: /**
23:  * Sets the runtime default locale for the request based on the
24:  * Accept-Language header. The default will only be set if it
25:  * matches the list of passed valid locales.
26:  */
27: class LocaleSelectorFilter extends DispatcherFilter
28: {
29:     /**
30:      * List of valid locales for the request
31:      *
32:      * @var array
33:      */
34:     protected $_locales = [];
35: 
36:     /**
37:      * Constructor.
38:      *
39:      * @param array $config Settings for the filter.
40:      * @throws \Cake\Core\Exception\Exception When 'when' conditions are not callable.
41:      */
42:     public function __construct($config = [])
43:     {
44:         parent::__construct($config);
45:         if (!empty($config['locales'])) {
46:             $this->_locales = $config['locales'];
47:         }
48:     }
49: 
50:     /**
51:      * Inspects the request for the Accept-Language header and sets the
52:      * Locale for the current runtime if it matches the list of valid locales
53:      * as passed in the configuration.
54:      *
55:      * @param \Cake\Event\Event $event The event instance.
56:      * @return void
57:      */
58:     public function beforeDispatch(Event $event)
59:     {
60:         /* @var \Cake\Http\ServerRequest $request */
61:         $request = $event->getData('request');
62:         $locale = Locale::acceptFromHttp($request->getHeaderLine('Accept-Language'));
63: 
64:         if (!$locale || (!empty($this->_locales) && !in_array($locale, $this->_locales))) {
65:             return;
66:         }
67: 
68:         I18n::setLocale($locale);
69:     }
70: }
71: