Translator::ngettext() - Code Metrics - Inspection of "removed Translator::initGettextFunctions" - oscarotero/Gettext - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — v4.0-dev ( 9a8f25...7f8453 )

by Oscar

created 2016-04-20 19:02 UTC

Translator::ngettext() A

↳ Parent: Translator

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	3

<?php

namespace Gettext;

use Gettext\Generators\PhpArray;

class Translator extends BaseTranslator implements TranslatorInterface
{
    private $domain;
    private $dictionary = [];
    private $plurals = [];

    /**
     * Loads translation from a Translations instance, a file on an array.
     *
     * @param Translations|string|array $translations
     *
     * @return self
     */
    public function loadTranslations($translations)
    {
        if (is_object($translations) && $translations instanceof Translations) {
            $translations = PhpArray::toArray($translations);
        } elseif (is_string($translations) && is_file($translations)) {
            $translations = include $translations;
        } elseif (!is_array($translations)) {
            throw new \InvalidArgumentException('Invalid Translator: only arrays, files or instance of Translations are allowed');
        }

        $this->addTranslations($translations);

        return $this;
    }

    /**
     * Set the default domain.
     * 
     * @param string $domain
     */
    public function defaultDomain($domain)
    {
        $this->domain = $domain;
    }

    /**
     * @see TranslatorInterface
     *
     * {@inheritdoc}
     */
    public function gettext($original)
    {
        return $this->dpgettext($this->domain, null, $original);
    }

    /**
     * @see TranslatorInterface
     *
     * {@inheritdoc}
     */
    public function ngettext($original, $plural, $value)
    {
        return $this->dnpgettext($this->domain, null, $original, $plural, $value);
    }

    /**
     * @see TranslatorInterface
     *
     * {@inheritdoc}
     */
    public function dngettext($domain, $original, $plural, $value)
    {
        return $this->dnpgettext($domain, null, $original, $plural, $value);
    }

    /**
     * @see TranslatorInterface
     *
     * {@inheritdoc}
     */
    public function npgettext($context, $original, $plural, $value)
    {
        return $this->dnpgettext($this->domain, $context, $original, $plural, $value);
    }

    /**
     * @see TranslatorInterface
     *
     * {@inheritdoc}
     */
    public function pgettext($context, $original)
    {
        return $this->dpgettext($this->domain, $context, $original);
    }

    /**
     * @see TranslatorInterface
     *
     * {@inheritdoc}
     */
    public function dgettext($domain, $original)
    {
        return $this->dpgettext($domain, null, $original);
    }

    /**
     * @see TranslatorInterface
     *
     * {@inheritdoc}
     */
    public function dpgettext($domain, $context, $original)
    {
        $translation = $this->getTranslation($domain, $context, $original);

        if (isset($translation[0]) && $translation[0] !== '') {
            return $translation[0];
        }

        return $original;
    }

    /**
     * @see TranslatorInterface
     *
     * {@inheritdoc}
     */
    public function dnpgettext($domain, $context, $original, $plural, $value)
    {
        $key = $this->isPlural($domain, $value);
        $translation = $this->getTranslation($domain, $context, $original);

        if (isset($translation[$key]) && $translation[$key] !== '') {
            return $translation[$key];
        }

        return ($key === 0) ? $original : $plural;
    }

    /**
     * Set new translations to the dictionary.
     *
     * @param array $translations
     */
    protected function addTranslations(array $translations)
    {
        $domain = $translations['domain'];

        //Set the first domain loaded as default domain
        if (!$this->domain) {
            $this->domain = $domain;
        }

        if (isset($this->dictionary[$domain])) {
            $this->dictionary[$domain] = array_replace_recursive($this->dictionary[$domain], $translations['messages']);

            return;
        }

        $pluralForms = $translations['plural-forms'];

        list($count, $code) = explode(';', $pluralForms, 2);

        // extract just the expression turn 'n' into a php variable '$n'.
        // Slap on a return keyword and semicolon at the end.
        $this->plurals[$domain] = [
            'count' => (int) str_replace('nplurals=', '', $count),
            'code' => str_replace('plural=', 'return ', str_replace('n', '$n', $code)).';',
        ];

        $this->dictionary[$domain] = $translations['messages'];
    }

    /**
     * Search and returns a translation.
     *
     * @param string $domain
     * @param string $context
     * @param string $original
     *
     * @return string|false
     */
    protected function getTranslation($domain, $context, $original)
    {
        return isset($this->dictionary[$domain][$context][$original]) ? $this->dictionary[$domain][$context][$original] : false;
    }

