chamilo / chamilo-lms

plugin/bbb/lib/bbb.lib.php

Doc Comments +4 added lines, -4 removed lines

@@ -279,7 +279,7 @@ 
      * Save a participant in a meeting room
      * @param int $meetingId
      * @param int $participantId
-     * @return false|int The last inserted ID. Otherwise return false
+     * @return false|string The last inserted ID. Otherwise return false
      */
     public function saveParticipant($meetingId, $participantId)
     {
@@ -352,7 +352,7 @@ 
     /**
      * Returns a meeting "join" URL
      * @param string The name of the meeting (usually the course code)
-     * @return mixed The URL to join the meeting, or false on error
+     * @return false|string The URL to join the meeting, or false on error
      * @todo implement moderator pass
      * @assert ('') === false
      * @assert ('abcdefghijklmnopqrstuvwxyzabcdefghijklmno') === false
@@ -660,7 +660,7 @@ 
      * Closes a meeting (usually when the user click on the close button from
      * the conferences listing.
      * @param string The internal ID of the meeting (id field for this meeting)
-     * @return void
+     * @return false|null
      * @assert (0) === false
      */
     public function endMeeting($id)
@@ -1077,7 +1077,7 @@ 
      * @param array $recordInfo
      * @param bool $isGlobal
      * @param bool $isAdminReport
-     * @return array
+     * @return string[]
      */
     private function getActionLinks($meetingInfo, $recordInfo, $isGlobal = false, $isAdminReport = false)
     {

main/inc/lib/course_home.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -218,7 +218,7 @@
     /**
      * Displays the tools of a certain category.
      *
-     * @return void
+     * @return string
      * @param string $course_tool_category	contains the category of tools to display:
      * "Public", "PublicButHide", "courseAdmin", "claroAdmin"
      */

main/inc/lib/social.lib.php

Doc Comments +15 added lines, -5 removed lines

@@ -67,6 +67,8 @@ 
      * @param int user id
      * @param int user friend id
      * @param string
+     * @param integer $user_id
+     * @param integer $user_friend
      * @author isaac flores paz
      */
     public static function get_relation_between_contacts($user_id, $user_friend)
@@ -98,6 +100,8 @@ 
      * @param int group id
      * @param string name to search
      * @param bool true will load firstname, lastname, and image name
+     * @param integer $user_id
+     * @param integer $id_group
      * @return array
      * @author Julio Montoya <gugli100@gmail.com> Cleaning code, function renamed, $load_extra_info option added
      * @author isaac flores paz
@@ -174,6 +178,9 @@ 
      * @param int user friend id
      * @param string title of the message
      * @param string content of the message
+     * @param integer $user_id
+     * @param string $message_title
+     * @param string $message_content
      * @return boolean
      * @author isaac flores paz
      * @author Julio Montoya <gugli100@gmail.com> Cleaning code
@@ -248,6 +255,7 @@ 
      * Get number messages of the inbox
      * @author isaac flores paz
      * @param int user receiver id
+     * @param integer $user_receiver_id
      * @return int
      */
     public static function get_message_number_invitation_by_user_id($user_receiver_id)
@@ -290,6 +298,7 @@ 
      * Get invitation list sent by user
      * @author Julio Montoya <gugli100@gmail.com>
      * @param int user id
+     * @param integer $user_id
      * @return array()
      */
     public static function get_list_invitation_sent_by_user_id($user_id)
@@ -332,6 +341,7 @@ 
      * Denies invitation
      * @param int user sender id
      * @param int user receiver id
+     * @param integer $user_receiver_id
      * @author isaac flores paz
      * @author Julio Montoya <gugli100@gmail.com> Cleaning code
      */
@@ -426,7 +436,7 @@ 
      * @param string $subject
      * @param string $content
      *
-     * @return string message invitation
+     * @return false|null message invitation
      */
     public static function sendInvitationToUser($userId, $subject = '', $content = '')
     {
@@ -1223,7 +1233,7 @@ 
      * @param string $messageContent of the message
      * @param int $messageId id parent
      * @param string $messageStatus status type of message
-     * @return boolean
+     * @return false|string
      * @author Yannick Warnier
      */
     public static function sendWallMessage($userId, $friendId, $messageContent, $messageId = 0, $messageStatus = '')
@@ -1315,7 +1325,7 @@ 
      * Gets all messages from someone's wall (within specific limits)
      * @param int $userId id of wall shown
      * @param string $messageStatus status wall message
-     * @param int|string $parentId id message (Post main)
+     * @param integer|null $parentId id message (Post main)
      * @param date $start Date from which we want to show the messages, in UTC time
      * @param int $limit Limit for the number of parent messages we want to show
      * @param int $offset Wall message query offset
@@ -1600,7 +1610,7 @@ 
 
     /**
      * verify if Url Exist - Using Curl
-     * @param $uri url
+     * @param string $uri url
      *
      * @return boolean
      */
@@ -1626,7 +1636,7 @@ 
     /**
     * Delete messages delete logic
     * @param int $id id message to delete.
-    * @return bool status query
+    * @return Statement|null status query
     */
     public static function deleteMessage($id)
     {

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 $time_limit
+ */
 function who_is_online_in_this_course_count($uid, $time_limit, $coursecode=null)
 {
 	if (empty($coursecode)) {

main/inc/lib/TicketManager.php

Doc Comments +11 added lines, -11 removed lines

@@ -640,10 +640,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
@@ -737,9 +737,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(
@@ -2017,7 +2017,7 @@ 
     }
 
     /**
-     * @param $id
+     * @param integer $id
      * @return Project
      */
     public static function getProject($id)
@@ -2137,7 +2137,7 @@ 
     }
 
     /**
-     * @param $id
+     * @param integer $id
      * @return Project
      */
     public static function getStatus($id)
@@ -2260,7 +2260,7 @@ 
     }
 
     /**
-     * @param $id
+     * @param integer $id
      * @return Priority
      */
     public static function getPriority($id)
@@ -2330,7 +2330,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getDefaultStatusList() {
         return [
@@ -2343,7 +2343,7 @@ 
     }
 
         /**
-     * @return array
+     * @return string[]
      */
     public static function getDefaultPriorityList() {
         return [

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/message.lib.php

Doc Comments +6 added lines, -3 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)
     {

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/extra_field_value.lib.php

Doc Comments +4 added lines, -4 removed lines

@@ -75,7 +75,7 @@ 
      * This function is used with $extraField->addElements()
      * @param array $params array for the insertion into the *_field_values table
      * @param bool $showQuery
-     * @return mixed false on empty params, void otherwise
+     * @return false|null false on empty params, void otherwise
      * @assert (array()) === false
      */
     public function saveFieldValues($params, $showQuery = false)
@@ -531,7 +531,7 @@ 
      * @param int $item_id Item ID (It could be a session_id, course_id or user_id)
      * @param int $field_id Field ID (the ID from the *_field table)
      * @param bool $transform Whether to transform the result to a human readable strings
-     * @return mixed A structured array with the field_id and field_value, or false on error
+     * @return string A structured array with the field_id and field_value, or false on error
      * @assert (-1,-1) === false
      */
     public function get_values_by_handler_and_field_id($item_id, $field_id, $transform = false)
@@ -624,7 +624,7 @@ 
      * @param int $item_id Item ID from the original table
      * @param string $field_variable The name of the field we are looking for
      * @param bool $transform
-     * @param bool $allVisibility
+     * @param bool $visibility
      *
      * @return mixed Array of results, or false on error or not found
      * @assert (-1,'') === false
@@ -686,7 +686,7 @@ 
      * @param string $field_value Data we are looking for in the given field
      * @param bool $transform Whether to transform the result to a human readable strings
      * @param bool $last Whether to return the last element or simply the first one we get
-     * @return mixed Give the ID if found, or false on failure or not found
+     * @return string|null Give the ID if found, or false on failure or not found
      * @assert (-1,-1) === false
      */
     public function get_item_id_from_field_variable_and_field_value(