chamilo / chamilo-lms

main/admin/class_user_import.php

Doc Comments +3 added lines, -1 removed lines

@@ -11,6 +11,7 @@ 
 
 /**
  * Validates imported data.
+ * @param Ddeboer\DataImport\Reader\CsvReader $user_classes
  */
 function validate_data($user_classes) {
     global $purification_option_for_usernames;
@@ -66,6 +67,7 @@ 
 
 /**
  * Saves imported data.
+ * @param Ddeboer\DataImport\Reader\CsvReader $users_classes
  */
 function save_data($users_classes, $deleteUsersNotInList = false) {
 
@@ -115,7 +117,7 @@ 
 /**
  * Reads a 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_data($file) {
     $courses = Import::csvToArray($file);

main/admin/course_user_import.php

Doc Comments +3 added lines, -1 removed lines

@@ -8,6 +8,7 @@ 
  */
 /**
  * Validates the imported data.
+ * @param Ddeboer\DataImport\Reader\CsvReader $users_courses
  */
 function validate_data($users_courses)
 {
@@ -66,6 +67,7 @@ 
 
 /**
  * Saves imported data.
+ * @param Ddeboer\DataImport\Reader\CsvReader $users_courses
  */
 function save_data($users_courses)
 {
@@ -134,7 +136,7 @@ 
 /**
  * Reads 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_data($file)
 {

main/ticket/tutor_report.lib.php

Doc Comments +4 added lines, -4 removed lines

@@ -73,7 +73,7 @@ 
 
 /**
  * @param $courseInfo
- * @param $weeksCount
+ * @param string $weeksCount
  * @param $page
  * @return array
  */
@@ -182,7 +182,7 @@ 
 
 /**
  * @param $datos
- * @param $pagina
+ * @param integer $pagina
  * @return string
  */
 function showStudentResult($datos, $pagina)
@@ -201,8 +201,8 @@ 
 
 /**
  * @param $data
- * @param $numero_semanas
- * @return array
+ * @param integer $numero_semanas
+ * @return string[]
  */
 function showStudentResultExport($data, $numero_semanas)
 {

plugin/azure_active_directory/src/AzureActiveDirectory.php

Doc Comments +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
     /**
      * Instance the plugin
      * @staticvar null $result
-     * @return Tour
+     * @return AzureActiveDirectory
      */
     static function create()
     {

main/inc/lib/TicketManager.php

Doc Comments +9 added lines, -9 removed lines

@@ -250,8 +250,8 @@ 
      * Inserts a new ticket in the corresponding tables
      * @param $category_id
      * @param $course_id
-     * @param $project_id
-     * @param $other_area
+     * @param integer $project_id
+     * @param integer $other_area
      * @param $email
      * @param $subject
      * @param $content
@@ -632,10 +632,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
@@ -734,9 +734,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(
@@ -1969,7 +1969,7 @@ 
     }
 
     /**
-     * @param $id
+     * @param integer $id
      * @return Project
      */
     public static function getProject($id)

main/inc/lib/attendance.lib.php

Doc Comments +23 added lines, -5 removed lines

@@ -280,7 +280,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)
 	{
@@ -356,6 +356,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)
@@ -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)
 	{
@@ -917,7 +920,11 @@ 
 	 * @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_date
+	 * @param string $lastedit_type
+	 * @param integer $lastedit_user_id
+	 * @return  false|string     Affected rows
 	 */
     public function save_attendance_sheet_log(
         $attendance_id,
@@ -962,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)
@@ -1196,6 +1204,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)
@@ -1223,6 +1232,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)
@@ -1251,6 +1261,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)
@@ -1298,6 +1309,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)
@@ -1421,6 +1433,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)
@@ -1646,7 +1659,6 @@ 
 	/**
 	 * @param int $calendarId
 	 * @param int $courseId
-	 * @param int $groupId
 	 * @return array
 	 */
 	public function getGroupListByAttendanceCalendar($calendarId, $courseId)
@@ -1686,7 +1698,6 @@ 
 	/**
 	 * @param int $calendarId
 	 * @param int $courseId
-	 * @param int $groupId
      *
 	 * @return array
 	 */
@@ -1787,6 +1798,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)
@@ -1826,6 +1839,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)
@@ -1888,6 +1903,9 @@ 
 		$this->course_id = $course_id;
 	}
 
