chamilo / chamilo-lms

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

Doc Comments +21 added lines, -15 removed lines

@@ -422,6 +422,7 @@ 
  * If null, the timezone will be determined based on user preference,
  * or timezone chosen by the admin for the platform.
  * @param string The timezone to be converted from. If null, UTC will be assumed.
+ * @param string $to_timezone
  * @return string The converted time formatted as Y-m-d H:i:s
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
@@ -666,6 +667,7 @@ 
  * @param mixed The time to be converted
  * @param mixed Format to be used (TIME_NO_SEC_FORMAT, DATE_FORMAT_SHORT, DATE_FORMAT_LONG, DATE_TIME_FORMAT_LONG)
  * @param string Timezone to be converted from. If null, UTC will be assumed.
+ * @param string $from_timezone
  * @return string Converted and localized date
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
@@ -735,7 +737,7 @@ 
  * @param int/string $format (optional)	The person name format. It may be a pattern-string (for example '%t %l, %f' or '%T %F %L', ...) or some of the constants PERSON_NAME_COMMON_CONVENTION (default), PERSON_NAME_WESTERN_ORDER, PERSON_NAME_EASTERN_ORDER, PERSON_NAME_LIBRARY_ORDER.
  * @param string $language (optional)	The language id. If it is omitted, the current interface language is assumed. This parameter has meaning with the format PERSON_NAME_COMMON_CONVENTION only.
  * @param string $encoding (optional)	The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return bool							The result is sort of full name of the person.
+ * @return string							The result is sort of full name of the person.
  * Sample results:
  * Peter Ustinoff or Dr. Peter Ustinoff     - the Western order
  * Ustinoff Peter or Dr. Ustinoff Peter     - the Eastern order
