LanguageNegotiator::__construct() - Code Metrics - Inspection of "The language negotiator will convert the locale na..." - mcamara/laravel-localization - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 194435...e98428 )

by Marc

created 2017-11-11 13:24 UTC

LanguageNegotiator::__construct() B

↳ Parent: LanguageNegotiator

Complexity

Conditions	5
Paths	2

Size

Total Lines	25
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	0
loc	25
rs	8.439
cc	5
eloc	15
nc	2
nop	3

<?php

namespace Mcamara\LaravelLocalization;

use Illuminate\Http\Request;
use Locale;

class LanguageNegotiator
{
    /**
     * @var string
     */
    private $defaultLocale;

    /**
     * @var array
     */
    private $supportedLanguages;

    /**
     * @var Request
     */
    private $request;

    /**
     * @var bool
     */
    private $use_intl = false;

    /**
     * @param string  $defaultLocale
     * @param array   $supportedLanguages
     * @param Request $request
     */
    public function __construct($defaultLocale, $supportedLanguages, Request $request)

    {
        $this->defaultLocale = $defaultLocale;

        if (class_exists('Locale')) {
            $this->use_intl = true;

            foreach ($supportedLanguages as $key => $supportedLanguage) {
                if ( ! isset($supportedLanguage['lang'])) {
                    $supportedLanguage['lang'] = Locale::canonicalize($key);
                } else {
                    $supportedLanguage['lang'] = Locale::canonicalize($supportedLanguage['lang']);
                }
                if (isset($supportedLanguage['regional'])) {
                    $supportedLanguage['regional'] = Locale::canonicalize($supportedLanguage['regional']);
                }

                $this->supportedLanguages[$key] = $supportedLanguage;
            }
        } else {
            $this->supportedLanguages = $supportedLanguages;
        }

        $this->request = $request;
    }

    /**
     * Negotiates language with the user's browser through the Accept-Language
     * HTTP header or the user's host address.  Language codes are generally in
     * the form "ll" for a language spoken in only one country, or "ll-CC" for a
     * language spoken in a particular country.  For example, U.S. English is
     * "en-US", while British English is "en-UK".  Portuguese as spoken in
     * Portugal is "pt-PT", while Brazilian Portuguese is "pt-BR".
     *
     * This function is based on negotiateLanguage from Pear HTTP2
     * http://pear.php.net/package/HTTP2/
     *
     * Quality factors in the Accept-Language: header are supported, e.g.:
     *      Accept-Language: en-UK;q=0.7, en-US;q=0.6, no, dk;q=0.8
     *
     * @return string The negotiated language result or app.locale.
     */
    public function negotiateLanguage()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $matches = $this->getMatchesFromAcceptedLanguages();
        foreach ($matches as $key => $q) {
            if (!empty($this->supportedLanguages[$key])) {
                return $key;
            }

            if ($this->use_intl) {
                $key = Locale::canonicalize($key);
            }

            // Search for acceptable locale by 'regional' => 'af_ZA' or 'lang' => 'af-ZA' match.
            foreach ( $this->supportedLanguages as $key_supported => $locale ) {
                if ( (isset($locale['regional']) && $locale['regional'] == $key) || (isset($locale['lang']) && $locale['lang'] == $key) ) {
                    return $key_supported;
                }
            }
        }
        // If any (i.e. "*") is acceptable, return the first supported format
        if (isset($matches['*'])) {
            reset($this->supportedLanguages);

            return key($this->supportedLanguages);
        }

        if ($this->use_intl && !empty($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
            $http_accept_language = Locale::acceptFromHttp($_SERVER['HTTP_ACCEPT_LANGUAGE']);

            if (!empty($this->supportedLanguages[$http_accept_language])) {
                return $http_accept_language;
            }
        }

        if ($this->request->server('REMOTE_HOST')) {
            $remote_host = explode('.', $this->request->server('REMOTE_HOST'));
            $lang = strtolower(end($remote_host));

            if (!empty($this->supportedLanguages[$lang])) {
                return $lang;
            }
        }

        return $this->defaultLocale;
    }

