pradosoft / prado

framework/I18N/core/Gettext/MO.php

Doc Comments +3 added lines, -3 removed lines

@@ -86,7 +86,7 @@ 
      * _read
      *
      * @access  private
-     * @return  mixed
+     * @return  string|null
      * @param   int     $bytes
      */
     function _read($bytes = 1)
@@ -165,7 +165,7 @@ 
      * Load MO file
      *
      * @access   public
-     * @return   mixed   Returns true on success or PEAR_Error on failure.
+     * @return   boolean   Returns true on success or PEAR_Error on failure.
      * @param    string  $file
      */
     function load($file = null)
@@ -261,7 +261,7 @@ 
      * Save MO file
      *
      * @access  public
-     * @return  mixed   Returns true on success or PEAR_Error on failure.
+     * @return  boolean   Returns true on success or PEAR_Error on failure.
      * @param   string  $file
      */
     function save($file = null)

framework/I18N/core/Gettext/PO.php

Doc Comments +2 added lines, -2 removed lines

@@ -67,7 +67,7 @@ 
      * Load PO file
      *
      * @access  public
-     * @return  mixed   Returns true on success or PEAR_Error on failure.
+     * @return  boolean   Returns true on success or PEAR_Error on failure.
      * @param   string  $file
      */
     function load($file = null)
@@ -116,7 +116,7 @@ 
      * Save PO file
      *
      * @access  public
-     * @return  mixed   Returns true on success or PEAR_Error on failure.
+     * @return  boolean   Returns true on success or PEAR_Error on failure.
      * @param   string  $file
      */
     function save($file = null)

framework/I18N/core/Gettext/TGettext.php

Doc Comments +3 added lines, -3 removed lines

@@ -118,7 +118,7 @@ 
      *
      * @static
      * @access  public
-     * @return  mixed   Returns true on success or PEAR_Error on failure.
+     * @return  boolean   Returns true on success or PEAR_Error on failure.
      * @param   string  $pofile path to GNU PO file
      * @param   string  $mofile path to GNU MO file
      */
@@ -260,7 +260,7 @@ 
      * toMO
      *
      * @access  protected
-     * @return  object  File_Gettext_MO
+     * @return  TGettext_MO  File_Gettext_MO
      */
     function toMO()
     {
@@ -274,7 +274,7 @@ 
      * toPO
      *
      * @access  protected
-     * @return  object      File_Gettext_PO
+     * @return  TGettext_PO      File_Gettext_PO
      */
     function toPO()
     {

framework/I18N/core/IMessageSource.php

Doc Comments +1 added lines

@@ -109,6 +109,7 @@
 	/**
 	 * Set the culture for this particular message source.
 	 * @param string the Culture name.
+	 * @return void
 	 */
 	function setCulture($culture);
 	

framework/I18N/core/MessageCache.php

Doc Comments +1 added lines, -3 removed lines

@@ -99,9 +99,7 @@
 	 * Get the data from the cache.
 	 * @param string $catalogue The translation section.
 	 * @param string $culture The translation locale, e.g. "en_AU".
-	 * @param string $filename If the source is a file, this file's modified
-	 * time is newer than the cache's modified time, no cache hit.
-	 * @return mixed Boolean FALSE if no cache hit. Otherwise, translation
+	 * @return false|string Boolean FALSE if no cache hit. Otherwise, translation
 	 * table data for the specified section and locale.
 	 */
 	public function get($catalogue, $culture, $lastmodified=0)

framework/I18N/core/MessageFormat.php

Doc Comments +3 added lines, -2 removed lines

@@ -111,6 +111,7 @@ 
 	/** 
 	 * Sets the charset for message output.
 	 * @param string charset, default is UTF-8
+	 * @param string $charset
 	 */
 	public function setCharset($charset)
 	{
@@ -171,9 +172,9 @@ 
 
 	/**
 	 * Do string translation.
-	 * @param string the string to translate.
+	 * @param string string string to translate.
 	 * @param array a list of string to substitute.
-	 * @param string get the translation from a particular message
+	 * @param string string the translation from a particular message
 	 * catalogue.
 	 * @return string translated string.
 	 */

framework/I18N/core/MessageSource.php

Doc Comments +5 added lines

@@ -252,6 +252,7 @@ 
 	/**
 	 * Set the culture for this message source.
 	 * @param string culture name
+	 * @param string $culture
 	 */
 	public function setCulture($culture)
 	{
@@ -270,6 +271,7 @@ 
 	/**
 	 * Get the last modified unix-time for this particular catalogue+variant.
 	 * @param string catalogue+variant
+	 * @param string $source
 	 * @return int last modified in unix-time format.
 	 */
 	protected function getLastModified($source)
@@ -281,6 +283,7 @@ 
 	 * Load the message for a particular catalogue+variant.
 	 * This methods needs to implemented by subclasses.
 	 * @param string catalogue+variant.
+	 * @param string $variant
 	 * @return array of translation messages. 
 	 */
 	protected function &loadData($variant)
@@ -301,6 +304,7 @@ 
 	/**
 	 * Determine if the source is valid.
 	 * @param string catalogue+variant
+	 * @param string $source
 	 * @return boolean true if valid, false otherwise. 
 	 */
 	protected function isValidSource($source)
@@ -312,6 +316,7 @@ 
 	 * Get all the variants of a particular catalogue.
 	 * This method must be implemented by subclasses.
 	 * @param string catalogue name
+	 * @param string $catalogue
 	 * @return array list of all variants for this catalogue. 
 	 */	
 	protected function getCatalogueList($catalogue)

framework/I18N/core/MessageSource_Database.php

Doc Comments +2 added lines, -1 removed lines

@@ -60,6 +60,7 @@ 
 	/**
 	 * Creates the DB connection.
 	 * @param string the module ID for TDataSourceConfig
+	 * @param string $connectionID
 	 * @return TDbConnection the created DB connection
 	 * @throws TConfigurationException if module ID is invalid or empty
 	 */
@@ -185,7 +186,7 @@ 
 
 	/**
 	 * Update the catalogue last modified time.
-	 * @return boolean true if updated, false otherwise.
+	 * @return integer true if updated, false otherwise.
 	 */
 	private function updateCatalogueTime($cat_id, $variant)
 	{

framework/I18N/core/MessageSource_gettext.php

Doc Comments +6 added lines

@@ -200,6 +200,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $MOFile
+	 */
 	private function getPOFile($MOFile)
 	{
 		$filebase = substr($MOFile, 0, strlen($MOFile)-strlen($this->dataExt));
@@ -422,6 +425,9 @@ 
 		return $catalogue;
 	}
 
+	/**
+	 * @param string $catalogue
+	 */
 	protected function createMessageTemplate($catalogue)
 	{
 		if($catalogue === null) {