TGlobalization::setTranslationConfiguration() - Code Metrics - Inspection of "Translation storage in php array; fix #93" - pradosoft/prado - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 704662...efcdfa )

by Fabio

created 2017-05-08 09:26 UTC

TGlobalization::setTranslationConfiguration() C

↳ Parent: TGlobalization

Complexity

Conditions	11
Paths	14

Size

Total Lines	37
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	11
eloc	21
nc	14
nop	1
dl	0
loc	37
rs	5.2653
c	0
b	0
f	0

How to fix Complexity

<?php
/**
 * TGlobalization class file.
 *
 * @author Wei Zhuo<weizhuo[at]gmail[dot]com>
 * @link https://github.com/pradosoft/prado
 * @copyright Copyright &copy; 2005-2016 The PRADO Group
 * @license https://github.com/pradosoft/prado/blob/master/LICENSE
 * @package Prado\I18N
 */

namespace Prado\I18N;
use Prado\Exceptions\TConfigurationException;
use Prado\Prado;
use Prado\TApplication;
use Prado\TPropertyValue;

/**
 * TGlobalization contains settings for Culture, Charset
 * and TranslationConfiguration.
 *
 * TGlobalization can be subclassed to change how the Culture, Charset
 * are determined. See TGlobalizationAutoDetect for example of
 * setting the Culture based on browser settings.
 *
 * @author Wei Zhuo<weizhuo[at]gmail[dot]com>
 * @package Prado\I18N
 * @since 3.0
 */
class TGlobalization extends \Prado\TModule
{
	/**
	 * Default character set is 'UTF-8'.
	 * @var string
	 */
	private $_defaultCharset = 'UTF-8';

	/**
	 * Default culture is 'en'.
	 * @var string
	 */
	private $_defaultCulture = 'en';

	/**
	 * The current charset.
	 * @var string
	 */
	private $_charset=null;

	/**
	 * The current culture.
	 * @var string
	 */
	private $_culture=null;

	/**
	 * Translation source parameters.
	 * @var TMap
	 */
	private $_translation;

	/**
	 * @var boolean whether we should translate the default culture
	 */
	private $_translateDefaultCulture=true;

	/**
	 * Initialize the Culture and Charset for this application.
	 * You should override this method if you want a different way of
	 * setting the Culture and/or Charset for your application.
	 * If you override this method, call parent::init($xml) first.
	 * @param mixed application configuration
	 */
	public function init($config)
	{
		if($this->_charset===null)
			$this->_charset=$this->getDefaultCharset();
		if($this->_culture===null)
			$this->_culture=$this->getDefaultCulture();

		if($config!==null)
		{
			if($this->getApplication()->getConfigurationType()==TApplication::CONFIG_TYPE_PHP)
				$translation = isset($config['translate'])?$config['translate']:null;
			else
			{
				$t = $config->getElementByTagName('translation');
				$translation = ($t)?$t->getAttributes():null;
			}
			if($translation)
				$this->setTranslationConfiguration($translation);
		}
		$this->getApplication()->setGlobalization($this);
	}

	/**
	 * @return string default culture
	 */
	public function getTranslateDefaultCulture()
	{
		return $this->_translateDefaultCulture;
	}

	/**
	 * @param bool default culture, e.g. <tt>en_US</tt> for American English
	 */
	public function setTranslateDefaultCulture($value)
	{
		$this->_translateDefaultCulture = TPropertyValue::ensureBoolean($value);
	}

	/**
	 * @return string default culture
	 */
	public function getDefaultCulture()
	{
		return $this->_defaultCulture;
	}

	/**
	 * @param string default culture, e.g. <tt>en_US</tt> for American English
	 */
	public function setDefaultCulture($culture)
	{
		$this->_defaultCulture = str_replace('-','_',$culture);
	}

	/**
	 * @return string default charset set
	 */
	public function getDefaultCharset()
	{
		return $this->_defaultCharset;
	}

	/**
	 * @param string default localization charset, e.g. <tt>UTF-8</tt>
	 */
	public function setDefaultCharset($charset)
	{
		$this->_defaultCharset = $charset;
	}

	/**
	 * @return string current application culture
	 */
	public function getCulture()
	{
		return $this->_culture;
	}

	/**
	 * @param string culture, e.g. <tt>en_US</tt> for American English
	 */
	public function setCulture($culture)
	{
		$this->_culture = str_replace('-','_',$culture);
	}

	/**
	 * @return string localization charset
	 */
	public function getCharset()
	{
		return $this->_charset;
	}

	/**
	 * @param string localization charset, e.g. <tt>UTF-8</tt>
	 */
	public function setCharset($charset)
	{
		$this->_charset = $charset;
	}