    /**
     * Return all the accepted languages from the browser.
     *
     * @return array Matches from the header field Accept-Languages
     */
    private function getMatchesFromAcceptedLanguages()
    {
        $matches = [];

        if ($acceptLanguages = $this->request->header('Accept-Language')) {
            $acceptLanguages = explode(',', $acceptLanguages);

            $generic_matches = [];
            foreach ($acceptLanguages as $option) {
                $option = array_map('trim', explode(';', $option));
                $l = $option[0];
                if (isset($option[1])) {
                    $q = (float) str_replace('q=', '', $option[1]);
                } else {
                    $q = null;
                    // Assign default low weight for generic values
                    if ($l == '*/*') {
                        $q = 0.01;
                    } elseif (substr($l, -1) == '*') {
                        $q = 0.02;
                    }
                }
                // Unweighted values, get high weight by their position in the
                // list
                $q = isset($q) ? $q : 1000 - count($matches);
                $matches[$l] = $q;

                //If for some reason the Accept-Language header only sends language with country
                //we should make the language without country an accepted option, with a value
                //less than it's parent.
                $l_ops = explode('-', $l);
                array_pop($l_ops);
                while (!empty($l_ops)) {
                    //The new generic option needs to be slightly less important than it's base
                    $q -= 0.001;
                    $op = implode('-', $l_ops);
                    if (empty($generic_matches[$op]) || $generic_matches[$op] > $q) {
                        $generic_matches[$op] = $q;
                    }
                    array_pop($l_ops);
                }
            }
            $matches = array_merge($generic_matches, $matches);

            arsort($matches, SORT_NUMERIC);
        }

        return $matches;
    }
}