+	/**
+	 * @param string $datetime
+	 */
 	public function set_date_time($datetime)
 	{
 		$this->date_time = $datetime;

main/inc/lib/link.lib.php

Doc Comments +10 added lines, -2 removed lines

@@ -477,6 +477,7 @@ 
      *
      * Get link info
      * @param int link id
+     * @param integer $id
      * @return array link info
      *
      **/
@@ -1061,7 +1062,9 @@ 
     /**
      * Displays the edit, delete and move icons
      * @param int   Category ID
-     * @return void
+     * @param integer $currentCategory
+     * @param integer $countCategories
+     * @return string
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
      */
     public static function showCategoryAdminTools($category, $currentCategory, $countCategories)
@@ -1225,6 +1228,7 @@ 
     /**
      * CSV file import functions
      * @author René Haentjens , Ghent University
+     * @param string $catname
      */
     public static function get_cat($catname)
     {
@@ -1264,6 +1268,11 @@ 
     /**
      * CSV file import functions
      * @author René Haentjens , Ghent University
+     * @param string $url
+     * @param string $title
+     * @param string $description
+     * @param string $on_homepage
+     * @param string $hidden
      */
     public static function put_link($url, $cat, $title, $description, $on_homepage, $hidden)
     {
@@ -1622,7 +1631,6 @@ 
     /**
      * @param int $linkId
      * @param $action
-     * @param null $urlview
      * @param null $token
      * @return FormValidator
      */

main/inc/lib/thematic.lib.php

Doc Comments +9 added lines, -4 removed lines

@@ -242,6 +242,8 @@ 
     /**
      * get thematic list
      * @param	int		Thematic id (optional), get list by id
+     * @param integer $thematic_id
+     * @param integer $session_id
      * @return	array	Thematic data
      */
     public static function get_thematic_list(
@@ -798,6 +800,7 @@ 
     /**
      * delete  thematic advance
      * @param	int		Thematic advance id
+     * @param integer $thematic_advance_id
      * @return	int		Affected rows
      */
     public function thematic_advance_destroy($thematic_advance_id)
@@ -1114,6 +1117,7 @@ 
     /**
      * update done thematic advances from thematic details interface
      * @param 	int		Thematic id
+     * @param integer $thematic_advance_id
      * @return	int		Affected rows
      */
     public function update_done_thematic_advances($thematic_advance_id)
@@ -1296,6 +1300,7 @@ 
      * Get total average of thematic advances
      * @param	string	Course code (optional)
      * @param	int		Session id	(optional)
+     * @param integer $session_id
      * @return 	float	Average of thematic advances
      */
     public function get_total_average_of_thematic_advances($course_code = null, $session_id = null)
@@ -1433,7 +1438,7 @@ 
 
     /**
      * get thematic id
-     * @return void
+     * @return integer
      */
     public function get_thematic_id()
     {
@@ -1442,7 +1447,7 @@ 
 
     /**
      * Get thematic plan titles by default
-     * @return array
+     * @return string[]
      */
     public function get_default_thematic_plan_title()
     {
@@ -1459,7 +1464,7 @@ 
 
     /**
      * Get thematic plan icons by default
-     * @return array
+     * @return string[]
      */
     public function get_default_thematic_plan_icon()
     {
@@ -1476,7 +1481,7 @@ 
 
     /**
      * Get questions by default for help
-     * @return array
+     * @return string[]
      */
     public function get_default_question()
     {

main/wiki/wiki.inc.php

Doc Comments +11 added lines, -3 removed lines

@@ -258,7 +258,7 @@ 
      * This function saves a change in a wiki page
      * @author Patrick Cool <patrick.cool@ugent.be>, Ghent University
      * @param array $values
-     * @return language string saying that the changes are stored
+     * @return string string saying that the changes are stored
      **/
     public function save_wiki($values)
     {
@@ -1196,6 +1196,7 @@ 
      * Checks if this navigation tab has to be set to active
      * @author Patrick Cool <patrick.cool@ugent.be>, Ghent University
      *
+     * @param string $paramwk
      * @return string html code
      */
     public function is_active_navigation_tab($paramwk)
@@ -1711,6 +1712,7 @@ 
 
     /**
      * Sends pending e-mails
+     * @param string $type
      */
     public function check_emailcue($id_or_ref, $type, $lastime='', $lastuser='')
     {
@@ -2011,6 +2013,7 @@ 
 
     /**
      * Exports the wiki page to PDF
+     * @param string $course_code
      */
     public function export_to_pdf($id, $course_code)
     {
@@ -2478,6 +2481,7 @@ 
     /**
      * Draws an HTML form select with the given options
      *
+     * @param string $name
      */
     public function make_select($name,$values,$checked='')
     {
@@ -2514,7 +2518,7 @@ 
     /**
      * Get wiki information
      * @param   int     wiki id
-     * @return  array   wiki data
+     * @return  string   wiki data
      */
     public function get_wiki_data($id)
     {
@@ -2558,6 +2562,7 @@ 
      * Get wiki information
      * @param   string     wiki id
      * @param int $courseId
+     * @param string $title
      * @return  array   wiki data
      */
     public function getPageByTitle($title, $courseId = null)
@@ -2590,6 +2595,8 @@ 
      * @param int $courseId
      * @param string
      * @param string
+     * @param string $groupfilter
+     * @param string $condition_session
      * @return bool
      */
     public function deletePage($title, $courseId, $groupfilter = null, $condition_session = null)
@@ -3635,6 +3642,7 @@ 
 
     /**
      * Show all pages
+     * @param string $action
      */
     public function allPages($action)
     {
@@ -4190,7 +4198,7 @@ 
 
     /**
      * Restore page
-     * @return bool
+     * @return false|null
      */
     public function restorePage()
     {