chamilo / chamilo-lms

plugin/ims_lti/ImsLtiTool.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
         return $this->id;
     }
 
+    /**
+     * @return string
+     */
     public function getName()
     {
         return $this->name;

plugin/ims_lti/OAuthSimple.php

Doc Comments +3 added lines

@@ -334,6 +334,9 @@
         return preg_replace('/, $/','',$result);
     }
 
+    /**
+     * @param string $paramString
+     */
     private function _parseParameterString ($paramString)
     {
         $elements = explode('&',$paramString);

main/inc/lib/groupmanager.lib.php

Doc Comments +12 added lines, -9 removed lines

@@ -371,7 +371,7 @@ 
      * @author Bart Mollet
      * @param  int  $groupId iid
      * @param string $course_code Default is current course
-     * @return integer              - number of groups deleted.
+     * @return boolean              - number of groups deleted.
      */
     public static function delete_groups($groupId, $course_code = null)
     {
@@ -563,7 +563,7 @@ 
      * @param bool      Whether self registration is allowed or not
      * @param bool      Whether self unregistration is allowed or not
      * @param int       $categoryId
-     * @return bool     TRUE if properties are successfully changed, false otherwise
+     * @return Statement|null     TRUE if properties are successfully changed, false otherwise
      */
     public static function set_group_properties(
         $group_id,
@@ -716,7 +716,7 @@ 
      * @param int $group_id The iid of the group
      * @param string $course_code The course in which the group is (default =
      * current course)
-     * @return array The category
+     * @return integer The category
      */
     public static function get_category_from_group($group_id, $course_code = null)
     {
@@ -782,9 +782,9 @@ 
      * Create group category
      * @param string $title The title of the new category
      * @param string $description The description of the new category
-     * @param bool $self_registration_allowed
-     * @param bool $self_unregistration_allowed
-     * @param int $max_number_of_students
+     * @param integer $self_registration_allowed
+     * @param integer $self_unregistration_allowed
+     * @param int $maximum_number_of_students
      * @param int $groups_per_user
      */
     public static function create_category(
@@ -990,6 +990,8 @@ 
      * @param int $limit
      * @param bool $getCount
      * @param int $courseId
+     * @param string $column
+     * @param string $direction
      * @return array list of user id
      */
     public static function get_users(
@@ -1583,7 +1585,7 @@ 
     /**
      * Subscribe tutor(s) to a specified group in current course
      * @param mixed $user_ids Can be an array with user-id's or a single user-id
-     * @param int $group_id iid
+     * @param int $groupId iid
      * @param int $course_id
      *
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
@@ -1614,7 +1616,7 @@ 
      * Unsubscribe user(s) from a specified group in current course
      * @param mixed $user_ids Can be an array with user-id's or a single user-id
      * @param int $group_id iid
-     * @return bool TRUE if successful
+     * @return boolean|null TRUE if successful
      */
     public static function unsubscribe_users($user_ids, $group_id)
     {
@@ -1633,7 +1635,7 @@ 
 
     /**
      * Unsubscribe all users from one or more groups
-     * @param int $group_id iid
+     * @param integer $groupId iid
      * @return bool TRUE if successful
      */
     public static function unsubscribe_all_users($groupId)
@@ -1781,6 +1783,7 @@ 
      *
      * @param $user_array_in list of users (must be sorted).
      * @param string $compare_field, the field to be compared
+     * @param string $compare_field
      */
     public static function filter_duplicates($user_array_in, $compare_field)
     {

main/webservices/cm_webservice.php

Doc Comments +5 added lines, -1 removed lines

@@ -37,6 +37,8 @@ 
      *
      * @param int Error code
      * @param string Error message
+     * @param integer $code
+     * @param string $message
      */
     public function __construct($code, $message)
     {
@@ -48,6 +50,7 @@ 
      * Sets the error handler
      *
      * @param WSErrorHandler Error handler
+     * @param WSCMSoapErrorHandler $handler
      */
     public static function setErrorHandler($handler)
     {
@@ -86,6 +89,7 @@ 
 	 * Handle method
 	 *
 	 * @param WSError Error
+	 * @return void
 	 */
 	public function handle($error);
 }
@@ -114,7 +118,7 @@ 
 	 * Verifies the API key
 	 *
 	 * @param string Secret key
-	 * @return mixed WSError in case of failure, null in case of success
+	 * @return WSCMError|null WSError in case of failure, null in case of success
 	 */
 	protected function verifyKey($secret_key)
     {

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/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)) {