1			<?php
2
3			namespace Mcamara\LaravelLocalization;
4
5			use Illuminate\Http\Request;
6			use Locale;
7
8			class LanguageNegotiator
9			{
10			/**
11			* @var string
12			*/
13			private $defaultLocale;
14
15			/**
16			* @var array
17			*/
18			private $supportedLanguages;
19
20			/**
21			* @var Request
22			*/
23			private $request;
24
25			/**
26			* @var bool
27			*/
28			private $use_intl = false;
29
30			/**
31			* @param string $defaultLocale
32			* @param array $supportedLanguages
33			* @param Request $request
34			*/
35			public function __construct($defaultLocale, $supportedLanguages, Request $request)
			0 ignored issues – show Bug introduced 2015-11-27 12:37 UTC by Report Bug Copy Issue Report You have injected the Request via parameter `$request`. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via `getCurrentRequest()`. Loading history...
36			{
37			$this->defaultLocale = $defaultLocale;
38
39			if (class_exists('Locale')) {
40			$this->use_intl = true;
41
42			foreach ($supportedLanguages as $key => $supportedLanguage) {
43			if ( ! isset($supportedLanguage['lang'])) {
44			$supportedLanguage['lang'] = Locale::canonicalize($key);
45			} else {
46			$supportedLanguage['lang'] = Locale::canonicalize($supportedLanguage['lang']);
47			}
48			if (isset($supportedLanguage['regional'])) {
49			$supportedLanguage['regional'] = Locale::canonicalize($supportedLanguage['regional']);
50			}
51
52			$this->supportedLanguages[$key] = $supportedLanguage;
53			}
54			} else {
55			$this->supportedLanguages = $supportedLanguages;
56			}
57
58			$this->request = $request;
59			}
60
61			/**
62			* Negotiates language with the user's browser through the Accept-Language
63			* HTTP header or the user's host address. Language codes are generally in
64			* the form "ll" for a language spoken in only one country, or "ll-CC" for a
65			* language spoken in a particular country. For example, U.S. English is
66			* "en-US", while British English is "en-UK". Portuguese as spoken in
67			* Portugal is "pt-PT", while Brazilian Portuguese is "pt-BR".
68			*
69			* This function is based on negotiateLanguage from Pear HTTP2
70			* http://pear.php.net/package/HTTP2/
71			*
72			* Quality factors in the Accept-Language: header are supported, e.g.:
73			* Accept-Language: en-UK;q=0.7, en-US;q=0.6, no, dk;q=0.8
74			*
75			* @return string The negotiated language result or app.locale.
76			*/
77			public function negotiateLanguage()
			0 ignored issues – show Coding Style introduced 2017-08-02 09:51 UTC by Report Bug Copy Issue Report `negotiateLanguage` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
78			{
79			$matches = $this->getMatchesFromAcceptedLanguages();
80			foreach ($matches as $key => $q) {
81			if (!empty($this->supportedLanguages[$key])) {
82			return $key;
83			}
84
85			if ($this->use_intl) {
86			$key = Locale::canonicalize($key);
87			}
88
89			// Search for acceptable locale by 'regional' => 'af_ZA' or 'lang' => 'af-ZA' match.
90			foreach ( $this->supportedLanguages as $key_supported => $locale ) {
91			if ( (isset($locale['regional']) && $locale['regional'] == $key) \|\| (isset($locale['lang']) && $locale['lang'] == $key) ) {
92			return $key_supported;
93			}
94			}
95			}
96			// If any (i.e. "*") is acceptable, return the first supported format
97			if (isset($matches['*'])) {
98			reset($this->supportedLanguages);
99
100			return key($this->supportedLanguages);
101			}
102
103			if ($this->use_intl && !empty($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
104			$http_accept_language = Locale::acceptFromHttp($_SERVER['HTTP_ACCEPT_LANGUAGE']);
105
106			if (!empty($this->supportedLanguages[$http_accept_language])) {
107			return $http_accept_language;
108			}
109			}
110
111			if ($this->request->server('REMOTE_HOST')) {
112			$remote_host = explode('.', $this->request->server('REMOTE_HOST'));
113			$lang = strtolower(end($remote_host));
114
115			if (!empty($this->supportedLanguages[$lang])) {
116			return $lang;
117			}
118			}
119
120			return $this->defaultLocale;
121			}
122
123			/**
124			* Return all the accepted languages from the browser.
125			*
126			* @return array Matches from the header field Accept-Languages
127			*/
128			private function getMatchesFromAcceptedLanguages()
129			{
130			$matches = [];
131
132			if ($acceptLanguages = $this->request->header('Accept-Language')) {
133			$acceptLanguages = explode(',', $acceptLanguages);
134
135			$generic_matches = [];
136			foreach ($acceptLanguages as $option) {
137			$option = array_map('trim', explode(';', $option));
138			$l = $option[0];
139			if (isset($option[1])) {
140			$q = (float) str_replace('q=', '', $option[1]);
141			} else {
142			$q = null;
143			// Assign default low weight for generic values
144			if ($l == '/') {
145			$q = 0.01;
146			} elseif (substr($l, -1) == '*') {
147			$q = 0.02;
148			}
149			}
150			// Unweighted values, get high weight by their position in the
151			// list
152			$q = isset($q) ? $q : 1000 - count($matches);
153			$matches[$l] = $q;
154
155			//If for some reason the Accept-Language header only sends language with country
156			//we should make the language without country an accepted option, with a value
157			//less than it's parent.
158			$l_ops = explode('-', $l);
159			array_pop($l_ops);
160			while (!empty($l_ops)) {
161			//The new generic option needs to be slightly less important than it's base
162			$q -= 0.001;
163			$op = implode('-', $l_ops);
164			if (empty($generic_matches[$op]) \|\| $generic_matches[$op] > $q) {
165			$generic_matches[$op] = $q;
166			}
167			array_pop($l_ops);
168			}
169			}
170			$matches = array_merge($generic_matches, $matches);
171
172			arsort($matches, SORT_NUMERIC);
173			}
174
175			return $matches;
176			}
177			}
178

mcamara / laravel-localization

GitHub Access Token became invalid

Push — master ( 194435...e98428 )

LanguageNegotiator::__construct() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like