I18N::getMessageSource() - Code Metrics - Inspection of "Fixed `yii\i18n\PhpMessageSource::loadFallbackMess..." - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 11429-message-source ( f7ff15 )

by Dmitry

created 2016-05-11 22:30 UTC

I18N::getMessageSource() D

↳ Parent: I18N

Complexity

Conditions	9
Paths	10

Size

Total Lines	33
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	9.8886

Metric	Value
dl	0
loc	33
ccs	14
cts	18
cp	0.7778
rs	4.909
cc	9
eloc	21
nc	10
nop	1
crap	9.8886

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\i18n;

use Yii;
use yii\base\Component;
use yii\base\InvalidConfigException;

/**
 * I18N provides features related with internationalization (I18N) and localization (L10N).
 *
 * I18N is configured as an application component in [[\yii\base\Application]] by default.
 * You can access that instance via `Yii::$app->i18n`.
 *
 * @property MessageFormatter $messageFormatter The message formatter to be used to format message via ICU
 * message format. Note that the type of this property differs in getter and setter. See
 * [[getMessageFormatter()]] and [[setMessageFormatter()]] for details.
 *
 * @author Qiang Xue <[email protected]>
 * @since 2.0
 */
class I18N extends Component
{
    /**
     * @var array list of [[MessageSource]] configurations or objects. The array keys are message
     * category patterns, and the array values are the corresponding [[MessageSource]] objects or the configurations
     * for creating the [[MessageSource]] objects.
     *
     * The message category patterns can contain the wildcard '*' at the end to match multiple categories with the same prefix.
     * For example, 'app/*' matches both 'app/cat1' and 'app/cat2'.
     *
     * The '*' category pattern will match all categories that do not match any other category patterns.
     *
     * This property may be modified on the fly by extensions who want to have their own message sources
     * registered under their own namespaces.
     *
     * The category "yii" and "app" are always defined. The former refers to the messages used in the Yii core
     * framework code, while the latter refers to the default message category for custom application code.
     * By default, both of these categories use [[PhpMessageSource]] and the corresponding message files are
     * stored under "@yii/messages" and "@app/messages", respectively.
     *
     * You may override the configuration of both categories.
     */
    public $translations;


    /**
     * Initializes the component by configuring the default message categories.
     */
    public function init()
    {
        parent::init();
        if (!isset($this->translations['yii']) && !isset($this->translations['yii*'])) {
            $this->translations['yii'] = [
                'class' => 'yii\i18n\PhpMessageSource',
                'sourceLanguage' => 'en-US',
                'basePath' => '@yii/messages',
            ];
        }
        if (!isset($this->translations['app']) && !isset($this->translations['app*'])) {
            $this->translations['app'] = [
                'class' => 'yii\i18n\PhpMessageSource',
                'sourceLanguage' => Yii::$app->sourceLanguage,
                'basePath' => '@app/messages',
            ];
        }
    }

    /**
     * Translates a message to the specified language.
     *
     * After translation the message will be formatted using [[MessageFormatter]] if it contains
     * ICU message format and `$params` are not empty.
     *
     * @param string $category the message category.
     * @param string $message the message to be translated.
     * @param array $params the parameters that will be used to replace the corresponding placeholders in the message.
     * @param string $language the language code (e.g. `en-US`, `en`).
     * @return string the translated and formatted message.
     */
    public function translate($category, $message, $params, $language)
    {
        $messageSource = $this->getMessageSource($category);
        $translation = $messageSource->translate($category, $message, $language);
        if ($translation === false) {
            return $this->format($message, $params, $messageSource->sourceLanguage);
        } else {
            return $this->format($translation, $params, $language);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        }
    }

    /**
     * Formats a message using [[MessageFormatter]].
     *
     * @param string $message the message to be formatted.
     * @param array $params the parameters that will be used to replace the corresponding placeholders in the message.
     * @param string $language the language code (e.g. `en-US`, `en`).
     * @return string the formatted message.
     */
    public function format($message, $params, $language)
    {
        $params = (array) $params;
        if ($params === []) {
            return $message;
        }

        if (preg_match('~{\s*[\d\w]+\s*,~u', $message)) {
            $formatter = $this->getMessageFormatter();
            $result = $formatter->format($message, $params, $language);
            if ($result === false) {
                $errorMessage = $formatter->getErrorMessage();
                Yii::warning("Formatting message for language '$language' failed with error: $errorMessage. The message being formatted was: $message.", __METHOD__);

                return $message;
            } else {
                return $result;
            }
        }

        $p = [];
        foreach ($params as $name => $value) {
            $p['{' . $name . '}'] = $value;
        }

        return strtr($message, $p);
    }

    /**
     * @var string|array|MessageFormatter
     */
    private $_messageFormatter;

