Translator::translate() - Code Metrics - Inspection of "Making Translator's messages 'mutable'" - auraphp/Aura.Intl - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.x (#27)

unknown

created 2016-06-02 13:29 UTC

Translator::translate() A

↳ Parent: Translator

Complexity

Conditions	3
Paths	4

Size

Total Lines	20
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	3

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	20
ccs	8
cts	8
cp	1
rs	9.4285
cc	3
eloc	7
nc	4
nop	2
crap	3

<?php
/**
 *
 * This file is part of the Aura Project for PHP.
 *
 * @package Aura.Intl
 *
 * @license http://opensource.org/licenses/MIT MIT
 *
 */
namespace Aura\Intl;

/**
 *
 * Translator to translate the message
 *
 * @package Aura.Intl
 *
 */
class Translator implements TranslatorInterface
{
    /**
     *
     * A fallback translator.
     *
     * @var TranslatorInterface
     *
     */
    protected $fallback;

    /**
     *
     * The formatter to use when translating messages.
     *
     * @var FormatterInterface
     *
     */
    protected $formatter;

    /**
     *
     * The locale being used for translations.
     *
     * @var string
     *
     */
    protected $locale;

    /**
     * The Package containing keys and translations.
     *
     * @var Package
     *
     */
    protected $package;

    /**
     *
     * Constructor
     *
     * @param string $locale The locale being used.
     *
     * @param Package $package The Package containing keys and translations.
     *
     * @param FormatterInterface $formatter A message formatter.
     *
     * @param TranslatorInterface $fallback A fallback translator.
     *
     */
    public function __construct(
        $locale,
        Package $package,
        FormatterInterface $formatter,
        TranslatorInterface $fallback = null
    ) {
        $this->locale    = $locale;
        $this->package   = $package;
        $this->formatter = $formatter;
        $this->fallback  = $fallback;
    }

    /**
     *
     * Gets the message translation by its key.
     *
     * @param string $key The message key.
     *
     * @return mixed The message translation string, or false if not found.
     *
     */
    protected function getMessage($key)
    {
        $message = $this->package->getMessage($key);
        if ($message) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return $message;
        }

        if ($this->fallback) {
            // get the message from the fallback translator
            $message = $this->fallback->getMessage($key);
            if ($message) {
                // speed optimization: retain locally
                $this->package->addMessage($key, $message);
                // done!
                return $message;
            }
        }

        // no local message, no fallback
        return false;
    }

    /**
     *
     * Translates the message indicated by they key, replacing token values
     * along the way.
     *
     * @param string $key The message key.
     *
     * @param array $tokens_values Token values to interpolate into the
     * message.
     *
     * @return string The translated message with tokens replaced.
     *
     */
    public function translate($key, array $tokens_values = [])
    {
        // get the message string
        $message = $this->getMessage($key);

        // do we have a message string?
        if (! $message) {
            // no, return the message key as-is
            $message = $key;
        }

        // are there token replacement values?
        if (! $tokens_values) {

            // no, return the message string as-is
            return $message;
        }

        // run message string through formatter to replace tokens with values
        return $this->formatter->format($this->locale, $message, $tokens_values);
    }

    /**
     *
     * @return Package
     *
     */
    public function getPackage()
    {
        return $this->package;
    }
}


1		<?php
2		/**
3		*
4		* This file is part of the Aura Project for PHP.
5		*
6		* @package Aura.Intl
7		*
8		* @license http://opensource.org/licenses/MIT MIT
9		*
10		*/
11		namespace Aura\Intl;
12
13		/**
14		*
15		* Translator to translate the message
16		*
17		* @package Aura.Intl
18		*
19		*/
20		class Translator implements TranslatorInterface
21		{
22		/**
23		*
24		* A fallback translator.
25		*
26		* @var TranslatorInterface
27		*
28		*/
29		protected $fallback;
30
31		/**
32		*
33		* The formatter to use when translating messages.
34		*
35		* @var FormatterInterface
36		*
37		*/
38		protected $formatter;
39
40		/**
41		*
42		* The locale being used for translations.
43		*
44		* @var string
45		*
46		*/
47		protected $locale;
48
49		/**
50		* The Package containing keys and translations.
51		*
52		* @var Package
53		*
54		*/
55		protected $package;
56
57		/**
58		*
59		* Constructor
60		*
61		* @param string $locale The locale being used.
62		*
63		* @param Package $package The Package containing keys and translations.
64		*
65		* @param FormatterInterface $formatter A message formatter.
66		*
67		* @param TranslatorInterface $fallback A fallback translator.
68		*
69		*/
70	5	public function __construct(
71		$locale,
72		Package $package,
73		FormatterInterface $formatter,
74		TranslatorInterface $fallback = null
75		) {
76	5	$this->locale = $locale;
77	5	$this->package = $package;
78	5	$this->formatter = $formatter;
79	5	$this->fallback = $fallback;
80	5	}
81
82		/**
83		*
84		* Gets the message translation by its key.
85		*
86		* @param string $key The message key.
87		*
88		* @return mixed The message translation string, or false if not found.
89		*
90		*/
91	4	protected function getMessage($key)
92		{
93	4	$message = $this->package->getMessage($key);
94	4	if ($message) {
		0 ignored issues – show Bug Best Practice introduced 2016-06-02 08:29 UTC by Report Bug Copy Issue Report The expression `$message` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
95	3	return $message;
96		}
97
98	3	if ($this->fallback) {
99		// get the message from the fallback translator
100	1	$message = $this->fallback->getMessage($key);
101	1	if ($message) {
102		// speed optimization: retain locally
103	1	$this->package->addMessage($key, $message);
104		// done!
105	1	return $message;
106		}
107		}
108
109		// no local message, no fallback
110	2	return false;
111		}
112
113		/**
114		*
115		* Translates the message indicated by they key, replacing token values
116		* along the way.
117		*
118		* @param string $key The message key.
119		*
120		* @param array $tokens_values Token values to interpolate into the
121		* message.
122		*
123		* @return string The translated message with tokens replaced.
124		*
125		*/
126	4	public function translate($key, array $tokens_values = [])
127		{
128		// get the message string
129	4	$message = $this->getMessage($key);
130
131		// do we have a message string?
132	4	if (! $message) {
133		// no, return the message key as-is
134	2	$message = $key;
135	2	}
136
137		// are there token replacement values?
138	4	if (! $tokens_values) {
		0 ignored issues – show Bug Best Practice introduced 2016-01-19 15:26 UTC by Report Bug Copy Issue Report The expression `$tokens_values` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
139		// no, return the message string as-is
140	3	return $message;
141		}
142
143		// run message string through formatter to replace tokens with values
144	2	return $this->formatter->format($this->locale, $message, $tokens_values);
145		}
146
147		/**
148		*
149		* @return Package
150		*
151		*/
152		public function getPackage()
153		{
154		return $this->package;
155		}
156		}
157

auraphp / Aura.Intl

Pull Request — 2.x (#27)

Translator::translate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like