@@ -829,7 +831,7 @@ 
 
 /**
  * Checks whether a given format represents person name in Western order (for which first name is first).
- * @param int/string $format (optional)	The person name format. It may be a pattern-string (for example '%t. %l, %f') or some of the constants PERSON_NAME_COMMON_CONVENTION (default), PERSON_NAME_WESTERN_ORDER, PERSON_NAME_EASTERN_ORDER, PERSON_NAME_LIBRARY_ORDER.
+ * @param integer $format (optional)	The person name format. It may be a pattern-string (for example '%t. %l, %f') or some of the constants PERSON_NAME_COMMON_CONVENTION (default), PERSON_NAME_WESTERN_ORDER, PERSON_NAME_EASTERN_ORDER, PERSON_NAME_LIBRARY_ORDER.
  * @param string $language (optional)	The language id. If it is omitted, the current interface language is assumed. This parameter has meaning with the format PERSON_NAME_COMMON_CONVENTION only.
  * @return bool							The result TRUE means that the order is first_name last_name, FALSE means last_name first_name.
  * Note: You may use this function for determing the order of the fields or columns "First name" and "Last name" in forms, tables and reports.
@@ -1054,8 +1056,8 @@ 
 
 /**
  * This function returns a string or an array with all occurrences of search in subject (ignoring case) replaced with the given replace value.
- * @param mixed $search					String or array of strings to be found.
- * @param mixed $replace				String or array of strings used for replacement.
+ * @param string $search					String or array of strings to be found.
+ * @param string $replace				String or array of strings used for replacement.
  * @param mixed $subject				String or array of strings being searched.
  * @param int $count (optional)			The number of matched and replaced needles will be returned in count, which is passed by reference.
  * @param string $encoding (optional)	The used internally by this function character encoding.
@@ -1118,10 +1120,10 @@ 
 /**
  * Finds first occurrence of a string within another, case insensitive.
  * @param string $haystack					The string from which to get the first occurrence.
- * @param mixed $needle						The string to be found.
+ * @param string $needle						The string to be found.
  * @param bool $before_needle (optional)	Determines which portion of $haystack this function returns. The default value is FALSE.
  * @param string $encoding (optional)		The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed							Returns the portion of $haystack, or FALSE if $needle is not found.
+ * @return false|string							Returns the portion of $haystack, or FALSE if $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the ordinal value (codepoint if the encoding is UTF-8) of a character.
  * If $before_needle is set to TRUE, the function returns all of $haystack from the beginning to the first occurrence of $needle.
@@ -1177,7 +1179,7 @@ 
  * @param mixed $needle						The string which first character is to be found.
  * @param bool $before_needle (optional)	Determines which portion of $haystack this function returns. The default value is FALSE.
  * @param string $encoding (optional)		The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed							Returns the portion of $haystack, or FALSE if the first character from $needle is not found.
+ * @return false|string							Returns the portion of $haystack, or FALSE if the first character from $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the ordinal value (codepoint if the encoding is UTF-8) of a character.
  * If $before_needle is set to TRUE, the function returns all of $haystack from the beginning to the first occurrence.
@@ -1244,7 +1246,7 @@ 
  * @param mixed $needle						The string to be found.
  * @param bool $before_needle (optional)	Determines which portion of $haystack this function returns. The default value is FALSE.
  * @param string $encoding (optional)		The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed							Returns the portion of $haystack, or FALSE if $needle is not found.
+ * @return false|string							Returns the portion of $haystack, or FALSE if $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the ordinal value (codepoint if the encoding is UTF-8) of a character.
  * If $before_needle is set to TRUE, the function returns all of $haystack from the beginning to the first occurrence of $needle.
@@ -1387,7 +1389,7 @@ 
  * 										Note that this changes the return value in an array where every element is an array consisting of the matched string at index 0 and its string offset into subject at index 1.
  * @param int $offset (optional)		Normally, the search starts from the beginning of the subject string. The optional parameter offset can be used to specify the alternate place from which to start the search.
  * @param string $encoding (optional)	The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return int|boolean					Returns the number of times pattern matches or FALSE if an error occurred.
+ * @return integer					Returns the number of times pattern matches or FALSE if an error occurred.
  * @link http://php.net/preg_match
  */
 function api_preg_match($pattern, $subject, &$matches = null, $flags = 0, $offset = 0, $encoding = null) {
@@ -1410,7 +1412,7 @@ 
  * If no order flag is given, PREG_PATTERN_ORDER is assumed.
  * @param int $offset (optional)		Normally, the search starts from the beginning of the subject string. The optional parameter offset can be used to specify the alternate place from which to start the search.
  * @param string $encoding (optional)	The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return int|boolean					Returns the number of full pattern matches (which might be zero), or FALSE if an error occurred.
+ * @return integer					Returns the number of full pattern matches (which might be zero), or FALSE if an error occurred.
  * @link http://php.net/preg_match_all
  */
 function api_preg_match_all($pattern, $subject, &$matches, $flags = PREG_PATTERN_ORDER, $offset = 0, $encoding = null) {
@@ -1425,8 +1427,8 @@ 
 
 /**
  * Performs a regular expression search and replace, UTF-8 aware when it is applicable.
- * @param string|array $pattern			The pattern to search for. It can be either a string or an array with strings.
- * @param string|array $replacement		The string or an array with strings to replace.
+ * @param string $pattern			The pattern to search for. It can be either a string or an array with strings.
+ * @param string $replacement		The string or an array with strings to replace.
  * @param string|array $subject			The string or an array with strings to search and replace.
  * @param int $limit					The maximum possible replacements for each pattern in each subject string. Defaults to -1 (no limit).
  * @param int &$count					If specified, this variable will be filled with the number of replacements done.
@@ -1574,7 +1576,7 @@ 
 
 /**
  * This function checks whether two $encoding are equal (same, equvalent).
- * @param string/array $encoding1		The first encoding
+ * @param string $encoding1		The first encoding
  * @param string/array $encoding2		The second encoding
  * @param bool $strict					When this parameter is TRUE the comparison ignores aliases of encodings.
  * When the parameter is FALSE, aliases are taken into account.
@@ -1678,6 +1680,7 @@ 
 /**
  * Checks a string for UTF-8 validity.
  *
+ * @param string $string
  */
 function api_is_valid_utf8(&$string)
 {
@@ -1820,7 +1823,7 @@ 
 /**
  * Replaces non-valid formats for person names with the default (English) format.
  * @param string $format	The input format to be verified.
- * @return bool				Returns the same format if is is valid, otherwise returns a valid English format.
+ * @return string				Returns the same format if is is valid, otherwise returns a valid English format.
  */
 function _api_validate_person_name_format($format) {
     if (empty($format) || stripos($format, '%f') === false || stripos($format, '%l') === false) {
@@ -1947,6 +1950,9 @@ 
 
 // This function checks whether the function _api_convert_encoding() (the php-
 // implementation) is able to convert from/to a given encoding.
+/**
+ * @param string $encoding
+ */
 function _api_convert_encoding_supports($encoding) {
     static $supports = array();
     if (!isset($supports[$encoding])) {
@@ -1957,7 +1963,7 @@ 
 
 /**
  * Given a date object, return a human or ISO format, with or without h:m:s
- * @param object $date The Date object
+ * @param DateTime $date The Date object
  * @param bool $showTime Whether to show the time and date (true) or only the date (false)
  * @param bool $humanForm Whether to show day-month-year (true) or year-month-day (false)
  * @return string Formatted date

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

src/Chamilo/CourseBundle/Component/CourseCopy/CourseArchiver.php

Doc Comments +1 added lines, -1 removed lines

@@ -173,7 +173,7 @@
 
     /**
      * @param array $file
-     * @return bool|string
+     * @return string|false
      */
     public static function import_uploaded_file($file)
     {

src/Chamilo/CourseBundle/Component/CourseCopy/CourseRecycler.php

Doc Comments +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
     }
 
     /**
-     * @return bool
+     * @return false|null
      */
     public function create_user_folder()
     {