    /**
     * Returns the message formatter instance.
     * @return MessageFormatter the message formatter to be used to format message via ICU message format.
     */
    public function getMessageFormatter()
    {
        if ($this->_messageFormatter === null) {
            $this->_messageFormatter = new MessageFormatter();
        } elseif (is_array($this->_messageFormatter) || is_string($this->_messageFormatter)) {
            $this->_messageFormatter = Yii::createObject($this->_messageFormatter);
        }

        return $this->_messageFormatter;
    }

    /**
     * @param string|array|MessageFormatter $value the message formatter to be used to format message via ICU message format.
     * Can be given as array or string configuration that will be given to [[Yii::createObject]] to create an instance
     * or a [[MessageFormatter]] instance.
     */
    public function setMessageFormatter($value)
    {
        $this->_messageFormatter = $value;
    }

    /**
     * Returns the message source for the given category.
     * @param string $category the category name.
     * @return MessageSource the message source for the given category.
     * @throws InvalidConfigException if there is no message source available for the specified category.
     */
    public function getMessageSource($category)
    {
        if (isset($this->translations[$category])) {
            $source = $this->translations[$category];
            if ($source instanceof MessageSource) {
                return $source;
            } else {
                return $this->translations[$category] = Yii::createObject($source);
            }
        } else {
            // try wildcard matching
            foreach ($this->translations as $pattern => $source) {
                if (strpos($pattern, '*') > 0 && strpos($category, rtrim($pattern, '*')) === 0) {
                    if ($source instanceof MessageSource) {
                        return $source;
                    } else {
                        return $this->translations[$category] = $this->translations[$pattern] = Yii::createObject($source);
                    }
                }
            }
            // match '*' in the last
            if (isset($this->translations['*'])) {
                $source = $this->translations['*'];
                if ($source instanceof MessageSource) {
                    return $source;
                } else {
                    return $this->translations[$category] = $this->translations['*'] = Yii::createObject($source);
                }
            }
        }

        throw new InvalidConfigException("Unable to locate message source for category '$category'.");
    }
}


