chamilo / chamilo-lms

main/inc/lib/add_many_session_to_category_functions.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
      * Search for a session based on a given search string
      * @param string A search string
      * @param string A search box type (single or anything else)
-     * @return string XajaxResponse
+     * @return xajaxResponse XajaxResponse
      * @assert () !== ''
      * @assert ('abc','single') !== ''
      */

main/inc/lib/AnnouncementEmail.php

Doc Comments +2 added lines, -2 removed lines

@@ -16,7 +16,7 @@ 
     /**
      *
      * @param int|array $course
-     * @param int|array $annoucement
+     * @param integer $announcement
      *
      * @return AnnouncementEmail
      */
@@ -50,7 +50,7 @@ 
      *
      * @param string $key
      *
-     * @return array
+     * @return string|null
      */
     public function course($key = '')
     {

main/inc/lib/AnnouncementManager.php

Doc Comments +9 added lines, -5 removed lines

@@ -18,7 +18,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_tags()
     {
@@ -40,7 +40,7 @@ 
      * @param string    $course_code
      * @param int       $session_id
      *
-     * @return mixed
+     * @return string
      */
     public static function parse_content($userId, $content, $course_code, $session_id = 0)
     {
@@ -349,7 +349,7 @@ 
      * @param array	    uploaded file $_FILES
      * @param string    Comment describing the attachment
      * @param bool  $sendToUsersInSession
-     * @return int      false on failure, ID of the announcement on success
+     * @return false|string      false on failure, ID of the announcement on success
      */
     public static function add_announcement(
         $emailTitle,
@@ -460,7 +460,7 @@ 
      * @param $to_users
      * @param array $file
      * @param string $file_comment
-     * @return bool|int
+     * @return false|string
      */
     public static function add_group_announcement(
         $emailTitle,
@@ -699,7 +699,7 @@ 
 
     /**
      * @param int $insert_id
-     * @return bool
+     * @return false|null
      */
     public static function update_mail_sent($insert_id)
     {
@@ -719,6 +719,7 @@ 
      * Gets all announcements from a user by course
      * @param	string course db
      * @param	int user id
+     * @param integer $user_id
      * @return	array html with the content and count of announcements or false otherwise
      */
     public static function get_all_annoucement_by_user_course($course_code, $user_id)
@@ -1184,6 +1185,7 @@ 
      * has been sent to
      * @param    string  The tool (announcement, agenda, ...)
      * @param    int     ID of the element of the corresponding type
+     * @param string $tool
      * @return   array   Array of users and groups to whom the element has been sent
      */
     public static function sent_to($tool, $id)
@@ -1308,6 +1310,8 @@ 
      * @param int attach id
      * @param array uploaded file $_FILES
      * @param string file comment
+     * @param integer $id_attach
+     * @param string $file_comment
      * @return int
      */
     public static function edit_announcement_attachment_file($id_attach, $file, $file_comment)

main/inc/lib/app_view.php

Doc Comments +3 added lines

@@ -18,6 +18,7 @@ 
     /**
      * Constructor, init tool path for rendering
      * @param string  tool name (optional)
+     * @param string $template_path
      */
     public function __construct($toolname = '', $template_path=null)
     {
@@ -50,6 +51,7 @@ 
     /**
      * Set layout view sent from a controller
      * @param string layout view
+     * @param string $layout
      */
     public function set_layout( $layout )
     {
@@ -59,6 +61,7 @@ 
     /**
      * Set template view sent from a controller
      * @param string template view
+     * @param string $template
      */
     public function set_template($template)
     {

main/inc/lib/banner.lib.php

Doc Comments +6 added lines

@@ -147,6 +147,9 @@ 
     return $customTabs;
 }
 
+/**
+ * @param string $theme
+ */
 function return_logo($theme)
 {
     $_course = api_get_course_info();
@@ -497,6 +500,9 @@ 
     return $menu;
 }
 
+/**
+ * @param string $nameTools
+ */
 function return_breadcrumb($interbreadcrumb, $language_file, $nameTools)
 {
     $session_id = api_get_session_id();

main/inc/lib/browser/Browser.php

Doc Comments +2 added lines, -2 removed lines

@@ -158,7 +158,7 @@ 
 
     /**
      * Set the name of the browser
-     * @param $browser string The name of the Browser
+     * @param string $browser string The name of the Browser
      */
     public function setBrowser($browser)
     {
@@ -266,7 +266,7 @@ 
 
     /**
      * Set the browser to be from AOL
-     * @param $isAol
+     * @param boolean $isAol
      */
     public function setAol($isAol)
     {

main/inc/lib/chat.lib.php

Doc Comments +2 added lines

@@ -41,6 +41,7 @@ 
     /**
     * Set user chat status
     * @param int 0 if disconnected, 1 if connected
+    * @param integer $status
      *
     * @return void
     */
@@ -164,6 +165,7 @@ 
     /**
      * Saves into session the fact that a chat window exists with the given user
      * @param int The ID of the user with whom the current user is chatting
+     * @param integer $user_id
      * @return void
      */
     public function save_window($user_id)

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)