chamilo / chamilo-lms

main/inc/lib/dashboard.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -498,7 +498,7 @@
 	 * @param int 		User id
 	 * @param string	plugin path
 	 * @param integer $user_id
-	 * @return bool
+	 * @return false|string
 	 */
 	public static function close_user_block($user_id, $path)
     {

main/inc/lib/AnnouncementManager.php

Doc Comments +11 added lines, -6 removed lines

@@ -20,7 +20,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_tags()
     {
@@ -42,7 +42,7 @@ 
      * @param string    $course_code
      * @param int       $session_id
      *
-     * @return mixed
+     * @return string
      */
     public static function parse_content($userId, $content, $course_code, $session_id = 0)
     {
@@ -191,7 +191,7 @@ 
      * @param int $courseId
      * @param int $userId
      *
-     * @return array
+     * @return integer
      */
     public static function getAnnouncementInfoById($announcementId, $courseId, $userId)
     {
@@ -400,7 +400,7 @@ 
      * @param string  $file_comment  Comment describing the attachment
      * @param string $end_date
      * @param bool $sendToUsersInSession
-     * @return int      false on failure, ID of the announcement on success
+     * @return false|string      false on failure, ID of the announcement on success
      */
     public static function add_announcement(
         $emailTitle,
@@ -511,7 +511,7 @@ 
      * @param string $file_comment
      * @param bool $sendToUsersInSession
      *
-     * @return bool|int
+     * @return false|string
      */
     public static function add_group_announcement(
         $emailTitle,
@@ -753,7 +753,7 @@ 
 
     /**
      * @param int $insert_id
-     * @return bool
+     * @return false|null
      */
     public static function update_mail_sent($insert_id)
     {
@@ -773,6 +773,7 @@ 
      * Gets all announcements from a user by course
      * @param	string course db
      * @param	int user id
+     * @param integer $user_id
      * @return	array html with the content and count of announcements or false otherwise
      */
     public static function get_all_annoucement_by_user_course($course_code, $user_id)
@@ -1018,6 +1019,7 @@ 
      * has been sent to
      * @param    string  The tool (announcement, agenda, ...)
      * @param    int     ID of the element of the corresponding type
+     * @param string $tool
      * @return   array   Array of users and groups to whom the element has been sent
      */
     public static function sent_to($tool, $id)
@@ -1088,6 +1090,7 @@ 
      * @param int  announcement id
      * @param string file comment
      * @param array  uploaded file $_FILES
+     * @param string|null $file_comment
      * @return int  -1 if failed, 0 if unknown (should not happen), 1 if success
      */
     public static function add_announcement_attachment_file($announcement_id, $file_comment, $file)
@@ -1146,6 +1149,8 @@ 
      * @param int attach id
      * @param array uploaded file $_FILES
      * @param string file comment
+     * @param integer $id_attach
+     * @param string $file_comment
      * @return int
      */
     public static function edit_announcement_attachment_file($id_attach, $file, $file_comment)

main/inc/lib/tracking.lib.php

Doc Comments +11 added lines, -6 removed lines

@@ -1440,7 +1440,7 @@ 
      * Get first connection date for a student
      * @param    int $student_id
      *
-     * @return    string|bool Date format long without day or false if there are no connections
+     * @return    string|false Date format long without day or false if there are no connections
      */
     public static function get_first_connection_date($student_id)
     {
@@ -1470,7 +1470,7 @@ 
      * @param int $student_id
      * @param bool $warning_message Show a warning message (optional)
      * @param bool $return_timestamp True for returning results in timestamp (optional)
-     * @return string|int|bool Date format long without day, false if there are no connections or
+     * @return string Date format long without day, false if there are no connections or
      * timestamp if parameter $return_timestamp is true
      */
     public static function get_last_connection_date($student_id, $warning_message = false, $return_timestamp = false)
@@ -2795,6 +2795,9 @@ 
      * @param     array         Limit average to listed lp ids
      * @param     int            Session id (optional), if param $session_id is
      * null(default) it'll return results including sessions, 0 = session is not filtered
+     * @param integer $student_id
+     * @param string $course_code
+     * @param integer $session_id
      * @return     int         Total time
      */
     public static function get_time_spent_in_lp($student_id, $course_code, $lp_ids = array(), $session_id = null)
@@ -2864,6 +2867,8 @@ 
      * @param     int|array    Student id(s)
      * @param     string         Course code
      * @param     int         Learning path id
+     * @param integer $student_id
+     * @param string $course_code
      * @return     int         Total time
      */
     public static function get_last_connection_time_in_lp($student_id, $course_code, $lp_id, $session_id = 0)
@@ -5586,7 +5591,7 @@ 
 
     /**
     * @param FormValidator $form
-    * @return mixed
+    * @return FormValidator
     */
     public static function setUserSearchForm($form)
     {
@@ -7187,7 +7192,7 @@ 
      * @param int $user_id
      * @param int $course_id
      * @param int $session_id
-     * @return array
+     * @return string[]
      */
     public function display_login_tracking_info($view, $user_id, $course_id, $session_id = 0)
     {
@@ -7233,9 +7238,9 @@ 
     /**
      * Displays the exercise results for a specific user in a specific course.
      * @param   string $view
-     * @param   int $user_id    User ID
+     * @param   int $userId    User ID
      * @param   string  $courseCode Course code
-     * @return array
+     * @return string[]
      * @todo remove globals
      */
     public function display_exercise_tracking_info($view, $userId, $courseCode)

main/inc/lib/course_request.lib.php

Doc Comments +2 added lines, -1 removed lines

@@ -51,7 +51,8 @@
      * @param string $objetives
      * @param string $target_audience
      * @param int $user_id
-     * @return mixed The database id of the newly created course request or FALSE on failure.
+     * @param boolean $exemplary_content
+     * @return false|string The database id of the newly created course request or FALSE on failure.
      */
     public static function create_course_request(
         $wanted_code,

main/inc/lib/grade_model.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
     }
 
     /**
-     * @return bool
+     * @return false|null
      */
     public function create_user_folder()
     {

main/inc/lib/message.lib.php

Doc Comments +8 added lines, -5 removed lines

@@ -599,6 +599,8 @@ 
      * @param  int    message id
      * @param  int    message user id (receiver user id or sender user id)
      * @param  int    group id (optional)
+     * @param integer $message_id
+     * @param integer $message_uid
      * @return void
      */
     public static function delete_message_attachment_file($message_id, $message_uid, $group_id = 0)
@@ -643,7 +645,7 @@ 
      * update messages by user id and message id
      * @param  int $user_id
      * @param  int $message_id
-     * @return resource
+     * @return false|null
      */
     public static function update_message($user_id, $message_id)
     {
@@ -663,7 +665,7 @@ 
      * @param int $user_id
      * @param int $message_id
      * @param string $type
-     * @return bool
+     * @return false|null
      */
     public static function update_message_status($user_id, $message_id, $type)
     {
@@ -701,6 +703,7 @@ 
     /**
      * get messages by group id
      * @param  int        group id
+     * @param integer $group_id
      * @return array
      */
     public static function get_messages_by_group($group_id)
@@ -1479,7 +1482,7 @@ 
      * Sort date by desc from a multi-dimensional array
      * @param array $array1 first array to compare
      * @param array $array2 second array to compare
-     * @return bool
+     * @return integer
      */
     public function order_desc_date($array1, $array2)
     {
@@ -1541,7 +1544,7 @@ 
     }
 
     /**
-     * @param $id
+     * @param string $id
      * @param array $params
      * @return string
      */
@@ -1555,7 +1558,7 @@ 
     }
 
     /**
-     * @param $id
+     * @param string $id
      * @param array $params
      * @return string
      */

main/inc/lib/online.inc.php

Doc Comments +9 added lines, -2 removed lines

@@ -209,11 +209,11 @@ 
 /**
  * Gives a list of people online now (and in the last $valid minutes)
  *
- * @param $from
+ * @param integer $from
  * @param $number_of_items
  * @param null $column
  * @param null $direction
- * @param null $time_limit
+ * @param integer $time_limit
  * @param bool $friends
  * @return  array|bool For each line, a list of user IDs and login dates, or FALSE on error or empty results
  */
@@ -320,6 +320,9 @@ 
     }
 }
 
+/**
+ * @param string $time_limit
+ */
 function who_is_online_count($time_limit = null, $friends = false)
 {
     if (empty($time_limit)) {
@@ -436,6 +439,10 @@ 
 	}
 }
 
+/**
+ * @param integer $uid
+ * @param string|null $time_limit
+ */
 function who_is_online_in_this_course_count($uid, $time_limit, $coursecode=null)
 {
 	if (empty($coursecode)) {

main/gradebook/lib/user_data_generator.class.php

Doc Comments +4 added lines, -4 removed lines

@@ -285,7 +285,7 @@ 
 
     /**
      * @param $item
-     * @param $ignore_score_color
+     * @param boolean $ignore_score_color
      * @return string
      */
     private function build_average_column($item, $ignore_score_color)
@@ -306,7 +306,7 @@ 
 
     /**
      * @param $item
-     * @param $ignore_score_color
+     * @param boolean $ignore_score_color
      * @return string
      */
     private function build_result_column($item, $ignore_score_color)
@@ -323,7 +323,7 @@ 
 
     /**
      * @param $item
-     * @param $ignore_score_color
+     * @param boolean $ignore_score_color
      * @return string
      */
     private function build_mask_column($item, $ignore_score_color)
@@ -339,7 +339,7 @@ 
 
     /**
      * @param $coursecode
-     * @return mixed
+     * @return string
      */
     private function get_course_name_from_code_cached($coursecode)
     {

src/Chamilo/SettingsBundle/Manager/SettingsManager.php

Doc Comments +8 added lines, -5 removed lines

@@ -125,7 +125,7 @@ 
 
     /**
      * Get variables and categories as in 1.11.x
-     * @return array
+     * @return string
      */
     public function getVariablesAndCategories()
     {
@@ -428,7 +428,7 @@ 
     /**
      * Rename old variable with variable used in Chamilo 2.0
      * @param string $variable
-     * @return mixed
+     * @return string
      */
     public function renameVariable($variable)
     {
@@ -464,7 +464,7 @@ 
      * Replace old Chamilo 1.x category with 2.0 version
      * @param string $variable
      * @param string $defaultCategory
-     * @return mixed
+     * @return string
      */
     public function fixCategory($variable, $defaultCategory)
     {
@@ -558,8 +558,8 @@ 
     }
 
     /**
-     * @param $name
-     * @return mixed
+     * @param string $name
+     * @return string
      * @throws \InvalidArgumentException
      */
     public function getSetting($name)
@@ -843,6 +843,9 @@ 
         return $parameters;
     }
 
+    /**
+     * @param string $namespace
+     */
     public function getParametersFromKeyword($namespace, $keyword = '')
     {
         $criteria = array('category' => $namespace);