1		<?php
2		/**
3		* @link http://www.yiiframework.com/
4		* @copyright Copyright (c) 2008 Yii Software LLC
5		* @license http://www.yiiframework.com/license/
6		*/
7
8		namespace yii\i18n;
9
10		use Yii;
11		use yii\base\Component;
12		use yii\base\InvalidConfigException;
13
14		/**
15		* I18N provides features related with internationalization (I18N) and localization (L10N).
16		*
17		* I18N is configured as an application component in [[\yii\base\Application]] by default.
18		* You can access that instance via `Yii::$app->i18n`.
19		*
20		* @property MessageFormatter $messageFormatter The message formatter to be used to format message via ICU
21		* message format. Note that the type of this property differs in getter and setter. See
22		* [[getMessageFormatter()]] and [[setMessageFormatter()]] for details.
23		*
24		* @author Qiang Xue <[email protected]>
25		* @since 2.0
26		*/
27		class I18N extends Component
28		{
29		/**
30		* @var array list of [[MessageSource]] configurations or objects. The array keys are message
31		* category patterns, and the array values are the corresponding [[MessageSource]] objects or the configurations
32		* for creating the [[MessageSource]] objects.
33		*
34		* The message category patterns can contain the wildcard '*' at the end to match multiple categories with the same prefix.
35		* For example, 'app/*' matches both 'app/cat1' and 'app/cat2'.
36		*
37		* The '*' category pattern will match all categories that do not match any other category patterns.
38		*
39		* This property may be modified on the fly by extensions who want to have their own message sources
40		* registered under their own namespaces.
41		*
42		* The category "yii" and "app" are always defined. The former refers to the messages used in the Yii core
43		* framework code, while the latter refers to the default message category for custom application code.
44		* By default, both of these categories use [[PhpMessageSource]] and the corresponding message files are
45		* stored under "@yii/messages" and "@app/messages", respectively.
46		*
47		* You may override the configuration of both categories.
48		*/
49		public $translations;
50
51
52		/**
53		* Initializes the component by configuring the default message categories.
54		*/
55	554	public function init()
56		{
57	554	parent::init();
58	554	if (!isset($this->translations['yii']) && !isset($this->translations['yii*'])) {
59	554	$this->translations['yii'] = [
60	554	'class' => 'yii\i18n\PhpMessageSource',
61	554	'sourceLanguage' => 'en-US',
62	554	'basePath' => '@yii/messages',
63		];
64	554	}
65	554	if (!isset($this->translations['app']) && !isset($this->translations['app*'])) {
66	554	$this->translations['app'] = [
67	554	'class' => 'yii\i18n\PhpMessageSource',
68	554	'sourceLanguage' => Yii::$app->sourceLanguage,
69	554	'basePath' => '@app/messages',
70		];
71	554	}
72	554	}
73
74		/**
75		* Translates a message to the specified language.
76		*
77		* After translation the message will be formatted using [[MessageFormatter]] if it contains
78		* ICU message format and `$params` are not empty.
79		*
80		* @param string $category the message category.
81		* @param string $message the message to be translated.
82		* @param array $params the parameters that will be used to replace the corresponding placeholders in the message.
83		* @param string $language the language code (e.g. `en-US`, `en`).
84		* @return string the translated and formatted message.
85		*/
86	550	public function translate($category, $message, $params, $language)
87		{
88	550	$messageSource = $this->getMessageSource($category);
89	550	$translation = $messageSource->translate($category, $message, $language);
90	550	if ($translation === false) {
91	408	return $this->format($message, $params, $messageSource->sourceLanguage);
92		} else {
93	161	return $this->format($translation, $params, $language);
		0 ignored issues – show Bug introduced 2016-02-04 14:20 UTC by Report Bug Copy Issue Report It seems like `$translation` defined by `$messageSource->translat...y, $message, $language)` on line `89` can also be of type `boolean`; however, `yii\i18n\I18N::format()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
94		}
95		}
96
97		/**
98		* Formats a message using [[MessageFormatter]].
99		*
100		* @param string $message the message to be formatted.
101		* @param array $params the parameters that will be used to replace the corresponding placeholders in the message.
102		* @param string $language the language code (e.g. `en-US`, `en`).
103		* @return string the formatted message.
104		*/
105	554	public function format($message, $params, $language)
106		{
107	554	$params = (array) $params;
108	554	if ($params === []) {
109	539	return $message;
110		}
111
112	251	if (preg_match('~{\s[\d\w]+\s,~u', $message)) {
113	116	$formatter = $this->getMessageFormatter();
114	116	$result = $formatter->format($message, $params, $language);
115	116	if ($result === false) {
116		$errorMessage = $formatter->getErrorMessage();
117		Yii::warning("Formatting message for language '$language' failed with error: $errorMessage. The message being formatted was: $message.", __METHOD__);
118
119		return $message;
120		} else {
121	116	return $result;
122		}
123		}
124
125	141	$p = [];
126	141	foreach ($params as $name => $value) {
127	141	$p['{' . $name . '}'] = $value;
128	141	}
129
130	141	return strtr($message, $p);
131		}
132
133		/**
134		* @var string\|array\|MessageFormatter
135		*/
136		private $_messageFormatter;
137
138		/**
139		* Returns the message formatter instance.
140		* @return MessageFormatter the message formatter to be used to format message via ICU message format.
141		*/
142	116	public function getMessageFormatter()
143		{
144	116	if ($this->_messageFormatter === null) {
145	116	$this->_messageFormatter = new MessageFormatter();
146	116	} elseif (is_array($this->_messageFormatter) \|\| is_string($this->_messageFormatter)) {
147		$this->_messageFormatter = Yii::createObject($this->_messageFormatter);
148		}
149
150	116	return $this->_messageFormatter;
151		}
152
153		/**
154		* @param string\|array\|MessageFormatter $value the message formatter to be used to format message via ICU message format.
155		* Can be given as array or string configuration that will be given to [[Yii::createObject]] to create an instance
156		* or a [[MessageFormatter]] instance.
157		*/
158		public function setMessageFormatter($value)
159		{
160		$this->_messageFormatter = $value;
161		}
162
163		/**
164		* Returns the message source for the given category.
165		* @param string $category the category name.
166		* @return MessageSource the message source for the given category.
167		* @throws InvalidConfigException if there is no message source available for the specified category.
168		*/
169	550	public function getMessageSource($category)
170		{
171	550	if (isset($this->translations[$category])) {
172	548	$source = $this->translations[$category];
173	548	if ($source instanceof MessageSource) {
174	394	return $source;
175		} else {
176	546	return $this->translations[$category] = Yii::createObject($source);
177		}
178		} else {
179		// try wildcard matching
180	4	foreach ($this->translations as $pattern => $source) {
181	4	if (strpos($pattern, '') > 0 && strpos($category, rtrim($pattern, '')) === 0) {
182		if ($source instanceof MessageSource) {
183		return $source;
184		} else {
185		return $this->translations[$category] = $this->translations[$pattern] = Yii::createObject($source);
186		}
187		}
188	4	}
189		// match '*' in the last
190	4	if (isset($this->translations['*'])) {
191	4	$source = $this->translations['*'];
192	4	if ($source instanceof MessageSource) {
193	4	return $source;
194		} else {
195	2	return $this->translations[$category] = $this->translations['*'] = Yii::createObject($source);
196		}
197		}
198		}
199
200		throw new InvalidConfigException("Unable to locate message source for category '$category'.");
201		}
202		}
203

yiisoft / yii2

Push — 11429-message-source ( f7ff15 )

I18N::getMessageSource() D

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like