chamilo / chamilo-lms

main/inc/lib/attendance.lib.php

Doc Comments +20 added lines, -6 removed lines

@@ -277,7 +277,7 @@ 
      * Add attendances sheet inside table. This is the *list of* dates, not
      * a specific date in itself.
      * @param  bool   true for adding link in gradebook or false otherwise (optional)
-     * @return int    last attendance id
+     * @return false|string    last attendance id
      */
     public function attendance_add($link_to_gradebook = false)
     {
@@ -354,6 +354,7 @@ 
      * edit attendances inside table
      * @param 	int	   attendance id
      * @param  	bool   true for adding link in gradebook or false otherwise (optional)
+     * @param integer $attendance_id
      * @return 	int    last id
      */
     public function attendance_edit($attendance_id, $link_to_gradebook = false)
@@ -429,6 +430,7 @@ 
     /**
      * Restore attendance
      * @param 	int|array	   one or many attendances id
+     * @param integer $attendance_id
      * @return 	int    		   affected rows
      */
     public function attendance_restore($attendance_id)
@@ -478,7 +480,7 @@ 
 
     /**
      * Delete attendances
-     * @param 	int|array	$attendance_id   one or many attendances id
+     * @param 	integer	$attendance_id   one or many attendances id
      * @return 	int    		   affected rows
      */
     public function attendance_delete($attendance_id)
@@ -530,7 +532,7 @@ 
 
     /**
      * Changes visibility
-     * @param int|array	$attendanceId   one or many attendances id
+     * @param integer	$attendanceId   one or many attendances id
      * @param int status
      *
      * @return 	int affected rows
@@ -585,6 +587,7 @@ 
      * Lock or unlock an attendance
      * @param   int     attendance id
      * @param   bool    True to lock or false otherwise
+     * @param integer $attendance_id
      */
     public function lock_attendance($attendance_id, $lock = true)
     {
@@ -918,7 +921,10 @@ 
      * @param   string  Event type ('locked_attendance', 'done_attendance_sheet' ...)
      * @param   int     Last edit user id
      * @param   string  Calendar datetime value (optional, when event type is 'done_attendance_sheet')
-     * @return  int     Affected rows
+     * @param integer $attendance_id
+     * @param string $lastedit_type
+     * @param integer $lastedit_user_id
+     * @return  false|string     Affected rows
      */
     public function save_attendance_sheet_log(
         $attendance_id,
@@ -963,6 +969,7 @@ 
     /**
      * Get number of done attendances inside current sheet
      * @param	int	   attendance id
+     * @param integer $attendance_id
      * @return 	int	   number of done attendances
      */
     public static function get_done_attendance_calendar($attendance_id)
@@ -1198,6 +1205,7 @@ 
     /**
      * Get next attendance calendar without presences (done attendances)
      * @param	int	attendance id
+     * @param integer $attendance_id
      * @return 	int attendance calendar id
      */
     public function get_next_attendance_calendar_id($attendance_id)
@@ -1226,6 +1234,7 @@ 
     /**
      * Get next attendance calendar datetime without presences (done attendances)
      * @param	int	attendance id
+     * @param integer $attendance_id
      * @return 	int UNIX time format datetime
      */
     public function get_next_attendance_calendar_datetime($attendance_id)
@@ -1254,6 +1263,7 @@ 
      * Get user' score from current attendance
      * @param	int	$user_id
      * @param	int $attendance_id
+     * @param integer $groupId
      * @return	int score
      */
     public function get_user_score($user_id, $attendance_id, $groupId = null)
@@ -1301,6 +1311,7 @@ 
     /**
      * Get attendance calendar data by id
      * @param	int	attendance calendar id
+     * @param integer $calendar_id
      * @return	array attendance calendar data
      */
     public function get_attendance_calendar_by_id($calendar_id)
@@ -1423,6 +1434,7 @@ 
      * Get number of attendance calendar inside current attendance
      * @param	int	$attendance_id
      * @param	int	$groupId
+     * @param boolean $done_attendance
      * @return	int number of dates in attendance calendar
      */
     public static function get_number_of_attendance_calendar($attendance_id, $groupId = 0, $done_attendance = NULL, $userId = 0)
@@ -1648,7 +1660,6 @@ 
     /**
      * @param int $calendarId
      * @param int $courseId
-     * @param int $groupId
      * @return array
      */
     public function getGroupListByAttendanceCalendar($calendarId, $courseId)
@@ -1688,7 +1699,6 @@ 
     /**
      * @param int $calendarId
      * @param int $courseId
-     * @param int $groupId
      *
      * @return array
      */
@@ -1789,6 +1799,8 @@ 
      * edit a datetime inside attendance calendar table
      * @param	int	attendance calendar id
      * @param	int	attendance id
+     * @param integer $calendar_id
+     * @param integer $attendance_id
      * @return	int affected rows
      */
     public function attendance_calendar_edit($calendar_id, $attendance_id)
@@ -1828,6 +1840,8 @@ 
      * @param	int		attendance calendar id
      * @param	int		attendance id
      * @param	bool	true for removing all calendar inside current attendance, false for removing by calendar id
+     * @param integer $calendar_id
+     * @param integer $attendance_id
      * @return	int affected rows
      */
     public function attendance_calendar_delete($calendar_id, $attendance_id , $all_delete = false)

main/inc/lib/course.lib.php

Doc Comments +7 added lines, -6 removed lines

@@ -792,7 +792,7 @@ 
      * @param  string $courseCode the course code
      * @param  int $visible (optional) The course visibility in the catalogue to the user (1=visible, 0=invisible)
      *
-     * @return boolean true if added succesfully, false otherwise.
+     * @return boolean|string true if added succesfully, false otherwise.
      */
     public static function addUserVisibilityToCourseInCatalogue($userId, $courseCode, $visible = 1)
     {
@@ -2664,7 +2664,7 @@ 
      * then the courses that the user is allowed or not to see in catalogue
      *
      * @param boolean $allowed Either if the courses have some users that are or are not allowed to see in catalogue
-     * @param boolean $byUserId if the courses are or are not allowed to see to the user
+     * @param integer $byUserId if the courses are or are not allowed to see to the user
      * @return array Course codes allowed or not to see in catalogue by some user or the user
      */
     public static function getCatalogueCourseList($allowed = true, $byUserId = -1)
@@ -3208,6 +3208,7 @@ 
      * @param int $limit
      * @param string $column
      * @param string $direction
+     * @param integer $status
      * @return array    courses
      */
     public static function get_courses_followed_by_drh(
@@ -4801,7 +4802,7 @@ 
      * Returns an array with the hottest courses
      * @param   int $days number of days
      * @param   int $limit number of hottest courses
-     * @return array
+     * @return null|Symfony\Component\HttpFoundation\Response
      */
     public static function return_hot_courses($days = 30, $limit = 6)
     {
@@ -5056,7 +5057,7 @@ 
     /**
      * Returns the SQL conditions to filter course only visible by the user in the catalogue
      *
-     * @param $courseTableAlias Alias of the course table
+     * @param string $courseTableAlias Alias of the course table
      * @return string SQL conditions
      */
     public static function getCourseVisibilitySQLCondition($courseTableAlias) {
@@ -6151,11 +6152,11 @@ 
 
     /**
      * @param int $user_id
-     * @param $filter
+     * @param string $filter
      * @param bool $load_dirs
      * @param int $getCount
      * @param int $start
-     * @param null $maxPerPage
+     * @param integer $maxPerPage
      * @return null|string
      */
     public static function displayCourses($user_id, $filter, $load_dirs, $getCount, $start = null, $maxPerPage = null)

main/inc/lib/course_home.lib.php

Doc Comments +3 added lines, -2 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"
      */
@@ -1014,6 +1014,7 @@ 
      * Shows the general data for a particular meeting
      *
      * @param id	session id
+     * @param integer $id_session
      * @return string	session data
      */
     public static function show_session_data($id_session)
@@ -1517,7 +1518,7 @@ 
 
     /**
      * Available tools
-     * @return array
+     * @return string[]
      */
     public static function availableTools()
     {

main/inc/lib/api.lib.php

Doc Comments +8 added lines, -3 removed lines

@@ -1263,6 +1263,7 @@ 
  * Gets the list of courses a specific user is subscribed to
  * @param int       User ID
  * @param boolean   $fetch_session Whether to get session courses or not - NOT YET IMPLEMENTED
+ * @param integer $userid
  * @return array    Array of courses in the form [0]=>('code'=>xxx,'db'=>xxx,'dir'=>xxx,'status'=>d)
  */
 function api_get_user_courses($userid, $fetch_session = true)
@@ -3024,7 +3025,7 @@ 
 * on the session visibility
 * @param bool $tutor  Whether to check if the user has the tutor role
 * @param bool  $coach Whether to check if the user has the coach role
-* @return boolean true: the user has the rights to edit, false: he does not
+* @return boolean|null true: the user has the rights to edit, false: he does not
 */
 function api_is_allowed_to_session_edit($tutor = false, $coach = false)
 {
@@ -4199,6 +4200,7 @@ 
 /**
  * Returns the id (the database id) of a language
  * @param   string  language name (the corresponding name of the language-folder in the filesystem)
+ * @param string $language
  * @return  int     id of the language
  */
 function api_get_language_id($language)
@@ -5207,6 +5209,7 @@ 
  * @param string    Whether we want a simple list (display a category) or
  * a grouped list (group by variable as in settings.php default). Values: 'list' or 'group'
  * @param int       Access URL's ID. Optional. Uses 1 by default, which is the unique URL
+ * @param string $cat
  * @return array    Array of database results for the current settings of the current access URL
  */
 function &api_get_settings($cat = null, $ordering = 'list', $access_url = 1, $url_changeable = 0)
@@ -6285,7 +6288,7 @@ 
  *
  * Returns the <link> HTML tag
  *
- * @param $file
+ * @param string $file
  * @param string $media
  * @return string
  */
@@ -6608,7 +6611,7 @@ 
 /**
  * Returns an array of global configuration settings which should be ignored
  * when printing the configuration settings screens
- * @return array Array of strings, each identifying one of the excluded settings
+ * @return string[] Array of strings, each identifying one of the excluded settings
  */
 function api_get_locked_settings() {
     return array(
@@ -6649,6 +6652,7 @@ 
  * false if he isn't. If the user ID is given and is an integer, then the same
  * ID is simply returned
  * @param  integer User ID
+ * @param integer $user_id
  * @return boolean Integer User ID is logged in, or false otherwise
  */
 function api_user_is_login($user_id = null) {
@@ -7069,6 +7073,7 @@ 
 /**
  * Gets memory limit in bytes
  * @param string The memory size (128M, 1G, 1000K, etc)
+ * @param string $mem
  * @return int
  * @assert (null) === false
  * @assert ('1t')  === 1099511627776

main/exercise/exercise.class.php

Doc Comments +9 added lines, -6 removed lines

@@ -353,7 +353,7 @@ 
     }
 
     /**
-     * @return int
+     * @return string
      */
     public function selectPassPercentage()
     {
@@ -462,7 +462,7 @@ 
      * tells if questions are selected randomly, and if so returns the draws
      *
      * @author Olivier Brouckaert
-     * @return integer - 0 if not random, otherwise the draws
+     * @return boolean - 0 if not random, otherwise the draws
      */
     public function isRandom()
     {
@@ -2838,7 +2838,7 @@ 
      * @param int  int lp id
      * @param int  int lp item id
      * @param int  int lp item_view id
-     * @param float $weight
+     * @param integer $weight
      * @param array question list
      */
     public function save_stat_track_exercise_info(
@@ -5246,7 +5246,7 @@ 
      * @param int $exe_id
      * @param float $score
      * @param float $weight
-     * @return bool
+     * @return false|null
      */
     public function send_mail_notification_for_exam($question_list_answers, $origin, $exe_id, $score, $weight)
     {
@@ -5445,6 +5445,9 @@ 
         }
     }
 
+    /**
+     * @param integer $exe_id
+     */
     function send_notification_for_oral_questions($question_list_answers, $origin, $exe_id)
     {
         if (api_get_course_setting('email_alert_manager_on_new_quiz') != 1 ) {
@@ -5596,7 +5599,7 @@ 
      * @param int     Maximum number of attempts (0 if no limit)
      * @param int     Feedback type
      * @todo this was function was added due the import exercise via CSV
-     * @return    int New exercise ID
+     * @return    string New exercise ID
      */
     public function createExercise(
         $title,
@@ -6931,7 +6934,7 @@ 
      * @param bool $show_comment
      * @param null $exercise_feedback
      * @param bool $show_answers
-     * @param null $modelType
+     * @param integer $modelType
      * @param bool $categoryMinusOne
      * @return bool|null|string
      */

main/forum/forumfunction.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -3132,7 +3132,7 @@ 
  * @param integer $thread_qualify
  * @param integer $qualify_time
  * @param integer $session_id
- * @return array optional
+ * @return string|null optional
  * @author Isaac Flores <isaac.flores@dokeos.com>, U.N.A.S University
  * @version October 2008, dokeos  1.8.6
  */
@@ -3952,7 +3952,7 @@ 
 
 /**
  * This function is used to find all the information about what's new in the forum tool
- * @return void
+ * @return false|null
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @version february 2006, dokeos 1.8

main/inc/lib/banner.lib.php

Doc Comments -1 removed lines

@@ -170,7 +170,6 @@
 
 /**
  * Return the active logo of the portal, based on a series of settings
- * @param string $theme The name of the theme folder from web/css/themes/
  * @return string HTML string with logo as an HTML element
  */
 function return_logo()

main/admin/course_import.php

Doc Comments +1 added lines, -1 removed lines

@@ -146,7 +146,7 @@
 /**
  * Read the CSV-file
  * @param string $file Path to the CSV-file
- * @return array All course-information read from the file
+ * @return Ddeboer\DataImport\Reader\CsvReader All course-information read from the file
  */
 function parse_csv_courses_data($file)
 {

main/exercise/export/exercise_import.inc.php

Doc Comments -1 removed lines

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