    /**
     * Executes the plural decision code given the number to decide which
     * plural version to take.
     *
     * @param string $domain
     * @param string $n
     *
     * @return int
     */
    protected function isPlural($domain, $n)
    {
        //Not loaded domain, use a fallback
        if (!isset($this->plurals[$domain])) {
            return $n == 1 ? 0 : 1;
        }

        if (!isset($this->plurals[$domain]['function'])) {
            $this->plurals[$domain]['function'] = create_function('$n', self::fixTerseIfs($this->plurals[$domain]['code']));
        }

        if ($this->plurals[$domain]['count'] <= 2) {
            return call_user_func($this->plurals[$domain]['function'], $n) ? 1 : 0;
        }

        return call_user_func($this->plurals[$domain]['function'], $n);
    }

    /**
     * This function will recursively wrap failure states in brackets if they contain a nested terse if.
     *
     * This because PHP can not handle nested terse if's unless they are wrapped in brackets.
     *
     * This code probably only works for the gettext plural decision codes.
     *
     * return ($n==1 ? 0 : $n%10>=2 && $n%10<=4 && ($n%100<10 || $n%100>=20) ? 1 : 2);
     * becomes
     * return ($n==1 ? 0 : ($n%10>=2 && $n%10<=4 && ($n%100<10 || $n%100>=20) ? 1 : 2));
     *
     * @param string $code  the terse if string
     * @param bool   $inner If inner is true we wrap it in brackets
     *
     * @return string A formatted terse If that PHP can work with.
     */
    private static function fixTerseIfs($code, $inner = false)
    {
        /*
         * (?P<expression>[^?]+)   Capture everything up to ? as 'expression'
         * \?                      ?
         * (?P<success>[^:]+)      Capture everything up to : as 'success'
         * :                       :
         * (?P<failure>[^;]+)      Capture everything up to ; as 'failure'
         */
        preg_match('/(?P<expression>[^?]+)\?(?P<success>[^:]+):(?P<failure>[^;]+)/', $code, $matches);

        // If no match was found then no terse if was present
        if (!isset($matches[0])) {
            return $code;
        }

        $expression = $matches['expression'];
        $success = $matches['success'];
        $failure = $matches['failure'];

        // Go look for another terse if in the failure state.
        $failure = self::fixTerseIfs($failure, true);
        $code = $expression.' ? '.$success.' : '.$failure;

        if ($inner) {
            return "($code)";
        }

        // note the semicolon. We need that for executing the code.
        return "$code;";
    }
}


