chamilo / chamilo-lms

main/inc/lib/myspace.lib.php

Doc Comments +4 added lines, -3 removed lines

@@ -666,7 +666,6 @@ 
      * @param   int $sessionId  The session ID
      * @param   int $courseId   The course ID
      * @param   int $exerciseId The quiz ID
-     * @param   int $answer Answer status (0 = incorrect, 1 = correct, 2 = both)
      * @return  string  HTML array of results formatted for gridJS
      * @author César Perales <cesar.perales@beeznest.com>, Beeznest Team
      */
@@ -1254,6 +1253,7 @@ 
      * @param int Number of items to select
      * @param string Column to order on
      * @param string Order direction
+     * @param integer $number_of_items
      * @return array Results
      */
     public static function get_course_data_tracking_overview($from, $number_of_items, $column, $direction)
@@ -1588,6 +1588,7 @@ 
      * @param int Number of items to select
      * @param string Column to order on
      * @param string Order direction
+     * @param integer $number_of_items
      * @return array Results
      */
     public static function get_session_data_tracking_overview($from, $number_of_items, $column, $direction)
@@ -1608,7 +1609,6 @@ 
     /**
      * Fills in session reporting data
      *
-     * @param integer $user_id the id of the user
      * @param array $url_params additonal url parameters
      * @param array $row the row information (the other columns)
      * @return string html code
@@ -2239,6 +2239,7 @@ 
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
      * @version Dokeos 1.8.6
      * @since October 2008
+     * @param integer $number_of_items
      */
     public static function get_user_data_tracking_overview($from, $number_of_items, $column, $direction)
     {
@@ -2341,7 +2342,6 @@ 
     /**
      * Checks if there are repeted users in a given array
      * @param  array $usernames list of the usernames in the uploaded file
-     * @param  array $user_array['username'] and $user_array['sufix'] where sufix is the number part in a login i.e -> jmontoya2
      * @return array with the $usernames array and the $user_array array
      * @author Julio Montoya Armas
      */
@@ -2516,6 +2516,7 @@ 
 
     /**
      * Adds missing user-information (which isn't required, like password, etc).
+     * @return integer
      */
     function complete_missing_data($user) {
         // 1. Generate a password if it is necessary.

main/inc/lib/fileManage.lib.php

Doc Comments +4 added lines, -4 removed lines

@@ -39,8 +39,8 @@ 
  * Deletes a file or a directory
  *
  * @author - Hugues Peeters
- * @param  $file (String) - the path of file or directory to delete
- * @return boolean - true if the delete succeed, false otherwise.
+ * @param  string $file (String) - the path of file or directory to delete
+ * @return boolean|null - true if the delete succeed, false otherwise.
  * @see    - delete() uses check_name_exist() and removeDir() functions
  */
 function my_delete($file)
@@ -127,7 +127,7 @@ 
  * @author Hugues Peeters <peeters@ipm.ucl.ac.be>
  * @param  string $file_path complete path of the file or the directory
  * @param  string $new_file_name new name for the file or the directory
- * @return boolean true if succeed, false otherwise
+ * @return string|false true if succeed, false otherwise
  * @see rename() uses the check_name_exist() and php2phps() functions
  */
 function my_rename($file_path, $new_file_name) {
@@ -174,7 +174,7 @@ 
  * @param  string $target the path of the new area
  * @param  bool $forceMove Whether to force a move or to make a copy (safer but slower) and then delete the original
  * @param	bool $moveContent In some cases (including migrations), we need to move the *content* and not the folder itself
- * @return bool true if the move succeed, false otherwise.
+ * @return boolean|null true if the move succeed, false otherwise.
  * @see move() uses check_name_exist() and copyDirTo() functions
  */
 function move($source, $target, $forceMove = false, $moveContent = false)

main/inc/lib/skill.lib.php

Doc Comments +4 added lines, -3 removed lines

@@ -326,6 +326,7 @@ 
 
     /**
      * Gets an element
+     * @param integer $gradebook_id
      */
     public function get_skill_info($skill_id, $gradebook_id)
     {
@@ -544,7 +545,7 @@ 
      * Gets an element
      * @param int $id
      *
-     * @return array|mixed
+     * @return integer
      */
     public function get($id)
     {
@@ -885,7 +886,7 @@ 
     /**
      * Get user's skills
      *
-     * @param int $userId User's id
+     * @param integer $user_id User's id
      * @param bool $get_skill_data
      */
     public function get_user_skills($user_id, $get_skill_data = false)
@@ -1090,7 +1091,7 @@ 
      * @param bool return a flat array or not
      * @param int depth of the skills
      * @param bool filter status
-     * @return json
+     * @return string
      */
     public function get_skills_tree_json($user_id = null, $skill_id = null, $return_flat_array = false, $main_depth = 2, $filter_status = false)
     {

main/inc/lib/system_announcements.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -306,7 +306,7 @@
      * @param int    Whether the announcement should be visible to anonymous users (1) or not (0)
      * @param string The language for which the announvement should be shown. Leave null for all langages
      * @param int    Whether to send an e-mail to all users (1) or not (0)
-     * @return mixed  insert_id on success, false on failure
+     * @return false|string  insert_id on success, false on failure
      */
     public static function add_announcement(
         $title,

main/inc/lib/system/session.class.php

Doc Comments +4 added lines, -1 removed lines

@@ -14,6 +14,9 @@ 
 class Session implements \ArrayAccess
 {
 
+    /**
+     * @param string $variable
+     */
     static function read($variable, $default = null)
     {
         return isset($_SESSION[$variable]) ? $_SESSION[$variable] : $default;
@@ -39,7 +42,7 @@ 
      * Returns true if session has variable set up, false otherwise.
      *
      * @param string $variable
-     * @return mixed value
+     * @return boolean value
      */
     static function has($variable)
     {

main/exercise/export/exercise_import.inc.php

Doc Comments -1 removed lines

@@ -949,7 +949,6 @@
 /**
  * Processes an IMS/QTI manifest file: store links to new files to be able to transform them into questions text
  * @param string $filePath The absolute filepath
- * @param array $links List of filepaths changes
  * @return bool
  */
 function qtiProcessManifest($filePath)

main/inc/lib/MoodleImport.php

Doc Comments +7 added lines, -7 removed lines

@@ -317,7 +317,7 @@ 
      * Read and validate the quiz module XML
      *
      * @param resource $moduleXml XML file
-     * @return mixed | array if is a valid xml file, false otherwise
+     * @return string | array if is a valid xml file, false otherwise
      */
     public function readQuizModule($moduleXml)
     {
@@ -537,9 +537,9 @@ 
      *
      * @param array $questionList
      * @param string $questionType
-     * @param object $questionInstance Question/Answer instance
+     * @param Question $questionInstance Question/Answer instance
      * @param array $currentQuestion
-     * @return integer db response
+     * @return boolean|null db response
      */
     public function processAnswers($questionList, $questionType, $questionInstance, $currentQuestion)
     {
@@ -665,7 +665,7 @@ 
     /**
      * Process Chamilo Unique Answer
      *
-     * @param object $objAnswer
+     * @param Answer $objAnswer
      * @param array $answerValues
      * @param integer $position
      * @param integer $questionWeighting
@@ -698,7 +698,7 @@ 
     /**
      * Process Chamilo True False
      *
-     * @param object $objAnswer
+     * @param Answer $objAnswer
      * @param array $answerValues
      * @param integer $position
      * @param integer $questionWeighting
@@ -731,7 +731,7 @@ 
     /**
      * Process Chamilo FillBlanks
      *
-     * @param object $objAnswer
+     * @param Answer $objAnswer
      * @param array $questionType
      * @param array $answerValues
      * @param string $placeholder
@@ -826,7 +826,7 @@ 
      * Litle utility to delete the unuseful tags
      *
      * @param $array
-     * @param $keys
+     * @param string[] $keys
      */
     public function traverseArray(&$array, $keys)
     {

main/inc/lib/TicketManager.php

Doc Comments +9 added lines, -9 removed lines

@@ -642,10 +642,10 @@ 
     /**
      * Insert message between Users and Admins
      * @param $ticket_id
-     * @param $subject
-     * @param $content
+     * @param string $subject
+     * @param string $content
      * @param $file_attachments
-     * @param $user_id
+     * @param integer $user_id
      * @param string $status
      * @param bool $sendConfirmation
      * @return bool
@@ -744,9 +744,9 @@ 
     /**
      * Attachment files when a message is sent
      * @param $file_attach
-     * @param $ticket_id
-     * @param $message_id
-     * @param $message_attch_id
+     * @param integer $ticket_id
+     * @param integer $message_id
+     * @param integer $message_attch_id
      * @return array
      */
     public static function save_message_attachment_file(
@@ -2006,7 +2006,7 @@ 
     }
 
     /**
-     * @param $id
+     * @param integer $id
      * @return Project
      */
     public static function getProject($id)
@@ -2125,7 +2125,7 @@ 
     }
 
     /**
-     * @param $id
+     * @param integer $id
      * @return Project
      */
     public static function getStatus($id)
@@ -2249,7 +2249,7 @@ 
     }
 
     /**
-     * @param $id
+     * @param integer $id
      * @return Priority
      */
     public static function getPriority($id)

main/inc/lib/internationalization.lib.php

Doc Comments +19 added lines, -12 removed lines

@@ -419,6 +419,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>
@@ -683,6 +684,8 @@ 
  * @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 integer $format
+ * @param string $from_timezone
  * @return string Converted and localized date
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
@@ -752,7 +755,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
@@ -1071,8 +1074,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.
@@ -1135,10 +1138,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.
@@ -1194,7 +1197,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.
@@ -1261,7 +1264,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.
@@ -1442,8 +1445,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.
@@ -1591,7 +1594,7 @@ 
 
 /**
  * This function checks whether two $encoding are equal (same, equvalent).
- * @param string|array $encoding1		The first encoding
+ * @param string $encoding1		The first encoding
  * @param string|array $encoding2		The second encoding
  * @param bool $strict					When this parameter is TRUE the comparison ignores aliases of encodings.
  * When the parameter is FALSE, aliases are taken into account.
@@ -1695,6 +1698,7 @@ 
 /**
  * Checks a string for UTF-8 validity.
  *
+ * @param string $string
  */
 function api_is_valid_utf8(&$string)
 {
@@ -1837,7 +1841,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) {
@@ -1964,6 +1968,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])) {
@@ -1974,7 +1981,7 @@ 
 
 /**
  * Given a date object, return a human or ISO format, with or without h:m:s
- * @param object $date The Date object
+ * @param DateTime $date The Date object
  * @param bool $showTime Whether to show the time and date (true) or only the date (false)
  * @param bool $humanForm Whether to show day-month-year (true) or year-month-day (false)
  * @return string Formatted date