chamilo / chamilo-lms

main/survey/survey.lib.php

Doc Comments +18 added lines, -15 removed lines

@@ -47,7 +47,7 @@ 
      * Deletes all survey invitations of a user
      * @param int $user_id
      *
-     * @return boolean
+     * @return false|null
      * @assert ('') === false
      */
     public static function delete_all_survey_invitations_by_user($user_id)
@@ -104,7 +104,7 @@ 
      * Retrieves all the survey information
      *
      * @param integer $survey_id the id of the survey
-     * @param boolean $shared this parameter determines if
+     * @param integer $shared this parameter determines if
      * we have to get the information of a survey from the central (shared) database or from the
      * 		  course database
      * @param string course code optional
@@ -571,7 +571,7 @@ 
      * This function deletes a survey (and also all the question in that survey
      *
      * @param int $survey_id id of the survey that has to be deleted
-     * @return true
+     * @return boolean
      *
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
      * @version January 2007
@@ -756,7 +756,7 @@ 
      *
      * @param int $survey_id id of the survey that has to be duplicated
      * @param int $courseId id of the course which survey has to be duplicated
-     * @return true
+     * @return boolean
      *
      * @author Eric Marguin <e.marguin@elixir-interactive.com>, Elixir Interactive
      * @version October 2007
@@ -796,7 +796,7 @@ 
     /**
      * This function recalculates the number of people who have taken the survey (=filled at least one question)
      *
-     * @param int $survey_id the id of the survey somebody
+     * @param int $survey_data the id of the survey somebody
      * @return true
      *
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
@@ -1367,7 +1367,7 @@ 
      * This function deletes a shared survey question from the main database and all its options
      *
      * @param int $question_id the id of the question
-     * @param int $shared
+     * @param integer $survey_id
      *
      * @todo delete all the options of this question
      *
@@ -1494,8 +1494,8 @@ 
      * This function deletes all the options of the questions of a given survey
      * This function is normally only called when a survey is deleted
      *
-     * @param $survey_id the id of the survey that has to be deleted
-     * @return true
+     * @param integer $survey_id the id of the survey that has to be deleted
+     * @return boolean
      *
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
      * @version January 2007
@@ -1562,8 +1562,8 @@ 
      * This function deletes all the answers anyone has given on this survey
      * This function is normally only called when a survey is deleted
      *
-     * @param $survey_id the id of the survey that has to be deleted
-     * @return true
+     * @param integer $survey_id the id of the survey that has to be deleted
+     * @return boolean
      *
      * @todo write the function
      *
@@ -1838,7 +1838,7 @@ 
     /**
      * This function checks the parameters that are used in this page
      *
-     * @return 	string 	The header, an error and the footer if any parameter fails, else it returns true
+     * @return 	null|boolean 	The header, an error and the footer if any parameter fails, else it returns true
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
      * @version February 2007
      */
@@ -2389,6 +2389,7 @@ 
      * Display score data about a survey question
      * @param	array	Question info
      * @param	integer	The offset of results shown
+     * @param integer $offset
      * @return	void 	(direct output)
      */
     public static function display_question_report_score($survey_data, $question, $offset)
@@ -3024,7 +3025,7 @@ 
      * Quite similar to display_complete_report(), returns an HTML string
      * that can be used in a csv file
      * @todo consider merging this function with display_complete_report
-     * @return	string	The contents of a csv file
+     * @return	false|null	The contents of a csv file
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
      * @version February 2007
      */
@@ -3246,7 +3247,7 @@ 
      * @param	array	User's answers
      * @param 	mixed	User ID or user details as string - Used as a string in the result string
      * @param	boolean	Whether to display user fields or not
-     * @return	string	One line of the csv file
+     * @return	string[]	One line of the csv file
      */
     public static function export_complete_report_row_xls(
         $survey_data,
@@ -3552,6 +3553,7 @@ 
      *
      * @param	integer	Survey ID
      * @param	integer	Question ID
+     * @param integer $survey_id
      * @return 	Array	Array containing all answers of all users, grouped by user
      *
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
@@ -3846,7 +3848,7 @@ 
 
     /**
      * @param $params
-     * @return bool|int
+     * @return false|string
      */
     public static function save_invitation($params)
     {
@@ -3900,6 +3902,7 @@ 
      *
      * @param int invitedUser - the userId (course user) or emailaddress of additional user
      * $param string $invitation_code - the unique invitation code for the URL
+     * @param string|null $invitation_text
      * @return	void
      */
     public static function send_invitation_mail($invitedUser, $invitation_code, $invitation_title, $invitation_text)
@@ -4794,7 +4797,7 @@ 
      * @author Isaac Flores Paz <florespaz@bidsoftperu.com>
      * @param int $user_id - User ID
      * @param string $survey_code
-     * @param int $user_id_answer - User in survey answer table (user id or anonymus)
+     * @param int $user_answer - User in survey answer table (user id or anonymus)
      *
      * @return boolean
      */

main/inc/lib/events.lib.php

Doc Comments +20 added lines, -9 removed lines

@@ -239,7 +239,7 @@ 
     }
 
     /**
-     * @param doc_id id of document (id in mainDb.document table)
+     * @param doc_id string of document (id in mainDb.document table)
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
      * @desc Record information for upload event
      * used in the works tool to record informations when
@@ -313,6 +313,9 @@ 
      * @param   int     session_id
      * @param   int     learnpath_id (id of the learnpath)
      * @param   int     learnpath_item_id (id of the learnpath_item)
+     * @param integer $score
+     * @param integer $weighting
+     * @param integer $session_id
      *
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
      * @author Julio Montoya Armas <gugli100@gmail.com> Reworked 2010
@@ -414,7 +417,9 @@ 
      * @param	integer	Session ID (from the session table). Default value of null means "get from context".
      * @param	integer	Learnpath ID (from c_lp table). Default value of null means "get from context".
      * @param	integer	Learnpath item ID (from the c_lp_item table). Default value of null means "get from context".
-     * @return	boolean	Result of the insert query
+     * @param integer $exe_id
+     * @param integer $position
+     * @return	false|string	Result of the insert query
      */
     public static function saveQuestionAttempt(
         $score,
@@ -588,6 +593,8 @@ 
      * @param	int		Whether this answer is correct (1) or not (0)
      * @param	string	Coordinates of this point (e.g. 123;324)
      * @param	bool update results?
+     * @param integer $exe_id
+     * @param integer $correct
      * @return	boolean	Result of the insert query
      * @uses Course code and user_id from global scope $_cid and $_user
      */
@@ -800,11 +807,11 @@ 
     /**
      * Save the new message for one event and for one language
      *
-     * @param string $eventName
+     * @param string $event_name
      * @param array $users
      * @param string $message
      * @param string $subject
-     * @param string $eventMessageLanguage
+     * @param string $event_message_language
      * @param int $activated
      */
     public static function save_event_type_message($event_name, $users, $message, $subject, $event_message_language, $activated)
@@ -938,10 +945,10 @@ 
     }
 
     /**
-     * @param $user_id
+     * @param integer $user_id
      * @param $exerciseId
-     * @param $lp_id
-     * @param $lp_item_id
+     * @param integer $lp_id
+     * @param integer $lp_item_id
      * @return int
      */
     public static function get_attempt_count_not_finished($user_id, $exerciseId, $lp_id, $lp_item_id)
@@ -1118,6 +1125,7 @@ 
      * @param   int     exercise id
      * @param   int $courseId
      * @param   int     session id
+     * @param integer $user_id
      * @return  array   with the results
      *
      */
@@ -1213,6 +1221,7 @@ 
      * @param   int     exercise id
      * @param   int  $courseId
      * @param   int     session id
+     * @param integer $user_id
      * @return  array   with the results
      *
      */
@@ -1301,6 +1310,8 @@ 
      * @param   int     lp id
      * @param   int     lp item id
      * @param   string 	order asc or desc
+     * @param integer $courseId
+     * @param string $order
      * @return  array   with the results
      *
      */
@@ -1367,7 +1378,7 @@ 
      * @param   int     exercise id
      * @param   int     $courseId
      * @param   int     session id
-     * @return  array   with the results
+     * @return  string   with the results
      *
      */
     public static function count_exercise_attempts_by_user($user_id, $exercise_id, $courseId, $session_id = 0)
@@ -1538,7 +1549,7 @@ 
      * @param   int     exercise id
      * @param   int   course id
      * @param   int     session id
-     * @return  array   with the results
+     * @return  integer   with the results
      *
      */
     public static function get_count_exercises_attempted_by_course($courseId, $session_id = 0)

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

Doc Comments +2 added lines, -2 removed lines

@@ -573,14 +573,14 @@
      * @param int $allDay is all day 'true' or 'false'
      * @param string $title
      * @param string $content
-     * @param array $usersToSend
+     * @param string[] $usersToSend
      * @param array $attachmentArray
      * @param array $attachmentCommentList
      * @param string $comment
      * @param string $color
      * @param bool $addAnnouncement
      *
-     * @return null|false
+     * @return null|boolean
      */
     public function editEvent(
         $id,

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

Doc Comments +18 added lines, -16 removed lines

@@ -1652,7 +1652,7 @@ 
      * @param array $user_list
      * @param int $session_visibility
      * @param bool $empty_users
-     * @return bool
+     * @return false|null
      */
     public static function subscribe_users_to_session(
         $id_session,
@@ -1925,7 +1925,7 @@ 
      * @param array $courseInfo
      * @param int $status
      * @param bool $updateTotal
-     * @return bool
+     * @return false|null
      */
     public static function removeUsersFromCourseSession(
         $userList,
@@ -1991,7 +1991,7 @@ 
      * @param string $course_code
      * @param int $session_visibility
      * @param bool $removeUsersNotInList
-     * @return bool
+     * @return false|null
      */
     public static function subscribe_users_to_session_course(
         $user_list,
@@ -2175,7 +2175,7 @@ 
      * @param	bool	$removeExistingCoursesWithUsers Whether to unsubscribe
      * existing courses and users (true, default) or not (false)
      * @param $copyEvaluation from base course to session course
-     * @return	void	Nothing, or false on error
+     * @return	false|null	Nothing, or false on error
      * */
     public static function add_courses_to_session(
         $sessionId,
@@ -2424,7 +2424,7 @@ 
      * @param	string	$variable Field's internal variable name
      * @param	int		$fieldType Field's type
      * @param	string	$displayText Field's language var name
-     * @return int     new extra field id
+     * @return boolean     new extra field id
      */
     public static function create_session_extra_field($variable, $fieldType, $displayText)
     {
@@ -2648,7 +2648,7 @@ 
      * @param	array	id_checked
      * @param	bool	include delete session
      * @param	bool	optional, true if the function is called by a webservice, false otherwise.
-     * @return	void	Nothing, or false on error
+     * @return	boolean	Nothing, or false on error
      * The parameters is a array to delete sessions
      * */
     public static function delete_session_category($id_checked, $delete_session = false, $from_ws = false)
@@ -3414,8 +3414,8 @@ 
     /**
      * Gets the list of courses by session filtered by access_url
      *
-     * @param $userId
-     * @param $sessionId
+     * @param integer $userId
+     * @param null|integer $sessionId
      * @param null $from
      * @param null $limit
      * @param null $column
@@ -3540,6 +3540,7 @@ 
     /**
      * Gets the count of courses by session filtered by access_url
      * @param int session id
+     * @param integer $session_id
      * @return array list of courses
      */
     public static function getCourseCountBySessionId($session_id, $keyword = null)
@@ -3798,6 +3799,7 @@ 
      * Updates a session status
      * @param	int 	session id
      * @param	int 	status
+     * @param integer $status
      */
     public static function set_session_status($session_id, $status)
     {
@@ -4006,7 +4008,7 @@ 
      * Protect a session to be edited.
      * @param int $id
      * @param bool $checkSession
-     * @return mixed | bool true if pass the check, api_not_allowed otherwise
+     * @return boolean|null | bool true if pass the check, api_not_allowed otherwise
      */
     public static function protectSession($id, $checkSession = true)
     {
@@ -4114,7 +4116,7 @@ 
 
     /**
      * @param $id
-     * @return bool
+     * @return null|boolean
      */
     public static function protect_teacher_session_edit($id)
     {
@@ -4179,7 +4181,7 @@ 
      *  true: if the session exists it will be updated.
      *  false: if session exists a new session will be created adding a counter session1, session2, etc
      * @param int $defaultUserId
-     * @param mixed $logger
+     * @param Logger $logger
      * @param array $extraFields convert a file row to an extra field. Example in CSV file there's a SessionID then it will
      * converted to extra_external_session_id if you set this: array('SessionId' => 'extra_external_session_id')
      * @param string $extraFieldId
@@ -5482,7 +5484,6 @@ 
      * @param string $lastConnectionDate
      * @param array $sessionIdList
      * @param array $studentIdList
-     * @param int $userStatus STUDENT|COURSEMANAGER constants
      *
      * @return array|int
      */
@@ -5634,7 +5635,7 @@ 
     /**
      * Get the list of course tools that have to be dealt with in case of
      * registering any course to a session
-     * @return array The list of tools to be dealt with (literal names)
+     * @return string[] The list of tools to be dealt with (literal names)
      */
     public static function getCourseToolToBeManaged()
     {
@@ -5648,7 +5649,7 @@ 
      * Calls the methods bound to each tool when a course is registered into a session
      * @param int $sessionId
      * @param int $courseId
-     * @return void
+     * @return boolean|null
      */
     public static function installCourse($sessionId, $courseId)
     {
@@ -6288,6 +6289,7 @@ 
      * @param int $categoryId The internal ID of the session category
      * @param string $target Value to search for in the session field values
      * @param array $extraFields A list of fields to be scanned and returned
+     * @param DateTime $publicationDate
      * @return mixed
      */
     public static function getShortSessionListAndExtraByCategory($categoryId, $target, $extraFields = null, $publicationDate = null)
@@ -7618,7 +7620,7 @@ 
     /**
      * Get link to the admin page for this session
      * @param   int $id Session ID
-     * @return mixed    URL to the admin page to manage the session, or false on error
+     * @return false|string    URL to the admin page to manage the session, or false on error
      */
     public static function getAdminPath($id)
     {
@@ -7635,7 +7637,7 @@ 
      * If a course is provided, build the link to the course
      * @param   int $id Session ID
      * @param   int $courseId Course ID (optional) in case the link has to send straight to the course
-     * @return mixed    URL to the page to use the session, or false on error
+     * @return false|string    URL to the page to use the session, or false on error
      */
     public static function getPath($id, $courseId = 0)
     {

plugin/vchamilo/lib/Virtual.php

Doc Comments +9 added lines, -7 removed lines

@@ -146,7 +146,7 @@ 
     * provides a side connection to a vchamilo database
     * @param array $_configuration
      *
-    * @return \Doctrine\DBAL\Driver\Connection
+    * @return string
     */
     public static function bootConnection(&$_configuration)
     {
@@ -334,7 +334,7 @@ 
 
     /**
     * get a proper SQLdump command
-    * @param object $vchamilodata the complete new host information
+    * @param stdClass $vchamilodata the complete new host information
     * @return string the shell command
     */
     public static function getDatabaseDumpCmd($vchamilodata)
@@ -418,8 +418,8 @@ 
 
     /**
      * Backups a database for having a snapshot.
-     * @param        $vchamilo    object        The Vchamilo object.
-     * @param        $outputfilerad    string        The output SQL file radical.
+     * @param        stdClass $vchamilo    object        The Vchamilo object.
+     * @param        string $outputfilerad    string        The output SQL file radical.
      * @return        bool    If TRUE, dumping database was a success, otherwise FALSE.
      */
     public static function backupDatabase($vchamilo, $outputfilerad)
@@ -581,6 +581,8 @@ 
     * this function set will map standard moodle API calls to chamilo
     * internal primitives. This avoids too many changes to do in imported
     * code
+    * @param string $module
+    * @param string $key
     */
     public static function getConfig($module, $key, $isplugin = true)
     {
@@ -660,7 +662,7 @@ 
     /**
      * @param string $path
      *
-     * @return mixed
+     * @return string
      */
     public static function chopLastSlash($path)
     {
@@ -812,7 +814,7 @@ 
     }
 
     /**
-     * @param object $instance
+     * @param stdClass $instance
      * @return \Doctrine\DBAL\Connection
      */
     public static function getConnectionFromInstance($instance, $getManager = false)
@@ -1254,7 +1256,7 @@ 
     /**
      * @param stdClass $instance
      *
-     * @return bool|string returns the original version of the app
+     * @return string|false returns the original version of the app
      */
     public static function canBeUpgraded($instance)
     {