1			<?php
2
3			namespace Gettext;
4
5			use Gettext\Generators\PhpArray;
6
7			class Translator extends BaseTranslator implements TranslatorInterface
8			{
9			private $domain;
10			private $dictionary = [];
11			private $plurals = [];
12
13			/**
14			* Loads translation from a Translations instance, a file on an array.
15			*
16			* @param Translations\|string\|array $translations
17			*
18			* @return self
19			*/
20			public function loadTranslations($translations)
21			{
22			if (is_object($translations) && $translations instanceof Translations) {
23			$translations = PhpArray::toArray($translations);
24			} elseif (is_string($translations) && is_file($translations)) {
25			$translations = include $translations;
26			} elseif (!is_array($translations)) {
27			throw new \InvalidArgumentException('Invalid Translator: only arrays, files or instance of Translations are allowed');
28			}
29
30			$this->addTranslations($translations);
31
32			return $this;
33			}
34
35			/**
36			* Set the default domain.
37			*
38			* @param string $domain
39			*/
40			public function defaultDomain($domain)
41			{
42			$this->domain = $domain;
43			}
44
45			/**
46			* @see TranslatorInterface
47			*
48			* {@inheritdoc}
49			*/
50			public function gettext($original)
51			{
52			return $this->dpgettext($this->domain, null, $original);
53			}
54
55			/**
56			* @see TranslatorInterface
57			*
58			* {@inheritdoc}
59			*/
60			public function ngettext($original, $plural, $value)
61			{
62			return $this->dnpgettext($this->domain, null, $original, $plural, $value);
63			}
64
65			/**
66			* @see TranslatorInterface
67			*
68			* {@inheritdoc}
69			*/
70			public function dngettext($domain, $original, $plural, $value)
71			{
72			return $this->dnpgettext($domain, null, $original, $plural, $value);
73			}
74
75			/**
76			* @see TranslatorInterface
77			*
78			* {@inheritdoc}
79			*/
80			public function npgettext($context, $original, $plural, $value)
81			{
82			return $this->dnpgettext($this->domain, $context, $original, $plural, $value);
83			}
84
85			/**
86			* @see TranslatorInterface
87			*
88			* {@inheritdoc}
89			*/
90			public function pgettext($context, $original)
91			{
92			return $this->dpgettext($this->domain, $context, $original);
93			}
94
95			/**
96			* @see TranslatorInterface
97			*
98			* {@inheritdoc}
99			*/
100			public function dgettext($domain, $original)
101			{
102			return $this->dpgettext($domain, null, $original);
103			}
104
105			/**
106			* @see TranslatorInterface
107			*
108			* {@inheritdoc}
109			*/
110			public function dpgettext($domain, $context, $original)
111			{
112			$translation = $this->getTranslation($domain, $context, $original);
113
114			if (isset($translation[0]) && $translation[0] !== '') {
115			return $translation[0];
116			}
117
118			return $original;
119			}
120
121			/**
122			* @see TranslatorInterface
123			*
124			* {@inheritdoc}
125			*/
126			public function dnpgettext($domain, $context, $original, $plural, $value)
127			{
128			$key = $this->isPlural($domain, $value);
129			$translation = $this->getTranslation($domain, $context, $original);
130
131			if (isset($translation[$key]) && $translation[$key] !== '') {
132			return $translation[$key];
133			}
134
135			return ($key === 0) ? $original : $plural;
136			}
137
138			/**
139			* Set new translations to the dictionary.
140			*
141			* @param array $translations
142			*/
143			protected function addTranslations(array $translations)
144			{
145			$domain = $translations['domain'];
146
147			//Set the first domain loaded as default domain
148			if (!$this->domain) {
149			$this->domain = $domain;
150			}
151
152			if (isset($this->dictionary[$domain])) {
153			$this->dictionary[$domain] = array_replace_recursive($this->dictionary[$domain], $translations['messages']);
154
155			return;
156			}
157
158			$pluralForms = $translations['plural-forms'];
159
160			list($count, $code) = explode(';', $pluralForms, 2);
161
162			// extract just the expression turn 'n' into a php variable '$n'.
163			// Slap on a return keyword and semicolon at the end.
164			$this->plurals[$domain] = [
165			'count' => (int) str_replace('nplurals=', '', $count),
166			'code' => str_replace('plural=', 'return ', str_replace('n', '$n', $code)).';',
167			];
168
169			$this->dictionary[$domain] = $translations['messages'];
170			}
171
172			/**
173			* Search and returns a translation.
174			*
175			* @param string $domain
176			* @param string $context
177			* @param string $original
178			*
179			* @return string\|false
180			*/
181			protected function getTranslation($domain, $context, $original)
182			{
183			return isset($this->dictionary[$domain][$context][$original]) ? $this->dictionary[$domain][$context][$original] : false;
184			}
185
186			/**
187			* Executes the plural decision code given the number to decide which
188			* plural version to take.
189			*
190			* @param string $domain
191			* @param string $n
192			*
193			* @return int
194			*/
195			protected function isPlural($domain, $n)
196			{
197			//Not loaded domain, use a fallback
198			if (!isset($this->plurals[$domain])) {
199			return $n == 1 ? 0 : 1;
200			}
201
202			if (!isset($this->plurals[$domain]['function'])) {
203			$this->plurals[$domain]['function'] = create_function('$n', self::fixTerseIfs($this->plurals[$domain]['code']));
204			}
205
206			if ($this->plurals[$domain]['count'] <= 2) {
207			return call_user_func($this->plurals[$domain]['function'], $n) ? 1 : 0;
208			}
209
210			return call_user_func($this->plurals[$domain]['function'], $n);
211			}
212
213			/**
214			* This function will recursively wrap failure states in brackets if they contain a nested terse if.
215			*
216			* This because PHP can not handle nested terse if's unless they are wrapped in brackets.
217			*
218			* This code probably only works for the gettext plural decision codes.
219			*
220			* return ($n==1 ? 0 : $n%10>=2 && $n%10<=4 && ($n%100<10 \|\| $n%100>=20) ? 1 : 2);
221			* becomes
222			* return ($n==1 ? 0 : ($n%10>=2 && $n%10<=4 && ($n%100<10 \|\| $n%100>=20) ? 1 : 2));
223			*
224			* @param string $code the terse if string
225			* @param bool $inner If inner is true we wrap it in brackets
226			*
227			* @return string A formatted terse If that PHP can work with.
228			*/
229			private static function fixTerseIfs($code, $inner = false)
230			{
231			/*
232			* (?P<expression>[^?]+) Capture everything up to ? as 'expression'
233			* \? ?
234			* (?P<success>[^:]+) Capture everything up to : as 'success'
235			* : :
236			* (?P<failure>[^;]+) Capture everything up to ; as 'failure'
237			*/
238			preg_match('/(?P<expression>[^?]+)\?(?P<success>[^:]+):(?P<failure>[^;]+)/', $code, $matches);
239
240			// If no match was found then no terse if was present
241			if (!isset($matches[0])) {
242			return $code;
243			}
244
245			$expression = $matches['expression'];
246			$success = $matches['success'];
247			$failure = $matches['failure'];
248
249			// Go look for another terse if in the failure state.
250			$failure = self::fixTerseIfs($failure, true);
251			$code = $expression.' ? '.$success.' : '.$failure;
252
253			if ($inner) {
254			return "($code)";
255			}
256
257			// note the semicolon. We need that for executing the code.
258			return "$code;";
259			}
260			}
261

oscarotero / Gettext

Push — v4.0-dev ( 9a8f25...7f8453 )

Translator::ngettext() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like