chamilo / chamilo-lms

main/inc/lib/database.lib.php

Doc Comments +4 added lines, -4 removed lines

@@ -66,7 +66,7 @@ 
      *
      * @param string $table
      *
-     * @return mixed
+     * @return string
      */
     public static function get_main_table($table)
     {
@@ -265,7 +265,7 @@ 
 
     /**
      * Frees all the memory associated with the provided result identifier.
-     * @return bool     Returns TRUE on success or FALSE on failure.
+     * @return boolean|null     Returns TRUE on success or FALSE on failure.
      * Notes: Use this method if you are concerned about how much memory is being used for queries that return large result sets.
      * Anyway, all associated result memory is automatically freed at the end of the script's execution.
      */
@@ -381,7 +381,7 @@ 
      * @param array     $attributes
      * @param bool      $show_query
      *
-     * @return bool|int
+     * @return false|string
      */
     public static function insert($table_name, $attributes, $show_query = false)
     {
@@ -674,7 +674,7 @@ 
     }
 
     /**
-     * @param $table
+     * @param string $table
      * @return \Doctrine\DBAL\Schema\Column[]
      */
     public static function listTableColumns($table) 

main/inc/lib/internationalization.lib.php

Doc Comments +20 added lines, -14 removed lines

@@ -437,6 +437,7 @@ 
  * If null, the timezone will be determined based on user preference,
  * or timezone chosen by the admin for the platform.
  * @param string The timezone to be converted from. If null, UTC will be assumed.
+ * @param string $to_timezone
  * @return string The converted time formatted as Y-m-d H:i:s
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
@@ -793,6 +794,7 @@ 
  * @param mixed The time to be converted
  * @param mixed Format to be used (TIME_NO_SEC_FORMAT, DATE_FORMAT_SHORT, DATE_FORMAT_LONG, DATE_TIME_FORMAT_LONG)
  * @param string Timezone to be converted from. If null, UTC will be assumed.
+ * @param string $from_timezone
  * @return string Converted and localized date
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
@@ -862,7 +864,7 @@ 
  * @param int/string $format (optional)	The person name format. It may be a pattern-string (for example '%t %l, %f' or '%T %F %L', ...) or some of the constants PERSON_NAME_COMMON_CONVENTION (default), PERSON_NAME_WESTERN_ORDER, PERSON_NAME_EASTERN_ORDER, PERSON_NAME_LIBRARY_ORDER.
  * @param string $language (optional)	The language id. If it is omitted, the current interface language is assumed. This parameter has meaning with the format PERSON_NAME_COMMON_CONVENTION only.
  * @param string $encoding (optional)	The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return bool							The result is sort of full name of the person.
+ * @return string							The result is sort of full name of the person.
  * Sample results:
  * Peter Ustinoff or Dr. Peter Ustinoff     - the Western order
  * Ustinoff Peter or Dr. Ustinoff Peter     - the Eastern order
@@ -956,7 +958,7 @@ 
 
 /**
  * Checks whether a given format represents person name in Western order (for which first name is first).
- * @param int/string $format (optional)	The person name format. It may be a pattern-string (for example '%t. %l, %f') or some of the constants PERSON_NAME_COMMON_CONVENTION (default), PERSON_NAME_WESTERN_ORDER, PERSON_NAME_EASTERN_ORDER, PERSON_NAME_LIBRARY_ORDER.
+ * @param integer $format (optional)	The person name format. It may be a pattern-string (for example '%t. %l, %f') or some of the constants PERSON_NAME_COMMON_CONVENTION (default), PERSON_NAME_WESTERN_ORDER, PERSON_NAME_EASTERN_ORDER, PERSON_NAME_LIBRARY_ORDER.
  * @param string $language (optional)	The language id. If it is omitted, the current interface language is assumed. This parameter has meaning with the format PERSON_NAME_COMMON_CONVENTION only.
  * @return bool							The result TRUE means that the order is first_name last_name, FALSE means last_name first_name.
  * Note: You may use this function for determing the order of the fields or columns "First name" and "Last name" in forms, tables and reports.
@@ -1184,8 +1186,8 @@ 
 
 /**
  * This function returns a string or an array with all occurrences of search in subject (ignoring case) replaced with the given replace value.
- * @param mixed $search					String or array of strings to be found.
- * @param mixed $replace				String or array of strings used for replacement.
+ * @param string $search					String or array of strings to be found.
+ * @param string $replace				String or array of strings used for replacement.
  * @param mixed $subject				String or array of strings being searched.
  * @param int $count (optional)			The number of matched and replaced needles will be returned in count, which is passed by reference.
  * @param string $encoding (optional)	The used internally by this function character encoding.
@@ -1248,10 +1250,10 @@ 
 /**
  * Finds first occurrence of a string within another, case insensitive.
  * @param string $haystack					The string from which to get the first occurrence.
- * @param mixed $needle						The string to be found.
+ * @param string $needle						The string to be found.
  * @param bool $before_needle (optional)	Determines which portion of $haystack this function returns. The default value is FALSE.
  * @param string $encoding (optional)		The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed							Returns the portion of $haystack, or FALSE if $needle is not found.
+ * @return false|string							Returns the portion of $haystack, or FALSE if $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the ordinal value (codepoint if the encoding is UTF-8) of a character.
  * If $before_needle is set to TRUE, the function returns all of $haystack from the beginning to the first occurrence of $needle.
@@ -1307,7 +1309,7 @@ 
  * @param mixed $needle						The string which first character is to be found.
  * @param bool $before_needle (optional)	Determines which portion of $haystack this function returns. The default value is FALSE.
  * @param string $encoding (optional)		The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed							Returns the portion of $haystack, or FALSE if the first character from $needle is not found.
+ * @return false|string							Returns the portion of $haystack, or FALSE if the first character from $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the ordinal value (codepoint if the encoding is UTF-8) of a character.
  * If $before_needle is set to TRUE, the function returns all of $haystack from the beginning to the first occurrence.
@@ -1357,7 +1359,7 @@ 
  * @param string $needle				The string to be found.
  * @param int $offset (optional)		$offset may be specified to begin searching an arbitrary position. Negative values will stop searching at an arbitrary point prior to the end of the string.
  * @param string $encoding (optional)	The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed						Returns the numeric position of the first occurrence of $needle in the $haystack, or FALSE if $needle is not found.
+ * @return integer|null						Returns the numeric position of the first occurrence of $needle in the $haystack, or FALSE if $needle is not found.
  * Note: The first character's position is 0, the second character position is 1, and so on.
  * This function is aimed at replacing the functions strrpos() and mb_strrpos() for human-language strings.
  * @link http://php.net/manual/en/function.strrpos
@@ -1374,7 +1376,7 @@ 
  * @param mixed $needle						The string to be found.
  * @param bool $before_needle (optional)	Determines which portion of $haystack this function returns. The default value is FALSE.
  * @param string $encoding (optional)		The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed							Returns the portion of $haystack, or FALSE if $needle is not found.
+ * @return false|string							Returns the portion of $haystack, or FALSE if $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the ordinal value (codepoint if the encoding is UTF-8) of a character.
  * If $before_needle is set to TRUE, the function returns all of $haystack from the beginning to the first occurrence of $needle.
@@ -1517,7 +1519,7 @@ 
  * 										Note that this changes the return value in an array where every element is an array consisting of the matched string at index 0 and its string offset into subject at index 1.
  * @param int $offset (optional)		Normally, the search starts from the beginning of the subject string. The optional parameter offset can be used to specify the alternate place from which to start the search.
  * @param string $encoding (optional)	The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return int|boolean					Returns the number of times pattern matches or FALSE if an error occurred.
+ * @return integer					Returns the number of times pattern matches or FALSE if an error occurred.
  * @link http://php.net/preg_match
  */
 function api_preg_match($pattern, $subject, &$matches = null, $flags = 0, $offset = 0, $encoding = null) {
@@ -1540,7 +1542,7 @@ 
  * If no order flag is given, PREG_PATTERN_ORDER is assumed.
  * @param int $offset (optional)		Normally, the search starts from the beginning of the subject string. The optional parameter offset can be used to specify the alternate place from which to start the search.
  * @param string $encoding (optional)	The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return int|boolean					Returns the number of full pattern matches (which might be zero), or FALSE if an error occurred.
+ * @return integer					Returns the number of full pattern matches (which might be zero), or FALSE if an error occurred.
  * @link http://php.net/preg_match_all
  */
 function api_preg_match_all($pattern, $subject, &$matches, $flags = PREG_PATTERN_ORDER, $offset = 0, $encoding = null) {
@@ -1555,8 +1557,8 @@ 
 
 /**
  * Performs a regular expression search and replace, UTF-8 aware when it is applicable.
- * @param string|array $pattern			The pattern to search for. It can be either a string or an array with strings.
- * @param string|array $replacement		The string or an array with strings to replace.
+ * @param string $pattern			The pattern to search for. It can be either a string or an array with strings.
+ * @param string $replacement		The string or an array with strings to replace.
  * @param string|array $subject			The string or an array with strings to search and replace.
  * @param int $limit					The maximum possible replacements for each pattern in each subject string. Defaults to -1 (no limit).
  * @param int &$count					If specified, this variable will be filled with the number of replacements done.
@@ -1808,6 +1810,7 @@ 
 /**
  * Checks a string for UTF-8 validity.
  *
+ * @param string $string
  */
 function api_is_valid_utf8(&$string)
 {
@@ -1950,7 +1953,7 @@ 
 /**
  * Replaces non-valid formats for person names with the default (English) format.
  * @param string $format	The input format to be verified.
- * @return bool				Returns the same format if is is valid, otherwise returns a valid English format.
+ * @return string				Returns the same format if is is valid, otherwise returns a valid English format.
  */
 function _api_validate_person_name_format($format) {
     if (empty($format) || stripos($format, '%f') === false || stripos($format, '%l') === false) {
@@ -2077,6 +2080,9 @@ 
 
 // This function checks whether the function _api_convert_encoding() (the php-
 // implementation) is able to convert from/to a given encoding.
+/**
+ * @param string $encoding
+ */
 function _api_convert_encoding_supports($encoding) {
     static $supports = array();
     if (!isset($supports[$encoding])) {

main/inc/lib/magpierss/extlib/Snoopy.class.inc

Doc Comments +12 added lines

@@ -366,6 +366,9 @@ 
 	Output:		$expandedLinks	the expanded links
 \*======================================================================*/
 
+	/**
+	 * @param string $links
+	 */
 	private function _expandlinks($links,$URI)
 	{
 		
@@ -400,6 +403,9 @@ 
 	Output:		
 \*======================================================================*/
 	
+	/**
+	 * @param string $http_method
+	 */
 	private function _httprequest($url,$fp,$URI,$http_method,$content_type="",$body="")
 	{
 		if($this->passcookies && $this->_redirectaddr)
@@ -583,6 +589,9 @@ 
 	Output:		
 \*======================================================================*/
 	
+	/**
+	 * @param string $http_method
+	 */
 	private function _httpsrequest($url,$URI,$http_method,$content_type="",$body="")
 	{
 		if($this->passcookies && $this->_redirectaddr)
@@ -766,6 +775,9 @@ 
 	Input:		$fp	file pointer
 \*======================================================================*/
 	
+	/**
+	 * @param boolean $fp
+	 */
 	private function _connect(&$fp)
 	{
 		if(!empty($this->proxy_host) && !empty($this->proxy_port))

main/inc/lib/magpierss/rss_cache.inc

Doc Comments +12 added lines

@@ -50,6 +50,9 @@ 
     Input:      url from wich the rss file was fetched
     Output:     true on sucess  
 \*=======================================================================*/
+    /**
+     * @param string $url
+     */
     public function set ($url, $rss) {
         $this->ERROR = "";
         $cache_file = $this->file_name( $url );
@@ -76,6 +79,9 @@ 
     Input:      url from wich the rss file was fetched
     Output:     cached object on HIT, false on MISS 
 \*=======================================================================*/ 
+    /**
+     * @param string $url
+     */
     public function get ($url) {
         $this->ERROR = "";
         $cache_file = $this->file_name( $url );
@@ -112,6 +118,9 @@ 
     Input:      url from wich the rss file was fetched
     Output:     cached object on HIT, false on MISS 
 \*=======================================================================*/     
+    /**
+     * @param string $url
+     */
     public function check_cache ( $url ) {
         $this->ERROR = "";
         $filename = $this->file_name( $url );
@@ -158,6 +167,9 @@ 
 /*=======================================================================*\
     Function:   unserialize
 \*=======================================================================*/     
+    /**
+     * @param string $data
+     */
     public function unserialize ( $data ) {
         return unserialize( $data );
     }

main/inc/lib/magpierss/rss_fetch.inc

Doc Comments +9 added lines

@@ -228,6 +228,9 @@ 
     Purpose:    set MAGPIE_ERROR, and trigger error
 \*=======================================================================*/
 
+/**
+ * @param integer $lvl
+ */
 function error ($errormsg, $lvl=E_USER_WARNING) {
         global $MAGPIE_ERROR;
         
@@ -242,6 +245,9 @@ 
         }
 }
 
+/**
+ * @param integer $lvl
+ */
 function debug ($debugmsg, $lvl=E_USER_NOTICE) {
     trigger_error("MagpieRSS [debug] $debugmsg", $lvl);
 }
@@ -288,6 +294,9 @@ 
     Input:      an HTTP response object (see Snoopy)
     Output:     parsed RSS object (see rss_parse)
 \*=======================================================================*/
+/**
+ * @param Snoopy $resp
+ */
 function _response_to_rss ($resp) {
     $rss = new MagpieRSS( $resp->results, MAGPIE_OUTPUT_ENCODING, MAGPIE_INPUT_ENCODING, MAGPIE_DETECT_ENCODING );
     

main/inc/lib/magpierss/rss_parse.inc

Doc Comments +10 added lines

@@ -449,6 +449,10 @@ 
     /**
     * return XML parser, and possibly re-encoded source
     *
+    * @param string $source
+    * @param string $out_enc
+    * @param string|null $in_enc
+    * @param boolean $detect
     */
     public function create_parser($source, $out_enc, $in_enc, $detect) {
         if ( substr(phpversion(),0,1) == 5) {
@@ -558,6 +562,9 @@ 
         }
     }
 
+    /**
+     * @param integer $lvl
+     */
     public function error ($errormsg, $lvl=E_USER_WARNING) {
         // append PHP's error message if track_errors enabled
         if ( isset($php_errormsg) ) { 
@@ -593,6 +600,9 @@ 
 	define("CASE_LOWER",0);
 
 
+	/**
+	 * @param integer $case
+	 */
 	function array_change_key_case($array,$case=CASE_LOWER) {
        if ($case=CASE_LOWER) $cmd=strtolower;
        elseif ($case=CASE_UPPER) $cmd=strtoupper;

main/inc/lib/pear/excelreader/OLERead.inc

Doc Comments +3 added lines

@@ -23,6 +23,9 @@
 //echo $data[ROOT_START_BLOCK_POS];

 //function log

 

+/**
+ * @param integer $pos
+ */
 function GetInt4d($data, $pos)

 {

 	$value = ord($data[$pos]) | (ord($data[$pos+1])	<< 8) | (ord($data[$pos+2]) << 16) | (ord($data[$pos+3]) << 24);

main/inc/lib/exercise_show_functions.lib.php

Doc Comments +32 added lines

@@ -24,6 +24,9 @@ 
 	 * @param int       Question ID
      * @param int $resultsDisabled
      * @param string $originalStudentAnswer
+     * @param integer $feedbackType
+     * @param integer $id
+     * @param integer $questionId
 	 * @return void
 	 */
 	public static function display_fill_in_blanks_answer($feedbackType, $answer, $id, $questionId, $resultsDisabled, $originalStudentAnswer = '')
@@ -62,6 +65,9 @@ 
      * @param string    Answer text
      * @param int       Exercise ID
      * @param int       Question ID
+     * @param integer $feedback_type
+     * @param integer $id
+     * @param integer $questionId
      * @return void
      */
     public static function display_calculated_answer($feedback_type, $answer, $id, $questionId)
@@ -95,6 +101,9 @@ 
 	 * @param string    Answer text
 	 * @param int       Exercise ID
 	 * @param int       Question ID
+	 * @param integer $feedback_type
+	 * @param integer $exe_id
+	 * @param integer $questionId
 	 * @return void
 	 */
 	public static function display_free_answer($feedback_type, $answer, $exe_id, $questionId, $questionScore = null)
@@ -117,6 +126,12 @@ 
         }
 	}
 
+	/**
+	 * @param integer $feedback_type
+	 * @param integer $id
+	 * @param integer $questionId
+	 * @param Nanogong $nano
+	 */
 	public static function display_oral_expression_answer($feedback_type, $answer, $id, $questionId, $nano = null)
     {
         if (isset($nano)) {
@@ -234,6 +249,11 @@ 
 	 * @param integer Exercise ID
 	 * @param integer Question ID
 	 * @param boolean Whether to show the answer comment or not
+	 * @param integer $answerType
+	 * @param string $answerComment
+	 * @param integer $answerCorrect
+	 * @param integer $id
+	 * @param integer $questionId
 	 * @return void
 	 */
 	public static function display_unique_or_multiple_answer(
@@ -324,6 +344,12 @@ 
      * @param integer Exercise ID
      * @param integer Question ID
      * @param boolean Whether to show the answer comment or not
+     * @param integer $feedback_type
+     * @param integer $answerType
+     * @param string $answerComment
+     * @param integer $answerCorrect
+     * @param integer $id
+     * @param integer $questionId
      * @return void
      */
     public static function display_multiple_answer_true_false(
@@ -414,6 +440,12 @@ 
      * @param integer Exercise ID
      * @param integer Question ID
      * @param boolean Whether to show the answer comment or not
+     * @param integer $feedback_type
+     * @param integer $answerType
+     * @param string $answerComment
+     * @param integer $answerCorrect
+     * @param integer $id
+     * @param integer $questionId
      * @return void
      */
     static function display_multiple_answer_combination_true_false(

main/exercice/answer.class.php

Doc Comments +7 added lines

@@ -187,6 +187,7 @@ 
      * Reads answer information from the data base ordered by parameter
      * @param	string	Field we want to order by
      * @param	string	DESC or ASC
+     * @param string $field
      * @author 	Frederic Vauthier
      */
     public function readOrderedBy($field, $order='ASC')
@@ -308,6 +309,7 @@ 
 	 * returns the question ID of the destination question
 	 *
 	 * @author Julio Montoya
+	 * @param integer $id
 	 * @return integer - the question ID
 	 */
 	public function selectDestination($id)
@@ -329,6 +331,7 @@ 
 
 	/**
 	 * return array answer by id else return a bool
+	 * @param integer $auto_id
 	 */
 	public function selectAnswerByAutoId($auto_id)
 	{
@@ -467,6 +470,7 @@ 
 	 *
 	 * @author Olivier Brouckaert
 	 * @param - integer $id - answer ID
+	 * @param integer $id
 	 * @return integer - answer weighting
 	 */
     public function selectWeighting($id)
@@ -491,6 +495,7 @@ 
 	 *
 	 * @author	Olivier Brouckaert
 	 * @param	integer	Answer ID
+	 * @param integer $id
 	 * @return	integer	Answer position
 	 */
     public function selectHotspotCoordinates($id)
@@ -503,6 +508,7 @@ 
 	 *
 	 * @author	Toon Keppens
 	 * @param	integer		Answer ID
+	 * @param integer $id
 	 * @return	integer		Answer position
 	 */
     public function selectHotspotType($id)
@@ -729,6 +735,7 @@ 
 	 * @author Olivier Brouckaert
 	 * @param  int question id
      * @param  array destination course info (result of the function api_get_course_info() )
+     * @param string $newQuestionId
 	 */
     public function duplicate($newQuestionId, $course_info = null)
     {