chamilo / chamilo-lms

main/auth/openid/openid.lib.php

Doc Comments +3 added lines

@@ -242,6 +242,9 @@
     return $hmac;
 }
 
+/**
+ * @param string|false $text
+ */
 function _openid_sha1($text) {
     $hex = sha1($text);
     $raw = '';

main/auth/shibboleth/app/model/scaffold/user.class.php

Doc Comments +3 added lines

@@ -33,6 +33,7 @@ 
         
     /**
      *
+     * @param ShibbolethUser $data
      * @return User 
      */
     public static function create($data = null)
@@ -133,6 +134,7 @@ 
     
     /**
      *
+     * @param string $value
      * @return User 
      */
     public function get_by_user_id($value)
@@ -169,6 +171,7 @@ 
     
     /**
      *
+     * @param string $value
      * @return bool 
      */
     public function username_exists($value)

main/inc/lib/exercise_show_functions.lib.php

Doc Comments +37 added lines, -4 removed lines

@@ -25,6 +25,7 @@ 
 	 * @param int $questionId      Question ID
      * @param int $resultsDisabled
      * @param string $originalStudentAnswer
+     * @param boolean $showTotalScoreAndUserChoices
  *
 	 * @return void
 	 */
@@ -71,6 +72,11 @@ 
      * @param string    Answer text
      * @param int       Exercise ID
      * @param int       Question ID
+     * @param integer $feedback_type
+     * @param string $answer
+     * @param integer $id
+     * @param integer $questionId
+     * @param boolean|string $showTotalScoreAndUserChoices
      * @return void
      */
     public static function display_calculated_answer(
@@ -110,6 +116,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(
@@ -139,11 +148,11 @@ 
 	}
 
     /**
-    * @param $feedback_type
+    * @param integer $feedback_type
     * @param $answer
-    * @param $id
-    * @param $questionId
-    * @param null $nano
+    * @param integer $id
+    * @param integer $questionId
+    * @param Nanogong|null $nano
     * @param int $results_disabled
      */
 	public static function display_oral_expression_answer(
@@ -195,6 +204,7 @@ 
      * @param string $answerComment
      * @param int $resultsDisabled
      * @param int $orderColor
+     * @param boolean $showTotalScoreAndUserChoices
      */
 	public static function display_hotspot_answer(
         $feedback_type,
@@ -279,6 +289,13 @@ 
 	 * @param integer Exercise ID
 	 * @param integer Question ID
 	 * @param boolean Whether to show the answer comment or not
+	 * @param integer $answerType
+	 * @param string $answer
+	 * @param string $answerComment
+	 * @param integer $answerCorrect
+	 * @param integer $id
+	 * @param integer $questionId
+	 * @param boolean $showTotalScoreAndUserChoices
 	 * @return void
 	 */
 	public static function display_unique_or_multiple_answer(
@@ -375,6 +392,14 @@ 
      * @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 $answer
+     * @param string $answerComment
+     * @param integer $answerCorrect
+     * @param integer $id
+     * @param integer $questionId
+     * @param boolean $showTotalScoreAndUserChoices
      * @return void
      */
     public static function display_multiple_answer_true_false(
@@ -479,6 +504,14 @@ 
      * @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 $answer
+     * @param string $answerComment
+     * @param integer $answerCorrect
+     * @param integer $id
+     * @param integer $questionId
+     * @param boolean $showTotalScoreAndUserChoices
      * @return void
      */
     public static function display_multiple_answer_combination_true_false(

main/inc/lib/internationalization.lib.php

Doc Comments +19 added lines, -13 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.
@@ -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/coursecopy/classes/CourseBuilder.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -91,7 +91,7 @@
     }
 
     /**
-     * @param array $array
+     * @param string[] $array
      */
     public function set_tools_to_build($array)
     {

main/coursecopy/classes/CourseRestorer.class.php

Doc Comments +1 added lines

@@ -1212,6 +1212,7 @@
 	 * Restore a forum-post
 	 * @TODO Restore tree-structure of posts. For example: attachments to posts.
 	 * @param false|string $topic_id
+	 * @param false|string $forum_id
 	 */
     public function restore_post($id, $topic_id, $forum_id, $sessionId = 0)
     {

main/dropbox/dropbox_class.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -267,7 +267,7 @@
 	 * @param string $author
 	 * @param string $filename
 	 * @param int $filesize
-	 * @param array $recipient_ids
+	 * @param unknown_type|null $recipient_ids
 	 */
 	public function _createNewSentWork($uploader_id, $title, $description, $author, $filename, $filesize, $recipient_ids)
     {

main/exercice/export/qti2/qti2_classes.php

Doc Comments +5 added lines

@@ -72,6 +72,7 @@ 
     /**
      * Return the XML flow for the possible answers.
      *
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment)
     {
@@ -147,6 +148,7 @@ 
      * Export the text with missing words.
      *
      *
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment)
     {
@@ -204,6 +206,7 @@ 
 {
     /**
      * Export the question part as a matrix-choice, with only one possible answer per line.
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment)
     {
@@ -295,6 +298,7 @@ 
     /**
      * TODO update this to match hot spots instead of copying matching
      * Export the question part as a matrix-choice, with only one possible answer per line.
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment, $questionDesc='', $questionMedia='')
     {
@@ -382,6 +386,7 @@ 
     /**
      * TODO implement
      * Export the question part as a matrix-choice, with only one possible answer per line.
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment, $questionDesc='', $questionMedia='')
 	{

main/exercice/hotpotatoes.lib.php

Doc Comments +2 added lines, -2 removed lines

@@ -259,7 +259,7 @@ 
  * @param    reference    Reference to the array to search
  * @param    string       Node we are looking for in the array
  * @param string $node
- * @return   mixed        Node name or false if not found
+ * @return   false|string        Node name or false if not found
  */
 function myarraysearch(&$array, $node)
 {
@@ -280,7 +280,7 @@ 
  * Searches an image name into an array.
  * @param    reference        Reference to an array to search
  * @param    string           String to look for
- * @return   mixed            String given if found, false otherwise
+ * @return   false|string            String given if found, false otherwise
  * @uses     myarraysearch    This function is just an additional layer on the myarraysearch() function
  */
 function CheckImageName(&$imgparams, $string)