chamilo / chamilo-lms

main/inc/lib/course.lib.php

Doc Comments +34 added lines, -20 removed lines

@@ -716,7 +716,7 @@ 
      * @param  int $status (optional) The user's status in the course
      * @param  int The user category in which this subscription will be classified
      *
-     * @return boolean true if subscription succeeds, boolean false otherwise.
+     * @return false|string true if subscription succeeds, boolean false otherwise.
      * @assert ('', '') === false
      */
     public static function add_user_to_course($user_id, $courseCode, $status = STUDENT, $userCourseCategoryId = 0)
@@ -788,7 +788,7 @@ 
      *    Checks wether a parameter exists.
      *    If it doesn't, the function displays an error message.
      *
-     * @return true if parameter is set and not empty, false otherwise
+     * @return boolean if parameter is set and not empty, false otherwise
      * @todo move function to better place, main_api ?
      */
     public static function check_parameter($parameter, $error_message)
@@ -812,7 +812,7 @@ 
     }
 
     /**
-     * @return true if there already are one or more courses
+     * @return boolean if there already are one or more courses
      *  with the same code OR visual_code (visualcode), false otherwise
      */
     public static function course_code_exists($wanted_course_code)
@@ -985,7 +985,7 @@ 
     /**
      * @param int $userId
      * @param array $courseInfo
-     * @return bool
+     * @return boolean|null
      */
     public static function isUserSubscribedInCourseAsDrh($userId, $courseInfo)
     {
@@ -1091,10 +1091,10 @@ 
     /**
      *    Is the user a teacher in the given course?
      *
-     * @param $user_id , the id (int) of the user
+     * @param integer $user_id , the id (int) of the user
      * @param $course_code , the course code
      *
-     * @return true if the user is a teacher in the course, false otherwise
+     * @return boolean if the user is a teacher in the course, false otherwise
      */
     public static function is_course_teacher($user_id, $course_code)
     {
@@ -1123,7 +1123,7 @@ 
      * @param int the id of the user
      * @param int $courseId
      * @deprecated linked_courses definition doesn't exists
-     * @return true if the user is registered in the real course or linked courses, false otherwise
+     * @return boolean if the user is registered in the real course or linked courses, false otherwise
      */
     public static function is_user_subscribed_in_real_or_linked_course($user_id, $courseId, $session_id = '')
     {
@@ -1194,9 +1194,9 @@ 
      * @param string $order_by the field to order the users by.
      * Valid values are 'lastname', 'firstname', 'username', 'email', 'official_code' OR a part of a SQL statement
      * that starts with ORDER BY ...
-     * @param null $filter_by_status if using the session_id: 0 or 2 (student, coach),
+     * @param integer|null $filter_by_status if using the session_id: 0 or 2 (student, coach),
      * if using session_id = 0 STUDENT or COURSEMANAGER
-     * @param null $return_count
+     * @param boolean|null $return_count
      * @param bool $add_reports
      * @param bool $resumed_report
      * @param array $extra_field
@@ -1943,7 +1943,7 @@ 
      * @param int $courseId
      * @param string $separator
      * @param bool $add_link_to_profile
-     * @return null|string
+     * @return string
      */
     public static function get_coachs_from_course_to_string(
         $session_id = 0,
@@ -2016,7 +2016,7 @@ 
      * Get the list of groups from the course
      * @param   string $course_code
      * @param   int $session_id Session ID (optional)
-     * @param   boolean $in_get_empty_group get empty groups (optional)
+     * @param   integer $in_get_empty_group get empty groups (optional)
      * @return  array   List of groups info
      */
     public static function get_group_list_of_course($course_code, $session_id = 0, $in_get_empty_group = 0)
@@ -2072,6 +2072,7 @@ 
      * course.
      *
      * @param string The code of the course to delete
+     * @param string $code
      * @todo When deleting a virtual course: unsubscribe users from that virtual
      * course from the groups in the real course if they are not subscribed in
      * that real course.
@@ -2283,6 +2284,7 @@ 
      * Sort courses for a specific user ??
      * @param   int     User ID
      * @param   string  Course code
+     * @param integer $user_id
      * @return  int     Minimum course order
      * @todo Review documentation
      */
@@ -2360,7 +2362,7 @@ 
      * check if course exists
      * @param string course_code
      * @param string whether to accept virtual course codes or not
-     * @return true if exists, false else
+     * @return integer if exists, false else
      */
     public static function course_exists($course_code, $accept_virtual = false)
     {
@@ -2379,9 +2381,9 @@ 
      * Send an email to tutor after the auth-suscription of a student in your course
      * @author Carlos Vargas <carlos.vargas@dokeos.com>, Dokeos Latino
      * @param  int $user_id the id of the user
-     * @param  string $course_code the course code
+     * @param  string $courseId the course code
      * @param  bool $send_to_tutor_also
-     * @return string we return the message that is displayed when the action is successful
+     * @return false|null we return the message that is displayed when the action is successful
      */
     public static function email_to_tutor($user_id, $courseId, $send_to_tutor_also = false)
     {
@@ -2624,6 +2626,7 @@ 
     /**
      * Get emails of tutors to course
      * @param string Visual code
+     * @param integer $courseId
      * @return array List of emails of tutors to course
      * @author @author Carlos Vargas <carlos.vargas@dokeos.com>, Dokeos Latino
      * */
@@ -2647,6 +2650,7 @@ 
      * Get coaches emails by session
      * @param int session id
      * @param int $courseId
+     * @param integer $session_id
      * @return array  array(email => name_tutor)  by coach
      * @author Carlos Vargas <carlos.vargas@dokeos.com>
      */
@@ -2695,7 +2699,9 @@ 
      * @param    string    Field's internal variable name
      * @param    int        Field's type
      * @param    string    Field's language var name
-     * @return int     new extra field id
+     * @param integer $fieldType
+     * @param string $default
+     * @return boolean     new extra field id
      */
     public static function create_course_extra_field($variable, $fieldType, $displayText, $default)
     {
@@ -2717,7 +2723,7 @@ 
      * @param int Course id
      * @param string Attribute name
      * @param string Attribute value
-     * @return bool True if attribute was successfully updated,
+     * @return Doctrine\DBAL\Driver\Statement|null True if attribute was successfully updated,
      * false if course was not found or attribute name is invalid
      */
     public static function update_attribute($id, $name, $value)
@@ -2735,7 +2741,7 @@ 
      *
      * @param int Course id
      * @param array Associative array with field names as keys and field values as values
-     * @return bool True if update was successful, false otherwise
+     * @return Doctrine\DBAL\Driver\Statement|null True if update was successful, false otherwise
      */
     public static function update_attributes($id, $attributes)
     {
@@ -2761,7 +2767,7 @@ 
      * @param    integer    Course ID
      * @param    string    Field variable name
      * @param    string    Field value
-     * @return    boolean    true if field updated, false otherwise
+     * @return    boolean|null    true if field updated, false otherwise
      */
     public static function update_course_extra_field_value($course_code, $variable, $value = '')
     {
@@ -3483,6 +3489,7 @@ 
      * @uses displayCoursesInCategory() to display the courses themselves
      * @param int        user id
      * @param bool      Whether to show the document quick-loader or not
+     * @param integer $user_id
      * @return string
      */
     public static function display_courses($user_id, $load_dirs = false)
@@ -4057,6 +4064,8 @@ 
      * @param     int        source session id
      * @param    string    destination course code
      * @param     int        destination session id
+     * @param integer $source_session_id
+     * @param integer $destination_session_id
      * @return  bool
      */
     public static function copy_course(
@@ -4091,6 +4100,7 @@ 
      * @param     int        source session id
      * @param     int        destination session id
      * @param    bool    new copied tools (Exercises and LPs)will be set to invisible by default?
+     * @param string $new_title
      *
      * @return     array
      */
@@ -4344,6 +4354,7 @@ 
      * @param int   course id
      * @param int   session id
      * @param id    url id
+     * @param integer $session_id
      * @return array
      **/
     public static function update_course_ranking(
@@ -4426,7 +4437,7 @@ 
      * @param   int course id
      * @param   int session id
      * @param   int url id (access_url_id)
-     * @return    mixed 'added', 'updated' or 'nothing'
+     * @return    false|string 'added', 'updated' or 'nothing'
      */
     public static function add_course_vote($user_id, $vote, $course_id, $session_id = null, $url_id = null)
     {
@@ -4681,6 +4692,7 @@ 
      * Get courses count
      * @param int Access URL ID (optional)
      * @param int $visibility
+     * @param integer $access_url_id
      *
      * @return int Number of courses
      */
@@ -4737,6 +4749,7 @@ 
     /**
      * Get available le courses count
      * @param int Access URL ID (optional)
+     * @param integer $accessUrlId
      * @return int Number of courses
      */
     public static function countAvailableCourses($accessUrlId = null)
@@ -4781,6 +4794,7 @@ 
      * @param int User ID
      * @param array Course details array
      * @param array  List of courses to which the user is subscribed (if not provided, will be generated)
+     * @param integer $uid
      * @return mixed 'enter' for a link to go to the course or 'register' for a link to subscribe, or false if no access
      */
     static function get_access_link_by_user($uid, $course, $user_courses = array())
@@ -4851,7 +4865,7 @@ 
      * @param bool $deleteTeachersNotInList
      * @param bool $editTeacherInSessions
      * @param bool $deleteSessionTeacherNotInList
-     * @return bool
+     * @return false|null
      */
     public static function updateTeachers(
         $courseId,

main/inc/lib/course_category.lib.php

Doc Comments +4 added lines, -5 removed lines

@@ -111,7 +111,7 @@ 
  * @param string $canHaveCourses
  * @param int $parent_id
  *
- * @return bool
+ * @return false|string
  */
 function addNode($code, $name, $canHaveCourses, $parent_id)
 {
@@ -306,8 +306,7 @@ 
 /**
  * Counts the number of children categories a category has
  * @param int   $categoryId The ID of the category of which we want to count the children
- * @param int   $count  The number of subcategories we counted this far
- * @return mixed The number of subcategories this category has
+ * @return integer The number of subcategories this category has
  */
 function courseCategoryChildrenCount($categoryId)
 {
@@ -474,7 +473,7 @@ 
 /**
  * @param int $id
  *
- * @return bool
+ * @return false|null
  */
 function addToUrl($id)
 {
@@ -970,7 +969,7 @@ 
  * Get Pagination HTML div
  * @param $pageCurrent
  * @param $pageLength
- * @param $pageTotal
+ * @param integer $pageTotal
  * @return string
  */
 function getCataloguePagination($pageCurrent, $pageLength, $pageTotal)

main/inc/lib/course_description.lib.php

Doc Comments +6 added lines, -6 removed lines

@@ -95,7 +95,7 @@ 
      * Get all data by description and session id,
      * first you must set session_id property with the object CourseDescription
      * @param    int  $description_type Description type
-     * @param   string $course_code Course code (optional)
+     * @param   string $courseId Course code (optional)
      * @param    int $session_id Session id (optional)
      * @return array    List of fields from the descriptions found of the given type
      */
@@ -359,7 +359,7 @@ 
 
     /**
      * Get description titles by default
-     * @return array
+     * @return string[]
      */
     public function get_default_description_title()
     {
@@ -378,7 +378,7 @@ 
 
     /**
      * Get description titles editable by default
-     * @return array
+     * @return boolean[]
      */
     public function get_default_description_title_editable()
     {
@@ -397,7 +397,7 @@ 
 
     /**
      * Get description icons by default
-     * @return array
+     * @return string[]
      */
     public function get_default_description_icon()
     {
@@ -417,7 +417,7 @@ 
 
     /**
      * Get questions by default for help
-     * @return array
+     * @return string[]
      */
     public function get_default_question()
     {
@@ -436,7 +436,7 @@ 
 
     /**
      * Get informations by default for help
-     * @return array
+     * @return string[]
      */
     public function get_default_information()
     {

main/inc/lib/course_home.lib.php

Doc Comments +3 added lines, -2 removed lines

@@ -213,7 +213,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"
      */
@@ -650,7 +650,7 @@ 
      * @param array $all_tools_list List of tools as returned by get_tools_category()
      * @param bool  $rows
      *
-     * @return void
+     * @return string
      */
     public static function show_tools_category($all_tools_list, $rows = false)
     {
@@ -1194,6 +1194,7 @@ 
 
     /**
      * Show a toolbar with shortcuts to the course tool
+     * @param integer $orientation
      */
     public static function show_navigation_tool_shortcuts($orientation = SHORTCUTS_HORIZONTAL)
     {

main/inc/lib/course_request.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -18,7 +18,7 @@ 
     /**
      * Checks whether a given course code has been already occupied.
      * @param string $wanted_course_code    The code to be checked.
-     * @return string
+     * @return boolean
      * Returns TRUE if there is created:
      * - a course with the same code OR visual_code (visualcode).
      * - a course request with the same code as the given one, or
@@ -368,7 +368,7 @@ 
     }
 
     /**
-     * @param null $status
+     * @param integer $status
      * @return bool
      */
     public static function count_course_requests($status = null)
@@ -390,7 +390,7 @@ 
 
     /**
      * Gets all the information about a course request using its database id as an access key.
-     * @param int/string $id              The id (an integer number) of the corresponding database record.
+     * @param integer $id              The id (an integer number) of the corresponding database record.
      * @return array/bool                 Returns the requested data as an array or FALSE on failure.
      */
     public static function get_course_request_info($id)

main/inc/lib/dashboard.lib.php

Doc Comments +1 added lines

@@ -493,6 +493,7 @@
 	 * This function update extra user blocks data after closing a dashboard block
 	 * @param int 		User id
 	 * @param string	plugin path
+	 * @param integer $user_id
 	 * @return bool
 	 */
 	public static function close_user_block($user_id, $path)

main/inc/lib/database.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -66,7 +66,7 @@ 
      *
      * @param string $table
      *
-     * @return mixed
+     * @return string
      */
     public static function get_main_table($table)
     {
@@ -265,7 +265,7 @@ 
 
     /**
      * Frees all the memory associated with the provided result identifier.
-     * @return bool     Returns TRUE on success or FALSE on failure.
+     * @return boolean|null     Returns TRUE on success or FALSE on failure.
      * Notes: Use this method if you are concerned about how much memory is being used for queries that return large result sets.
      * Anyway, all associated result memory is automatically freed at the end of the script's execution.
      */
@@ -381,7 +381,7 @@ 
      * @param array     $attributes
      * @param bool      $show_query
      *
-     * @return bool|int
+     * @return false|string
      */
     public static function insert($table_name, $attributes, $show_query = false)
     {

main/inc/lib/diagnoser.lib.php

Doc Comments +6 added lines

@@ -351,6 +351,12 @@
 
     /**
      * Additional functions needed for fast integration
+     * @param integer $status
+     * @param string $section
+     * @param string $title
+     * @param string $url
+     * @param string|null $formatter
+     * @param string $comment
      */
     public function build_setting($status, $section, $title, $url, $current_value, $expected_value, $formatter, $comment, $img_path = null) {
         switch ($status) {

main/inc/lib/display.lib.php

Doc Comments +26 added lines, -15 removed lines

@@ -32,7 +32,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function toolList()
     {
@@ -290,7 +290,6 @@ 
      * 					'page_nr' = The page to display
      * 					'hide_navigation' =  true to hide the navigation
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $form actions Additional variables to add in the query-string
      * @param mixed An array with bool values to know which columns show.
      * i.e: $visibility_options= array(true, false) we will only show the first column
      * 				Can be also only a bool value. TRUE: show all columns, FALSE: show nothing
@@ -331,7 +330,6 @@ 
      * 					'page_nr' = The page to display
      * 					'hide_navigation' =  true to hide the navigation
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $form actions Additional variables to add in the query-string
      * @param mixed An array with bool values to know which columns show. i.e:
      *  $visibility_options= array(true, false) we will only show the first column
      * 	Can be also only a bool value. TRUE: show all columns, FALSE: show nothing
@@ -388,10 +386,11 @@ 
      * 					'per_page' = number of items to show per page
      * 					'page_nr' = The page to display
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $column_show Array of binaries 1= show columns 0. hide a column
+     * @param integer[] $column_show Array of binaries 1= show columns 0. hide a column
      * @param array $column_order An array of integers that let us decide how the columns are going to be sort.
      * 						      i.e:  $column_order=array('1''4','3','4'); The 2nd column will be order like the 4th column
      * @param array $form_actions Set optional forms actions
+     * @param string $table_name
      *
      * @author Julio Montoya
      */
@@ -444,7 +443,7 @@ 
      * @param bool	$filter (true) or not (false)
      * @param bool $returnValue
      *
-     * @return void
+     * @return string|null
      */
     public static function display_normal_message($message, $filter = true, $returnValue = false)
     {
@@ -474,7 +473,7 @@ 
     /**
      * Displays an confirmation message. Use this if something has been done successfully
      * @param bool	Filter (true) or not (false)
-     * @return void
+     * @return string|null
      */
     public static function display_confirmation_message ($message, $filter = true, $returnValue = false)
     {
@@ -491,7 +490,7 @@ 
      * @param string $message - include any additional html
      *                          tags if you need them
      * @param bool	Filter (true) or not (false)
-     * @return void
+     * @return string|null
      */
     public static function display_error_message ($message, $filter = true, $returnValue = false)
     {
@@ -681,6 +680,7 @@ 
      * @param string   The alt text (probably a language variable)
      * @param array    additional attributes (for instance height, width, onclick, ...)
      * @param integer  The wanted width of the icon (to be looked for in the corresponding img/icons/ folder)
+     * @param string $image
      * @return void
     */
     public static function display_icon(
@@ -881,6 +881,7 @@ 
     /**
      * Displays an HTML input tag
      *
+     * @param string $type
      */
     public static function input($type, $name, $value, $attributes = array())
     {
@@ -897,8 +898,8 @@ 
     }
 
     /**
-     * @param $name
-     * @param $value
+     * @param string $name
+     * @param string $value
      * @param array $attributes
      * @return string
      */
@@ -913,6 +914,7 @@ 
     /**
      * Displays an HTML select tag
      *
+     * @param string $blank_item_text
      */
     public static function select(
         $name,
@@ -983,6 +985,8 @@ 
      * @param   array   content that will be showed
      * @param   string  the id of the container of the tab in the example "tabs"
      * @param   array   attributes for the ul
+     * @param string[] $header_list
+     * @param string[] $content_list
      *
      */
     public static function tabs($header_list, $content_list, $id = 'tabs', $attributes = array(), $ul_attributes = array())
@@ -1029,7 +1033,7 @@ 
 
     /**
      * @param $headers
-     * @param null $selected
+     * @param integer $selected
      *
      * @return string
      */
@@ -1067,6 +1071,7 @@ 
      * As you can see both function use the same "my_grid_name" this is very important otherwise nothing will work
      *
      * @param   string  the div id, this value must be the same with the first parameter of Display::grid_js()
+     * @param string $div_id
      * @return  string  html
      *
      */
@@ -1622,6 +1627,8 @@ 
      * @param  string  url that will be added (for jquery see hot_courses.tpl)
 	 * @param	string	point info array see function CourseManager::get_course_ranking()
 	 * @param	bool	add a div wrapper
+	 * @param string $id
+	 * @param string $url
 	 * @todo	use     templates
      **/
     public static function return_rating_system($id, $url, $point_info = array(), $add_div_wrapper = true)
@@ -1717,6 +1724,9 @@ 
         return '<'.$size.'>'.Security::remove_XSS($title).'</'.$size.'>';
     }
 
+    /**
+     * @param string $title
+     */
     public static function page_subheader2($title, $second_title = null)
     {
         return self::page_header($title, $second_title, 'h4');
@@ -1947,6 +1957,7 @@ 
 
     /**
      * @todo use twig
+     * @param string $title
      */
     public static function group_button($title, $elements)
     {
@@ -2164,9 +2175,9 @@ 
 
     /**
      * @param int $id
-     * @param array $content
+     * @param string[] $content
      * @param int $col
-     * @param bool|true $right
+     * @param boolean $right
      * @return string
      */
     public static function toolbarAction($id, $content = array(), $col = 2, $right = true)
@@ -2248,10 +2259,10 @@ 
     /**
      * @param string $title
      * @param string $content
-     * @param null $id
+     * @param string $id
      * @param array $params
-     * @param null $idAccordion
-     * @param null $idCollapse
+     * @param string $idAccordion
+     * @param string $idCollapse
      * @param bool|true $open
      * @param bool|false $fullClickable
      * @return null|string