pradosoft / prado

framework/I18N/core/MessageSource_PHP.php

Doc Comments +6 added lines

@@ -246,6 +246,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $filename
+	 */
 	protected function internalSaveFile($php, $filename)
 	{
 		$php['info']['date'] = @date('Y-m-d\TH:i:s\Z');
@@ -377,6 +380,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $catalogue
+	 */
 	protected function createMessageTemplate($catalogue)
 	{
 		if($catalogue === null) {

Spacing +75 added lines, -75 removed lines

@@ -40,13 +40,13 @@ 
 	 * Message data filename extension.
 	 * @var string
 	 */
-	protected $dataExt = '.php';
+	protected $dataExt='.php';
 
 	/**
 	 * Separator between culture name and source.
 	 * @var string
 	 */
-	protected $dataSeparator = '.';
+	protected $dataSeparator='.';
 
 	/**
 	 * Constructor.
@@ -55,7 +55,7 @@ 
 	 */
 	function __construct($source)
 	{
-		$this->source = (string)$source;
+		$this->source=(string) $source;
 	}
 
 	/**
@@ -66,20 +66,20 @@ 
 	protected function &loadData($filename)
 	{
 		//load it.
-		if(false === ($php = include($filename))) {
+		if(false===($php=include($filename))) {
 			return false;
 		}
 
-		$translationUnit = $php['trans-unit'];
+		$translationUnit=$php['trans-unit'];
 
-		$translations = array();
+		$translations=array();
 
 		foreach($translationUnit as $k => $unit)
 		{
-			$source = (string)$unit['source'];
-			$translations[$source][] = (string)$unit['target'];
-			$translations[$source][] = (string)$k;
-			$translations[$source][] = array_key_exists('note', $unit) ? (string)$unit['note'] : '';
+			$source=(string) $unit['source'];
+			$translations[$source][]=(string) $unit['target'];
+			$translations[$source][]=(string) $k;
+			$translations[$source][]=array_key_exists('note', $unit) ? (string) $unit['note'] : '';
 		}
 
 		return $translations;
@@ -124,22 +124,22 @@ 
 	 */
 	protected function getCatalogueList($catalogue)
 	{
-		$variants = explode('_',$this->culture);
-		$source = $catalogue.$this->dataExt;
-		$catalogues = array($source);
-		$variant = null;
+		$variants=explode('_', $this->culture);
+		$source=$catalogue.$this->dataExt;
+		$catalogues=array($source);
+		$variant=null;
 
-		for($i = 0, $k = count($variants); $i < $k; ++$i)
+		for($i=0, $k=count($variants); $i < $k; ++$i)
 		{
 			if(isset($variants[$i]{0}))
 			{
-				$variant .= ($variant)?'_'.$variants[$i]:$variants[$i];
-				$catalogues[] = $catalogue.$this->dataSeparator.$variant.$this->dataExt;
+				$variant.=($variant) ? '_'.$variants[$i] : $variants[$i];
+				$catalogues[]=$catalogue.$this->dataSeparator.$variant.$this->dataExt;
 			}
 		}
 
-		$byDir = $this->getCatalogueByDir($catalogue);
-		return array_merge($byDir,array_reverse($catalogues));
+		$byDir=$this->getCatalogueByDir($catalogue);
+		return array_merge($byDir, array_reverse($catalogues));
 	}
 
 	/**
@@ -151,16 +151,16 @@ 
 	 */
 	private function getCatalogueByDir($catalogue)
 	{
-		$variants = explode('_',$this->culture);
-		$catalogues = array();
-		$variant = null;
+		$variants=explode('_', $this->culture);
+		$catalogues=array();
+		$variant=null;
 
-		for($i = 0, $k = count($variants); $i < $k; ++$i)
+		for($i=0, $k=count($variants); $i < $k; ++$i)
 		{
 			if(isset($variants[$i]{0}))
 			{
-				$variant .= ($variant)?'_'.$variants[$i]:$variants[$i];
-				$catalogues[] = $variant.'/'.$catalogue.$this->dataExt;
+				$variant.=($variant) ? '_'.$variants[$i] : $variants[$i];
+				$catalogues[]=$variant.'/'.$catalogue.$this->dataExt;
 			}
 		}
 
@@ -184,38 +184,38 @@ 
 	 * E.g. array('messages','en_AU')
 	 * @return array list of catalogues
 	 */
-	protected function getCatalogues($dir=null,$variant=null)
+	protected function getCatalogues($dir=null, $variant=null)
 	{
-		$dir = $dir?$dir:$this->source;
-		$files = scandir($dir);
-		$catalogue = array();
+		$dir=$dir ? $dir : $this->source;
+		$files=scandir($dir);
+		$catalogue=array();
 
 		foreach($files as $file)
 		{
-			if(is_dir($dir.'/'.$file) && preg_match('/^[a-z]{2}(_[A-Z]{2,3})?$/',$file)) {
-				$catalogue = array_merge(
+			if(is_dir($dir.'/'.$file) && preg_match('/^[a-z]{2}(_[A-Z]{2,3})?$/', $file)) {
+				$catalogue=array_merge(
 					$catalogue,
 					$this->getCatalogues($dir.'/'.$file, $file)
 				);
 			}
 
-			$pos = strpos($file,$this->dataExt);
-			if($pos >0 && substr($file, -1*strlen($this->dataExt)) == $this->dataExt)
+			$pos=strpos($file, $this->dataExt);
+			if($pos > 0 && substr($file, -1 * strlen($this->dataExt))==$this->dataExt)
 			{
-				$name = substr($file,0,$pos);
-				$dot = strrpos($name,$this->dataSeparator);
-				$culture = $variant;
-				$cat = $name;
+				$name=substr($file, 0, $pos);
+				$dot=strrpos($name, $this->dataSeparator);
+				$culture=$variant;
+				$cat=$name;
 
 				if(is_int($dot))
 				{
-					$culture = substr($name, $dot+1, strlen($name));
-					$cat = substr($name, 0, $dot);
+					$culture=substr($name, $dot + 1, strlen($name));
+					$cat=substr($name, 0, $dot);
 				}
 
-				$details[0] = $cat;
-				$details[1] = $culture;
-				$catalogue[] = $details;
+				$details[0]=$cat;
+				$details[1]=$culture;
+				$catalogue[]=$details;
 			}
 		}
 		sort($catalogue);
@@ -232,13 +232,13 @@ 
 	 */
 	private function getVariants($catalogue='messages')
 	{
-		if($catalogue === null) {
-			$catalogue = 'messages';
+		if($catalogue===null) {
+			$catalogue='messages';
 		}
 
 		foreach($this->getCatalogueList($catalogue) as $variant)
 		{
-			$file = $this->getSource($variant);
+			$file=$this->getSource($variant);
 			if(is_file($file)) {
 				return array($variant, $file);
 			}
@@ -248,10 +248,10 @@ 
 
 	protected function internalSaveFile($php, $filename)
 	{
-		$php['info']['date'] = @date('Y-m-d\TH:i:s\Z');
+		$php['info']['date']=@date('Y-m-d\TH:i:s\Z');
 
 		//save it and clear the cache for this variant
-		if(false === file_put_contents($filename, "<?php\nreturn " . var_export($php, true) . ';'))
+		if(false===file_put_contents($filename, "<?php\nreturn ".var_export($php, true).';'))
 			return false;
 
 		if(!empty($this->cache))
@@ -269,30 +269,30 @@ 
 	 */
 	public function save($catalogue='messages')
 	{
-		$messages = $this->untranslated;
+		$messages=$this->untranslated;
 		if(count($messages) <= 0) {
 			return false;
 		}
 
-		$variants = $this->getVariants($catalogue);
+		$variants=$this->getVariants($catalogue);
 
 		if($variants) {
-			list($variant, $filename) = $variants;
+			list($variant, $filename)=$variants;
 		} else {
-			list($variant, $filename) = $this->createMessageTemplate($catalogue);
+			list($variant, $filename)=$this->createMessageTemplate($catalogue);
 		}
 
-		if(is_writable($filename) == false) {
+		if(is_writable($filename)==false) {
 			throw new TIOException("Unable to save to file {$filename}, file must be writable.");
 		}
 
 		//import the existing php file
-		$php = include($filename);
+		$php=include($filename);
 
 		//for each message add it to the XML file using DOM
 		foreach($messages as $message)
 		{
-			$php['trans-unit'][]= array(
+			$php['trans-unit'][]=array(
 				'source' => $message,
 				'target' => '',
 			);
@@ -311,29 +311,29 @@ 
 	 */
 	public function update($text, $target, $comments, $catalogue='messages')
 	{
-		$variants = $this->getVariants($catalogue);
+		$variants=$this->getVariants($catalogue);
 
 		if($variants) {
-			list($variant, $filename) = $variants;
+			list($variant, $filename)=$variants;
 		} else {
 			return false;
 		}
 
-		if(is_writable($filename) == false) {
+		if(is_writable($filename)==false) {
 			throw new TIOException("Unable to update file {$filename}, file must be writable.");
 		}
 
 		//import the existing php file
-		$php = include($filename);
+		$php=include($filename);
 
 		//for each of the existin units
 		foreach($php['trans-unit'] as $k => $unit)
 		{
-			if($unit['source'] == $text)
+			if($unit['source']==$text)
 			{
-				$php['trans-unit'][$k]['target'] = $target;
+				$php['trans-unit'][$k]['target']=$target;
 				if(!empty($comments))
-					$php['trans-unit'][$k]['note'] = $comments;
+					$php['trans-unit'][$k]['note']=$comments;
 
 				break;
 			}
@@ -350,24 +350,24 @@ 
 	 */
 	public function delete($message, $catalogue='messages')
 	{
-		$variants = $this->getVariants($catalogue);
+		$variants=$this->getVariants($catalogue);
 		if($variants) {
-			list($variant, $filename) = $variants;
+			list($variant, $filename)=$variants;
 		} else {
 			return false;
 		}
 
-		if(is_writable($filename) == false) {
+		if(is_writable($filename)==false) {
 			throw new TIOException("Unable to modify file {$filename}, file must be writable.");
 		}
 
 		//import the existing php file
-		$php = include($filename);
+		$php=include($filename);
 
 		//for each of the existin units
 		foreach($php['trans-unit'] as $k => $unit)
 		{
-			if($unit['source'] == $message)
+			if($unit['source']==$message)
 			{
 				unset($php['trans-unit'][$k]);
 				return $this->internalSaveFile($php, $filename);
@@ -379,18 +379,18 @@ 
 
 	protected function createMessageTemplate($catalogue)
 	{
-		if($catalogue === null) {
-			$catalogue = 'messages';
+		if($catalogue===null) {
+			$catalogue='messages';
 		}
 		
-		$variants = $this->getCatalogueList($catalogue);
-		$variant = array_shift($variants);
-		$file = $this->getSource($variant);
-		$dir = dirname($file);
+		$variants=$this->getCatalogueList($catalogue);
+		$variant=array_shift($variants);
+		$file=$this->getSource($variant);
+		$dir=dirname($file);
 
 		if(!is_dir($dir)) {
 			@mkdir($dir);
-			@chmod($dir,PRADO_CHMOD);
+			@chmod($dir, PRADO_CHMOD);
 		}
 
 		if(!is_dir($dir)) {
@@ -405,8 +405,8 @@ 
 
 	protected function getTemplate($catalogue)
 	{
-		$date = @date('Y-m-d\TH:i:s\Z');
-		$php = <<<EOD
+		$date=@date('Y-m-d\TH:i:s\Z');
+		$php=<<<EOD
 <?php
 return array(
 	'info' => array(

framework/I18N/core/MessageSource_XLIFF.php

Unused Use Statements -1 removed lines

@@ -19,7 +19,6 @@
 namespace Prado\I18N\core;
 
 use DOMDocument;
-use DOMXPath;
 use Prado\Exceptions\TException;
 use Prado\Exceptions\TIOException;
 

framework/I18N/TGlobalization.php

Spacing +28 added lines, -28 removed lines

@@ -33,13 +33,13 @@ 
 	 * Default character set is 'UTF-8'.
 	 * @var string
 	 */
-	private $_defaultCharset = 'UTF-8';
+	private $_defaultCharset='UTF-8';
 
 	/**
 	 * Default culture is 'en'.
 	 * @var string
 	 */
-	private $_defaultCulture = 'en';
+	private $_defaultCulture='en';
 
 	/**
 	 * The current charset.
@@ -81,11 +81,11 @@ 
 		if($config!==null)
 		{
 			if($this->getApplication()->getConfigurationType()==TApplication::CONFIG_TYPE_PHP)
-				$translation = isset($config['translate'])?$config['translate']:null;
+				$translation=isset($config['translate']) ? $config['translate'] : null;
 			else
 			{
-				$t = $config->getElementByTagName('translation');
-				$translation = ($t)?$t->getAttributes():null;
+				$t=$config->getElementByTagName('translation');
+				$translation=($t) ? $t->getAttributes() : null;
 			}
 			if($translation)
 				$this->setTranslationConfiguration($translation);
@@ -106,7 +106,7 @@ 
 	 */
 	public function setTranslateDefaultCulture($value)
 	{
-		$this->_translateDefaultCulture = TPropertyValue::ensureBoolean($value);
+		$this->_translateDefaultCulture=TPropertyValue::ensureBoolean($value);
 	}
 
 	/**
@@ -122,7 +122,7 @@ 
 	 */
 	public function setDefaultCulture($culture)
 	{
-		$this->_defaultCulture = str_replace('-','_',$culture);
+		$this->_defaultCulture=str_replace('-', '_', $culture);
 	}
 
 	/**
@@ -138,7 +138,7 @@ 
 	 */
 	public function setDefaultCharset($charset)
 	{
-		$this->_defaultCharset = $charset;
+		$this->_defaultCharset=$charset;
 	}
 
 	/**
@@ -154,7 +154,7 @@ 
 	 */
 	public function setCulture($culture)
 	{
-		$this->_culture = str_replace('-','_',$culture);
+		$this->_culture=str_replace('-', '_', $culture);
 	}
 
 	/**
@@ -170,7 +170,7 @@ 
 	 */
 	public function setCharset($charset)
 	{
-		$this->_charset = $charset;
+		$this->_charset=$charset;
 	}
 
 	/**
@@ -178,7 +178,7 @@ 
 	 */
 	public function getTranslationConfiguration()
 	{
-		return (!$this->_translateDefaultCulture && ($this->getDefaultCulture() == $this->getCulture()))
+		return (!$this->_translateDefaultCulture && ($this->getDefaultCulture()==$this->getCulture()))
 			? null
 			: $this->_translation;
 	}
@@ -200,11 +200,11 @@ 
 	 */
 	protected function setTranslationConfiguration($config)
 	{
-		if($config['type'] == 'XLIFF' || $config['type'] == 'gettext'  || $config['type'] == 'PHP')
+		if($config['type']=='XLIFF' || $config['type']=='gettext' || $config['type']=='PHP')
 		{
 			if($config['source'])
 			{
-				$config['source'] = Prado::getPathOfNamespace($config['source']);
+				$config['source']=Prado::getPathOfNamespace($config['source']);
 				if(!is_dir($config['source']))
 				{
 					if(@mkdir($config['source'])===false)
@@ -220,7 +220,7 @@ 
 		}
 		if(isset($config['cache']) && TPropertyValue::ensureBoolean($config['cache']))
 		{
-			$config['cache'] = $this->getApplication()->getRunTimePath().'/i18n';
+			$config['cache']=$this->getApplication()->getRunTimePath().'/i18n';
 			if(!is_dir($config['cache']))
 			{
 				if(@mkdir($config['cache'])===false)
@@ -233,7 +233,7 @@ 
 		{
 			unset($config['cache']);
 		}
-		$this->_translation = $config;
+		$this->_translation=$config;
 	}
 
 	/**
@@ -249,7 +249,7 @@ 
 	 */
 	public function setTranslationCatalogue($value)
 	{
-		$this->_translation['catalogue'] = $value;
+		$this->_translation['catalogue']=$value;
 	}
 
 	/**
@@ -260,11 +260,11 @@ 
 	 */
 	public function getCultureVariants($culture=null)
 	{
-		if($culture===null) $culture = $this->getCulture();
-		$variants = explode('_', $culture);
-		$result = array();
+		if($culture===null) $culture=$this->getCulture();
+		$variants=explode('_', $culture);
+		$result=array();
 		for(; count($variants) > 0; array_pop($variants))
-			$result[] = implode('_', $variants);
+			$result[]=implode('_', $variants);
 		return $result;
 	}
 
@@ -287,17 +287,17 @@ 
 	 * @param string culture string, null to use current culture
 	 * @return array list of possible localized resource files.
 	 */
-	public function getLocalizedResource($file,$culture=null)
+	public function getLocalizedResource($file, $culture=null)
 	{
-		$files = array();
-		$variants = $this->getCultureVariants($culture);
-		$path = pathinfo($file);
+		$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'],'.'));
+			$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;
+			$files[]=$path['dirname'].DIRECTORY_SEPARATOR.$filename.'.'.$variant.'.'.$path['extension'];
+		$files[]=$file;
 		return $files;
 	}
 

framework/I18N/core/MessageSource.php

Indentation +8 added lines, -8 removed lines

@@ -111,15 +111,15 @@
 	/**
 	 * Factory method to instantiate a new MessageSource depending on the
 	 * source type. The allowed source types are 'XLIFF', 'PHP', 'gettext' and
-     * 'Database'. The source parameter depends on the source type. 
-     * For 'gettext', 'PHP' and 'XLIFF', 'source' should point to the directory 
-     * where the messages are stored. 
-     * For 'Database', 'source' must be a valid connection id.
-     * If a deprecated 'SQLite' type is used, 'source' must contain
-     * a valid DSN.
+	 * 'Database'. The source parameter depends on the source type. 
+	 * For 'gettext', 'PHP' and 'XLIFF', 'source' should point to the directory 
+	 * where the messages are stored. 
+	 * For 'Database', 'source' must be a valid connection id.
+	 * If a deprecated 'SQLite' type is used, 'source' must contain
+	 * a valid DSN.
 	 *
- 	 * Custom message source are possible by supplying the a filename parameter
- 	 * in the factory method.
+	 * Custom message source are possible by supplying the a filename parameter
+	 * in the factory method.
 	 * 
 	 * @param string the message source type.
 	 * @param string the location of the resource or the ConnectionID.

Spacing +20 added lines, -20 removed lines

@@ -83,7 +83,7 @@ 
 	 * Array of translation messages.
 	 * @var array 
 	 */
-	protected $messages = array();
+	protected $messages=array();
 
 	/**
 	 * The source of message translations.
@@ -97,7 +97,7 @@ 
 	 */
 	protected $cache;
 	
-	protected $untranslated = array();
+	protected $untranslated=array();
 
 	/**
 	 * Private constructor. MessageSource must be initialized using
@@ -129,23 +129,23 @@ 
 	 */
 	static function &factory($type, $source='.', $filename='')
 	{
-		$types = array('XLIFF','PHP','gettext','Database','SQLite');
+		$types=array('XLIFF', 'PHP', 'gettext', 'Database', 'SQLite');
 
 		if(empty($filename) && !in_array($type, $types))
 			throw new Exception('Invalid type "'.$type.'", valid types are '.
 				implode(', ', $types));
 		
-		$class = 'MessageSource_'.$type;
+		$class='MessageSource_'.$type;
 		
 		if(empty($filename))
-			$filename = dirname(__FILE__).'/'.$class.'.php';
+			$filename=dirname(__FILE__).'/'.$class.'.php';
 						
-		if(is_file($filename) == false)
+		if(is_file($filename)==false)
 			throw new Exception("File $filename not found");
 						
 		include_once $filename;
         
-		$obj =  new $class($source);
+		$obj=new $class($source);
 		
 		return $obj;
 	}
@@ -171,36 +171,36 @@ 
 	 */
 	function load($catalogue='messages')
 	{
-		$variants = $this->getCatalogueList($catalogue);
+		$variants=$this->getCatalogueList($catalogue);
 		
-		$this->messages = array();
+		$this->messages=array();
 		
 		foreach($variants as $variant)
 		{
-			$source = $this->getSource($variant);
+			$source=$this->getSource($variant);
 			
-			if($this->isValidSource($source) == false) continue;
+			if($this->isValidSource($source)==false) continue;
 
-			$loadData = true;
+			$loadData=true;
 			
 			if($this->cache)
 			{
-				$data = $this->cache->get($variant, 
+				$data=$this->cache->get($variant, 
 					$this->culture, $this->getLastModified($source));
 				
 				if(is_array($data))
 				{
-					$this->messages[$variant] = $data;
-					$loadData = false;
+					$this->messages[$variant]=$data;
+					$loadData=false;
 				}
 				unset($data);
 			}
 			if($loadData)
 			{
-				$data = &$this->loadData($source);
+				$data=&$this->loadData($source);
 				if(is_array($data))
 				{
-					$this->messages[$variant] = $data;
+					$this->messages[$variant]=$data;
 					if($this->cache)
 						$this->cache->save($data, $variant, $this->culture);
 				}	
@@ -236,7 +236,7 @@ 
 	 */
 	public function setCache(MessageCache $cache)
 	{
-		$this->cache = $cache;
+		$this->cache=$cache;
 	}
 	
 	/**
@@ -247,7 +247,7 @@ 
 	public function append($message)
 	{
 		if(!in_array($message, $this->untranslated))
-			$this->untranslated[] = $message;
+			$this->untranslated[]=$message;
 	}
 	
 	/**
@@ -256,7 +256,7 @@ 
 	 */
 	public function setCulture($culture)
 	{
-		$this->culture = $culture;
+		$this->culture=$culture;
 	}	
 	
 	/**