	/**
	 * @return TMap translation source configuration.
	 */
	public function getTranslationConfiguration()
	{
		return (!$this->_translateDefaultCulture && ($this->getDefaultCulture() == $this->getCulture()))
			? null
			: $this->_translation;
	}

	/**
	 * Sets the translation configuration. Example configuration:
	 * <code>
	 * $config['type'] = 'XLIFF'; //XLIFF, gettext, PHP, Database or MySQL (deprecated)
	 * $config['source'] = 'Path.to.directory'; // for types XLIFF, PHP and gettext
	 * $config['source'] = 'connectionId'; // for type Database
	 * $config['source'] = 'mysql://user:pw@host/db'; // for type MySQL (deprecated)
	 * $config['catalogue'] = 'messages'; //default catalog
	 * $config['autosave'] = 'true'; //save untranslated message
	 * $config['cache'] = 'true'; //cache translated message
	 * $config['marker'] = '@@'; // surround untranslated text with '@@'
	 * </code>
	 * Throws exception is source is not found.
	 * @param TMap|array configuration options
	 */
	protected function setTranslationConfiguration($config)
	{
		if($config['type'] == 'XLIFF' || $config['type'] == 'gettext'  || $config['type'] == 'PHP')
		{
			if($config['source'])
			{
				$config['source'] = Prado::getPathOfNamespace($config['source']);
				if(!is_dir($config['source']))
				{
					if(@mkdir($config['source'])===false)
					throw new TConfigurationException('globalization_source_path_failed',
						$config['source']);
					chmod($config['source'], PRADO_CHMOD); //make it deletable
				}
			}
			else
			{
				throw new TConfigurationException("invalid source dir '{$config['source']}'");
			}
		}
		if(isset($config['cache']) && TPropertyValue::ensureBoolean($config['cache']))
		{
			$config['cache'] = $this->getApplication()->getRunTimePath().'/i18n';
			if(!is_dir($config['cache']))
			{
				if(@mkdir($config['cache'])===false)
					throw new TConfigurationException('globalization_cache_path_failed',
						$config['cache']);
				chmod($config['cache'], PRADO_CHMOD); //make it deletable
			}
		}
		else
		{
			unset($config['cache']);
		}
		$this->_translation = $config;
	}

	/**
	 * @return string current translation catalogue.
	 */
	public function getTranslationCatalogue()
	{
		return $this->_translation['catalogue'];
	}

	/**
	 * @param string update the translation catalogue.
	 */
	public function setTranslationCatalogue($value)
	{
		$this->_translation['catalogue'] = $value;
	}

	/**
	 * Gets all the variants of a specific culture. If the parameter
	 * $culture is null, the current culture is used.
	 * @param string $culture the Culture string

	 * @return array variants of the culture.
	 */
	public function getCultureVariants($culture=null)
	{
		if($culture===null) $culture = $this->getCulture();
		$variants = explode('_', $culture);
		$result = array();
		for(; count($variants) > 0; array_pop($variants))
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
			$result[] = implode('_', $variants);
		return $result;
	}

	/**
	 * Returns a list of possible localized files. Example
	 * <code>
	 * $files = $app->getLocalizedResource("path/to/Home.page","en_US");
	 * </code>
	 * will return
	 * <pre>
	 * array
	 *   0 => 'path/to/en_US/Home.page'
	 *   1 => 'path/to/en/Home.page'
	 *   2 => 'path/to/Home.en_US.page'
	 *   3 => 'path/to/Home.en.page'
	 *   4 => 'path/to/Home.page'
	 * </pre>
	 * Note that you still need to verify the existance of these files.
	 * @param string filename
	 * @param string culture string, null to use current culture
	 * @return array list of possible localized resource files.
	 */
	public function getLocalizedResource($file,$culture=null)
	{
		$files = array();
		$variants = $this->getCultureVariants($culture);
		$path = pathinfo($file);
		foreach($variants as $variant)
			$files[] = $path['dirname'].DIRECTORY_SEPARATOR.$variant.DIRECTORY_SEPARATOR.$path['basename'];
		$filename = substr($path['basename'],0,strrpos($path['basename'],'.'));
		foreach($variants as $variant)
			$files[] = $path['dirname'].DIRECTORY_SEPARATOR.$filename.'.'.$variant.'.'.$path['extension'];
		$files[] = $file;
		return $files;
	}

}


