chamilo / chamilo-lms

main/inc/lib/extra_field.lib.php

Doc Comments +6 added lines, -6 removed lines

@@ -153,7 +153,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getValidExtraFieldTypes()
     {
@@ -238,7 +238,7 @@ 
 
     /**
      * @param array $conditions
-     * @param null $order_field_options_by
+     * @param string $order_field_options_by
      *
      * @return array
      */
@@ -400,7 +400,7 @@ 
     /**
      * @param string $handler
      *
-     * @return array
+     * @return string[]
      */
     public static function get_extra_fields_by_handler($handler)
     {
@@ -627,7 +627,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function get_field_types()
     {
@@ -637,7 +637,7 @@ 
     /**
      * @param int $id
      *
-     * @return null
+     * @return string|null
      */
     public function get_field_type_by_id($id)
     {
@@ -2044,7 +2044,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getJqgridColumnNames()
     {

main/inc/lib/sessionmanager.lib.php

Doc Comments +21 added lines, -17 removed lines

@@ -1770,7 +1770,7 @@ 
      * @param array $user_list
      * @param int $session_visibility
      * @param bool $empty_users
-     * @return bool
+     * @return false|null
      */
     public static function subscribe_users_to_session(
         $id_session,
@@ -2115,7 +2115,7 @@ 
      * @param array $courseInfo
      * @param int $status
      * @param bool $updateTotal
-     * @return bool
+     * @return false|null
      */
     public static function removeUsersFromCourseSession(
         $userList,
@@ -2181,7 +2181,7 @@ 
      * @param string $course_code
      * @param int $session_visibility
      * @param bool $removeUsersNotInList
-     * @return bool
+     * @return false|null
      */
     public static function subscribe_users_to_session_course(
         $user_list,
@@ -2364,7 +2364,7 @@ 
      * @param   bool $removeExistingCoursesWithUsers Whether to unsubscribe
      * existing courses and users (true, default) or not (false)
      * @param bool $copyEvaluation from base course to session course
-     * @return    void    Nothing, or false on error
+     * @return    false|null    Nothing, or false on error
      * */
     public static function add_courses_to_session(
         $sessionId,
@@ -2673,7 +2673,7 @@ 
      * @param int $fieldType Field's type
      * @param string $displayText Field's language var name
      * @param string $default Field's default value
-     * @return int     new extra field id
+     * @return boolean     new extra field id
      */
     public static function create_session_extra_field(
         $variable,
@@ -2767,7 +2767,7 @@ 
      * @param integer        year_end
      * @param integer        month_end
      * @param integer        day_end
-     * @return int session ID
+     * @return string|false session ID
      * */
     public static function create_category_session(
         $sname,
@@ -2843,7 +2843,7 @@ 
      * @param integer        year_end
      * @param integer        month_end
      * @param integer        day_end
-     * @return bool
+     * @return string|boolean
      * The parameter id is a primary key
      * */
     public static function edit_category_session(
@@ -2907,7 +2907,7 @@ 
      * @param	array	id_checked
      * @param	bool	include delete session
      * @param	bool	optional, true if the function is called by a webservice, false otherwise.
-     * @return	void	Nothing, or false on error
+     * @return	boolean	Nothing, or false on error
      * The parameters is a array to delete sessions
      * */
     public static function delete_session_category($id_checked, $delete_session = false, $from_ws = false)
@@ -3677,8 +3677,8 @@ 
     /**
      * Gets the list of courses by session filtered by access_url
      *
-     * @param $userId
-     * @param $sessionId
+     * @param integer $userId
+     * @param null|integer $sessionId
      * @param null $from
      * @param null $limit
      * @param null $column
@@ -3802,6 +3802,7 @@ 
     /**
      * Gets the count of courses by session filtered by access_url
      * @param int session id
+     * @param integer $session_id
      * @return array list of courses
      */
     public static function getCourseCountBySessionId($session_id, $keyword = null)
@@ -4056,6 +4057,7 @@ 
      * Updates a session status
      * @param	int 	session id
      * @param	int 	status
+     * @param integer $status
      */
     public static function set_session_status($session_id, $status)
     {
@@ -4248,6 +4250,7 @@ 
     /**
      * Get the number of sessions
      * @param  int ID of the URL we want to filter on (optional)
+     * @param integer $access_url_id
      * @return int Number of sessions
      */
     public static function count_sessions($access_url_id = null)
@@ -4268,7 +4271,7 @@ 
      * Protect a session to be edited.
      * @param int $id
      * @param bool $checkSession
-     * @return mixed | bool true if pass the check, api_not_allowed otherwise
+     * @return boolean|null | bool true if pass the check, api_not_allowed otherwise
      */
     public static function protectSession($id, $checkSession = true)
     {
@@ -4376,7 +4379,7 @@ 
 
     /**
      * @param $id
-     * @return bool
+     * @return null|boolean
      */
     public static function protect_teacher_session_edit($id)
     {
@@ -4453,7 +4456,7 @@ 
      *  true: if the session exists it will be updated.
      *  false: if session exists a new session will be created adding a counter session1, session2, etc
      * @param int $defaultUserId
-     * @param mixed $logger
+     * @param Logger $logger
      * @param array $extraFields convert a file row to an extra field. Example in CSV file there's a SessionID then it will
      * converted to extra_external_session_id if you set this: array('SessionId' => 'extra_external_session_id')
      * @param string $extraFieldId
@@ -5992,7 +5995,7 @@ 
     /**
      * Get the list of course tools that have to be dealt with in case of
      * registering any course to a session
-     * @return array The list of tools to be dealt with (literal names)
+     * @return string[] The list of tools to be dealt with (literal names)
      */
     public static function getCourseToolToBeManaged()
     {
@@ -6006,7 +6009,7 @@ 
      * Calls the methods bound to each tool when a course is registered into a session
      * @param int $sessionId
      * @param int $courseId
-     * @return void
+     * @return boolean|null
      */
     public static function installCourse($sessionId, $courseId)
     {
@@ -6664,6 +6667,7 @@ 
      * @param int $categoryId The internal ID of the session category
      * @param string $target Value to search for in the session field values
      * @param array $extraFields A list of fields to be scanned and returned
+     * @param DateTime $publicationDate
      * @return mixed
      */
     public static function getShortSessionListAndExtraByCategory(
@@ -8139,7 +8143,7 @@ 
     /**
      * Get link to the admin page for this session
      * @param   int $id Session ID
-     * @return mixed    URL to the admin page to manage the session, or false on error
+     * @return false|string    URL to the admin page to manage the session, or false on error
      */
     public static function getAdminPath($id)
     {
@@ -8156,7 +8160,7 @@ 
      * If a course is provided, build the link to the course
      * @param   int $id Session ID
      * @param   int $courseId Course ID (optional) in case the link has to send straight to the course
-     * @return mixed    URL to the page to use the session, or false on error
+     * @return false|string    URL to the page to use the session, or false on error
      */
     public static function getPath($id, $courseId = 0)
     {

main/inc/lib/document.lib.php

Doc Comments +23 added lines, -17 removed lines

@@ -275,7 +275,7 @@ 
     /**
      * @param string
      * @param string
-     * @return true if the user is allowed to see the document, false otherwise
+     * @return boolean if the user is allowed to see the document, false otherwise
      * @author Sergio A Kessler, first version
      * @author Roan Embrechts, bugfix
      * @todo not only check if a file is visible, but also check if the user is allowed to see the file??
@@ -1663,6 +1663,8 @@ 
      * @param   int
      * @param   int
      * @param bool
+     * @param integer $session_id
+     * @param integer $user_id
      * @return  bool
      */
     public static function is_visible_by_id(
@@ -2031,7 +2033,7 @@ 
      * Remove default certificate
      * @param string $course_id The course code
      * @param int $default_certificate_id The document id of the default certificate
-     * @return void
+     * @return false|null
      */
     public static function remove_attach_certificate($course_id, $default_certificate_id)
     {
@@ -2164,6 +2166,7 @@ 
      * @param    bool    is file or string html
      * @param    string    type (one of the app tools) - optional (otherwise takes the current item's type)
      * @param    int        level of recursivity we're in
+     * @param string $source_html
      * @return   array    List of file paths. An additional field containing 'local' or 'remote' helps determine
      * if the file should be copied into the zip or just linked
      */
@@ -3073,6 +3076,8 @@ 
 
     /**
      * Obtains the text inside the file with the right parser
+     * @param string $doc_path
+     * @param string $doc_mime
      */
     public static function get_text_content($doc_path, $doc_mime)
     {
@@ -3325,6 +3330,7 @@ 
      * Shows a play icon next to the document title in the document list
      * @param int
      * @param string
+     * @param integer|null $i
      * @return string	html content
      */
     public static function generate_media_preview($i, $type = 'simple')
@@ -4283,7 +4289,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_web_odf_extension_list()
     {
@@ -4292,10 +4298,10 @@ 
 
     /**
      * Set of extension allowed to use Jodconverter
-     * @param $mode 'from'
+     * @param string $mode 'from'
      *              'to'
      *              'all'
-     * @param $format   'text'
+     * @param string $format   'text'
      *                  'spreadsheet'
      *                  'presentation'
      *                  'drawing'
@@ -4499,7 +4505,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_system_folders()
     {
@@ -4517,7 +4523,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getProtectedFolderFromStudent()
     {
@@ -4673,7 +4679,7 @@ 
      * Requires the ffmpeg lib. In ubuntu: sudo apt-get install ffmpeg
      * @param string $wavFile
      * @param bool $removeWavFileIfSuccess
-     * @return bool
+     * @return string|false
      */
     public static function convertWavToMp3($wavFile, $removeWavFileIfSuccess = false)
     {
@@ -5254,6 +5260,8 @@ 
      * @param string    The current folder (path inside of the "document" directory, including the prefix "/")
      * @param string    Group directory, if empty, prevents documents to be uploaded (because group documents cannot be uploaded in root)
      * @param boolean    Whether to change the renderer (this will add a template <span> to the QuickForm object displaying the form)
+     * @param string $document_id
+     * @param FormValidator $form
      * @return string html form
      */
     public static function build_directory_selector(
@@ -5987,9 +5995,6 @@ 
     /**
      * Creates the row of edit icons for a file/folder
      *
-     * @param string $curdirpath current path (cfr open folder)
-     * @param string $type (file/folder)
-     * @param string $path dbase path of file/folder
      * @param int $visibility (1/0)
      * @param int $id dbase id of the document
      * @return string html img tags with hyperlinks
@@ -6211,7 +6216,7 @@ 
     /**
      * Gets the path translated with title of docs and folders
      * @param string $path the real path
-     * @return the path which should be displayed
+     * @return string path which should be displayed
      */
     public static function get_titles_of_path($path)
     {
@@ -6267,7 +6272,8 @@ 
 
     /**
      * Checks whether the user is in shared folder
-     * @return return bool Return true when user is into shared folder
+     * @param integer $current_session_id
+     * @return boolean bool Return true when user is into shared folder
      */
     public static function is_shared_folder($curdirpath, $current_session_id)
     {
@@ -6283,7 +6289,7 @@ 
 
     /**
      * Checks whether the user is into any user shared folder
-     * @return return bool Return true when user is in any user shared folder
+     * @return boolean bool Return true when user is in any user shared folder
      */
     public static function is_any_user_shared_folder($path, $current_session_id)
     {
@@ -6497,7 +6503,7 @@ 
      * @param int $id
      * @param array $courseInfo
      * @param int $sessionId
-     * @return bool
+     * @return boolean|null
      */
     public static function downloadDeletedDocument($id, $courseInfo, $sessionId)
     {
@@ -6516,7 +6522,7 @@ 
      * @param array $courseInfo
      * @param int $sessionId
      *
-     * @return bool
+     * @return false|null
      */
     public static function downloadAllDeletedDocument($courseInfo, $sessionId)
     {
@@ -6555,7 +6561,7 @@ 
      * @param array $courseInfo
      * @param int $sessionId
      *
-     * @return bool
+     * @return false|null
      */
     public static function deleteDocumentsFromSession($courseInfo, $sessionId)
     {

main/inc/lib/certificate.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -273,7 +273,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function notificationTags()
     {
@@ -297,7 +297,7 @@ 
      * @param array $courseInfo
      * @param array $certificateInfo
      *
-     * @return bool
+     * @return false|null
      */
     public static function sendNotification(
         $subject,
@@ -395,7 +395,7 @@ 
      * Generates a QR code for the certificate. The QR code embeds the text given
      * @param string $text Text to be added in the QR code
      * @param string $path file path of the image
-     * @return bool
+     * @return null|false
      **/
     public function generateQRImage($text, $path)
     {

main/inc/lib/display.lib.php

Doc Comments +23 added lines, -17 removed lines

@@ -33,7 +33,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function toolList()
     {
@@ -307,7 +307,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
@@ -348,7 +347,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
@@ -403,10 +401,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
      */
@@ -462,7 +461,7 @@ 
      * @deprecated Use <code>Display::addFlash(Display::return_message($message, 'normal'));</code>
      *  Or <code>echo Display::return_message($message, 'normal')</code>
      *
-     * @return void
+     * @return string|null
      */
     public static function display_normal_message(
         $message,
@@ -500,7 +499,7 @@ 
      * Displays an confirmation message. Use this if something has been done successfully
      * @param bool    Filter (true) or not (false)
      * @deprecated use Display::addFlash(Display::return_message($message, 'confirm'));
-     * @return void
+     * @return string|null
      */
     public static function display_confirmation_message(
         $message,
@@ -522,7 +521,7 @@ 
      * @param bool    Filter (true) or not (false)
      * @deprecated use Display::addFlash(Display::return_message($message, 'error'));
      *
-     * @return void
+     * @return string|null
      */
     public static function display_error_message(
         $message,
@@ -725,6 +724,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(
@@ -976,6 +976,7 @@ 
 
     /**
      * Displays an HTML input tag
+     * @param string $type
      */
     public static function input($type, $name, $value, $attributes = array())
     {
@@ -992,8 +993,8 @@ 
     }
 
     /**
-     * @param $name
-     * @param $value
+     * @param string $name
+     * @param string $value
      * @param array $attributes
      * @return string
      */
@@ -1008,6 +1009,7 @@ 
     /**
      * Displays an HTML select tag
      *
+     * @param string $blank_item_text
      */
     public static function select(
         $name,
@@ -1078,8 +1080,8 @@ 
                         $( "#tabs" ).tabs();
                     });
                 </script>
-     * @param   array   $headers list of the tab titles
-     * @param   array   $items
+     * @param   string[]   $headers list of the tab titles
+     * @param   string[]   $items
      * @param   string  $id id of the container of the tab in the example "tabs"
      * @param   array   $attributes for the ul
      * @param array $ul_attributes
@@ -1159,7 +1161,7 @@ 
 
     /**
      * @param $headers
-     * @param null $selected
+     * @param integer $selected
      *
      * @return string
      */
@@ -1202,6 +1204,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
      *
      */
@@ -1795,6 +1798,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');
@@ -2443,7 +2449,7 @@ 
 
     /**
      * @param string $id
-     * @param array $content
+     * @param string[] $content
      * @param array $colsWidth Optional. Columns width
      * @return string
      */
@@ -2484,7 +2490,7 @@ 
     /**
      * Get a HTML code for a icon by Font Awesome
      * @param string $name The icon name
-     * @param int|string $size Optional. The size for the icon. (Example: lg, 2, 3, 4, 5)
+     * @param integer $size Optional. The size for the icon. (Example: lg, 2, 3, 4, 5)
      * @param boolean $fixWidth Optional. Whether add the fw class
      * @param string $additionalClass Optional. Additional class
      *
@@ -2529,10 +2535,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

plugin/bbb/lib/bbb.lib.php

Doc Comments +5 added lines, -5 removed lines

@@ -401,7 +401,7 @@ 
      * Save a participant in a meeting room
      * @param int $meetingId
      * @param int $participantId
-     * @return false|int The last inserted ID. Otherwise return false
+     * @return false|string The last inserted ID. Otherwise return false
      */
     public function saveParticipant($meetingId, $participantId)
     {
@@ -478,7 +478,7 @@ 
     /**
      * Returns a meeting "join" URL
      * @param string The name of the meeting (usually the course code)
-     * @return mixed The URL to join the meeting, or false on error
+     * @return false|string The URL to join the meeting, or false on error
      * @todo implement moderator pass
      * @assert ('') === false
      * @assert ('abcdefghijklmnopqrstuvwxyzabcdefghijklmno') === false
@@ -872,7 +872,7 @@ 
      * @param string The internal ID of the meeting (id field for this meeting)
      * @param string $courseCode
      *
-     * @return void
+     * @return false|null
      * @assert (0) === false
      */
     public function endMeeting($id, $courseCode = null)
@@ -1358,7 +1358,7 @@ 
      * @param array $recordInfo
      * @param bool $isGlobal
      * @param bool $isAdminReport
-     * @return array
+     * @return string[]
      */
     private function getActionLinks($meetingInfo, $recordInfo, $isGlobal = false, $isAdminReport = false)
     {
@@ -1488,7 +1488,7 @@ 
 
     /**
      * @param array $userInfo
-     * @return bool
+     * @return boolean|null
      */
     public static function showGlobalConferenceLink($userInfo)
     {

main/inc/lib/chat.lib.php

Doc Comments +3 added lines

@@ -63,6 +63,9 @@
         );
     }
 
+    /**
+     * @param integer $latestMessages
+     */
     public function getLatestChat($currentUserId, $userId, $latestMessages)
     {
         $items = self::getPreviousMessages(

main/inc/lib/auth.lib.php

Doc Comments +7 added lines

@@ -172,6 +172,7 @@ 
      * (moving a course to a different course category)
      * @param  int    $courseId
      * @param  int       Category id
+     * @param integer $newcategory
      * @return bool      True if it success
      */
     public function updateCourseCategory($courseId, $newcategory)
@@ -204,6 +205,9 @@ 
      * @param   string    Direction (up/down)
      * @param   string    Course code
      * @param   int       Category id
+     * @param string $direction
+     * @param string $course2move
+     * @param integer $category
      * @return  bool      True if it success
      */
     public function move_course($direction, $course2move, $category)
@@ -325,6 +329,8 @@ 
      * Updates the user course category in the chamilo_user database
      * @param   string  Category title
      * @param   int     Category id
+     * @param string $title
+     * @param integer $category_id
      * @return  bool    True if it success
      */
     public function store_edit_course_category($title, $category_id)
@@ -517,6 +523,7 @@ 
     /**
      * stores the user course category in the chamilo_user database
      * @param   string  Category title
+     * @param string $category_title
      * @return  bool    True if it success
      */
     public function store_course_category($category_title)

main/inc/lib/course.lib.php

Doc Comments +3 added lines, -2 removed lines

@@ -784,7 +784,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,
@@ -1107,6 +1107,7 @@ 
      * @param  int $user_id
      * @param  string $course_code , if this parameter is null, it'll check for all courses
      * @param  bool $in_a_session True for checking inside sessions too, by default is not checked
+     * @param integer $session_id
      * @return bool   $session_id true if the user is registered in the course, false otherwise
      */
     public static function is_user_subscribed_in_course(
@@ -4657,6 +4658,7 @@ 
      * @param int   session id
      * @param id    url id
      * @param integer $session_id
+     * @param integer $url_id
      * @return array
      **/
     public static function update_course_ranking(
@@ -5918,7 +5920,6 @@ 
     /**
      * Shows the form for sending a message to a specific group or user.
      * @param FormValidator $form
-     * @param int $group_id id
      * @param array $to
      *
      * @return HTML_QuickForm_element