1			<?php
2			/**
3			* TGlobalization class file.
4			*
5			* @author Wei Zhuo<weizhuo[at]gmail[dot]com>
6			* @link https://github.com/pradosoft/prado
7			* @copyright Copyright © 2005-2016 The PRADO Group
8			* @license https://github.com/pradosoft/prado/blob/master/LICENSE
9			* @package Prado\I18N
10			*/
11
12			namespace Prado\I18N;
13			use Prado\Exceptions\TConfigurationException;
14			use Prado\Prado;
15			use Prado\TApplication;
16			use Prado\TPropertyValue;
17
18			/**
19			* TGlobalization contains settings for Culture, Charset
20			* and TranslationConfiguration.
21			*
22			* TGlobalization can be subclassed to change how the Culture, Charset
23			* are determined. See TGlobalizationAutoDetect for example of
24			* setting the Culture based on browser settings.
25			*
26			* @author Wei Zhuo<weizhuo[at]gmail[dot]com>
27			* @package Prado\I18N
28			* @since 3.0
29			*/
30			class TGlobalization extends \Prado\TModule
31			{
32			/**
33			* Default character set is 'UTF-8'.
34			* @var string
35			*/
36			private $_defaultCharset = 'UTF-8';
37
38			/**
39			* Default culture is 'en'.
40			* @var string
41			*/
42			private $_defaultCulture = 'en';
43
44			/**
45			* The current charset.
46			* @var string
47			*/
48			private $_charset=null;
49
50			/**
51			* The current culture.
52			* @var string
53			*/
54			private $_culture=null;
55
56			/**
57			* Translation source parameters.
58			* @var TMap
59			*/
60			private $_translation;
61
62			/**
63			* @var boolean whether we should translate the default culture
64			*/
65			private $_translateDefaultCulture=true;
66
67			/**
68			* Initialize the Culture and Charset for this application.
69			* You should override this method if you want a different way of
70			* setting the Culture and/or Charset for your application.
71			* If you override this method, call parent::init($xml) first.
72			* @param mixed application configuration
73			*/
74			public function init($config)
75			{
76			if($this->_charset===null)
77			$this->_charset=$this->getDefaultCharset();
78			if($this->_culture===null)
79			$this->_culture=$this->getDefaultCulture();
80
81			if($config!==null)
82			{
83			if($this->getApplication()->getConfigurationType()==TApplication::CONFIG_TYPE_PHP)
84			$translation = isset($config['translate'])?$config['translate']:null;
85			else
86			{
87			$t = $config->getElementByTagName('translation');
88			$translation = ($t)?$t->getAttributes():null;
89			}
90			if($translation)
91			$this->setTranslationConfiguration($translation);
92			}
93			$this->getApplication()->setGlobalization($this);
94			}
95
96			/**
97			* @return string default culture
98			*/
99			public function getTranslateDefaultCulture()
100			{
101			return $this->_translateDefaultCulture;
102			}
103
104			/**
105			* @param bool default culture, e.g. <tt>en_US</tt> for American English
106			*/
107			public function setTranslateDefaultCulture($value)
108			{
109			$this->_translateDefaultCulture = TPropertyValue::ensureBoolean($value);
110			}
111
112			/**
113			* @return string default culture
114			*/
115			public function getDefaultCulture()
116			{
117			return $this->_defaultCulture;
118			}
119
120			/**
121			* @param string default culture, e.g. <tt>en_US</tt> for American English
122			*/
123			public function setDefaultCulture($culture)
124			{
125			$this->_defaultCulture = str_replace('-','_',$culture);
126			}
127
128			/**
129			* @return string default charset set
130			*/
131			public function getDefaultCharset()
132			{
133			return $this->_defaultCharset;
134			}
135
136			/**
137			* @param string default localization charset, e.g. <tt>UTF-8</tt>
138			*/
139			public function setDefaultCharset($charset)
140			{
141			$this->_defaultCharset = $charset;
142			}
143
144			/**
145			* @return string current application culture
146			*/
147			public function getCulture()
148			{
149			return $this->_culture;
150			}
151
152			/**
153			* @param string culture, e.g. <tt>en_US</tt> for American English
154			*/
155			public function setCulture($culture)
156			{
157			$this->_culture = str_replace('-','_',$culture);
158			}
159
160			/**
161			* @return string localization charset
162			*/
163			public function getCharset()
164			{
165			return $this->_charset;
166			}
167
168			/**
169			* @param string localization charset, e.g. <tt>UTF-8</tt>
170			*/
171			public function setCharset($charset)
172			{
173			$this->_charset = $charset;
174			}
175
176			/**
177			* @return TMap translation source configuration.
178			*/
179			public function getTranslationConfiguration()
180			{
181			return (!$this->_translateDefaultCulture && ($this->getDefaultCulture() == $this->getCulture()))
182			? null
183			: $this->_translation;
184			}
185
186			/**
187			* Sets the translation configuration. Example configuration:
188			* <code>
189			* $config['type'] = 'XLIFF'; //XLIFF, gettext, PHP, Database or MySQL (deprecated)
190			* $config['source'] = 'Path.to.directory'; // for types XLIFF, PHP and gettext
191			* $config['source'] = 'connectionId'; // for type Database
192			* $config['source'] = 'mysql://user:pw@host/db'; // for type MySQL (deprecated)
193			* $config['catalogue'] = 'messages'; //default catalog
194			* $config['autosave'] = 'true'; //save untranslated message
195			* $config['cache'] = 'true'; //cache translated message
196			* $config['marker'] = '@@'; // surround untranslated text with '@@'
197			* </code>
198			* Throws exception is source is not found.
199			* @param TMap\|array configuration options
200			*/
201			protected function setTranslationConfiguration($config)
202			{
203			if($config['type'] == 'XLIFF' \|\| $config['type'] == 'gettext' \|\| $config['type'] == 'PHP')
204			{
205			if($config['source'])
206			{
207			$config['source'] = Prado::getPathOfNamespace($config['source']);
208			if(!is_dir($config['source']))
209			{
210			if(@mkdir($config['source'])===false)
211			throw new TConfigurationException('globalization_source_path_failed',
212			$config['source']);
213			chmod($config['source'], PRADO_CHMOD); //make it deletable
214			}
215			}
216			else
217			{
218			throw new TConfigurationException("invalid source dir '{$config['source']}'");
219			}
220			}
221			if(isset($config['cache']) && TPropertyValue::ensureBoolean($config['cache']))
222			{
223			$config['cache'] = $this->getApplication()->getRunTimePath().'/i18n';
224			if(!is_dir($config['cache']))
225			{
226			if(@mkdir($config['cache'])===false)
227			throw new TConfigurationException('globalization_cache_path_failed',
228			$config['cache']);
229			chmod($config['cache'], PRADO_CHMOD); //make it deletable
230			}
231			}
232			else
233			{
234			unset($config['cache']);
235			}
236			$this->_translation = $config;
237			}
238
239			/**
240			* @return string current translation catalogue.
241			*/
242			public function getTranslationCatalogue()
243			{
244			return $this->_translation['catalogue'];
245			}
246
247			/**
248			* @param string update the translation catalogue.
249			*/
250			public function setTranslationCatalogue($value)
251			{
252			$this->_translation['catalogue'] = $value;
253			}
254
255			/**
256			* Gets all the variants of a specific culture. If the parameter
257			* $culture is null, the current culture is used.
258			* @param string $culture the Culture string
			0 ignored issues – show Documentation introduced 2016-02-29 19:57 UTC by Report Bug Copy Issue Report Should the type for parameter `$culture` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
259			* @return array variants of the culture.
260			*/
261			public function getCultureVariants($culture=null)
262			{
263			if($culture===null) $culture = $this->getCulture();
264			$variants = explode('_', $culture);
265			$result = array();
266			for(; count($variants) > 0; array_pop($variants))
			0 ignored issues – show Performance Best Practice introduced 2016-02-29 19:57 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
267			$result[] = implode('_', $variants);
268			return $result;
269			}
270
271			/**
272			* Returns a list of possible localized files. Example
273			* <code>
274			* $files = $app->getLocalizedResource("path/to/Home.page","en_US");
275			* </code>
276			* will return
277			* <pre>
278			* array
279			* 0 => 'path/to/en_US/Home.page'
280			* 1 => 'path/to/en/Home.page'
281			* 2 => 'path/to/Home.en_US.page'
282			* 3 => 'path/to/Home.en.page'
283			* 4 => 'path/to/Home.page'
284			* </pre>
285			* Note that you still need to verify the existance of these files.
286			* @param string filename
287			* @param string culture string, null to use current culture
288			* @return array list of possible localized resource files.
289			*/
290			public function getLocalizedResource($file,$culture=null)
291			{
292			$files = array();
293			$variants = $this->getCultureVariants($culture);
294			$path = pathinfo($file);
295			foreach($variants as $variant)
296			$files[] = $path['dirname'].DIRECTORY_SEPARATOR.$variant.DIRECTORY_SEPARATOR.$path['basename'];
297			$filename = substr($path['basename'],0,strrpos($path['basename'],'.'));
298			foreach($variants as $variant)
299			$files[] = $path['dirname'].DIRECTORY_SEPARATOR.$filename.'.'.$variant.'.'.$path['extension'];
300			$files[] = $file;
301			return $files;
302			}
303
304			}
305

pradosoft / prado

Push — master ( 704662...efcdfa )

TGlobalization::setTranslationConfiguration() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like