chamilo / chamilo-lms

main/inc/lib/course_description.lib.php

Doc Comments +6 added lines, -6 removed lines

@@ -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()
     {
@@ -574,7 +574,7 @@ 
     /**
      * get progress of a description
      *
-     * @return int
+     * @return string
      */
     public function get_progress()
     {

app/SymfonyRequirements.php

Doc Comments +1 added lines, -1 removed lines

@@ -238,7 +238,7 @@
      * Adds an optional recommendation in form of a php.ini configuration.
      *
      * @param string        $cfgName           The configuration name used for ini_get()
-     * @param bool|callback $evaluation        Either a boolean indicating whether the configuration should evaluate to true or false,
+     * @param string|false $evaluation        Either a boolean indicating whether the configuration should evaluate to true or false,
      *                                         or a callback function receiving the configuration value as parameter to determine the fulfillment of the requirement
      * @param bool          $approveCfgAbsence If true the Requirement will be fulfilled even if the configuration option does not exist, i.e. ini_get() returns false.
      *                                         This is helpful for abandoned configs in later PHP versions or configs of an optional extension, like Suhosin.

main/inc/lib/groupmanager.lib.php

Doc Comments +12 added lines, -9 removed lines

@@ -371,7 +371,7 @@ 
      * @author Bart Mollet
      * @param  int  $groupId iid
      * @param string $course_code Default is current course
-     * @return integer              - number of groups deleted.
+     * @return boolean              - number of groups deleted.
      */
     public static function delete_groups($groupId, $course_code = null)
     {
@@ -563,7 +563,7 @@ 
      * @param bool      Whether self registration is allowed or not
      * @param bool      Whether self unregistration is allowed or not
      * @param int       $categoryId
-     * @return bool     TRUE if properties are successfully changed, false otherwise
+     * @return Statement|null     TRUE if properties are successfully changed, false otherwise
      */
     public static function set_group_properties(
         $group_id,
@@ -716,7 +716,7 @@ 
      * @param int $group_id The iid of the group
      * @param string $course_code The course in which the group is (default =
      * current course)
-     * @return array The category
+     * @return integer The category
      */
     public static function get_category_from_group($group_id, $course_code = null)
     {
@@ -782,9 +782,9 @@ 
      * Create group category
      * @param string $title The title of the new category
      * @param string $description The description of the new category
-     * @param bool $self_registration_allowed
-     * @param bool $self_unregistration_allowed
-     * @param int $max_number_of_students
+     * @param integer $self_registration_allowed
+     * @param integer $self_unregistration_allowed
+     * @param int $maximum_number_of_students
      * @param int $groups_per_user
      */
     public static function create_category(
@@ -990,6 +990,8 @@ 
      * @param int $limit
      * @param bool $getCount
      * @param int $courseId
+     * @param string $column
+     * @param string $direction
      * @return array list of user id
      */
     public static function get_users(
@@ -1583,7 +1585,7 @@ 
     /**
      * Subscribe tutor(s) to a specified group in current course
      * @param mixed $user_ids Can be an array with user-id's or a single user-id
-     * @param int $group_id iid
+     * @param int $groupId iid
      * @param int $course_id
      *
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
@@ -1614,7 +1616,7 @@ 
      * Unsubscribe user(s) from a specified group in current course
      * @param mixed $user_ids Can be an array with user-id's or a single user-id
      * @param int $group_id iid
-     * @return bool TRUE if successful
+     * @return boolean|null TRUE if successful
      */
     public static function unsubscribe_users($user_ids, $group_id)
     {
@@ -1633,7 +1635,7 @@ 
 
     /**
      * Unsubscribe all users from one or more groups
-     * @param int $group_id iid
+     * @param integer $groupId iid
      * @return bool TRUE if successful
      */
     public static function unsubscribe_all_users($groupId)
@@ -1781,6 +1783,7 @@ 
      *
      * @param $user_array_in list of users (must be sorted).
      * @param string $compare_field, the field to be compared
+     * @param string $compare_field
      */
     public static function filter_duplicates($user_array_in, $compare_field)
     {

main/inc/lib/events.lib.php

Doc Comments +20 added lines, -9 removed lines

@@ -239,7 +239,7 @@ 
     }
 
     /**
-     * @param doc_id id of document (id in mainDb.document table)
+     * @param doc_id string of document (id in mainDb.document table)
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
      * @desc Record information for upload event
      * used in the works tool to record informations when
@@ -313,6 +313,9 @@ 
      * @param   int     session_id
      * @param   int     learnpath_id (id of the learnpath)
      * @param   int     learnpath_item_id (id of the learnpath_item)
+     * @param integer $score
+     * @param integer $weighting
+     * @param integer $session_id
      *
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
      * @author Julio Montoya Armas <gugli100@gmail.com> Reworked 2010
@@ -414,7 +417,9 @@ 
      * @param	integer	Session ID (from the session table). Default value of null means "get from context".
      * @param	integer	Learnpath ID (from c_lp table). Default value of null means "get from context".
      * @param	integer	Learnpath item ID (from the c_lp_item table). Default value of null means "get from context".
-     * @return	boolean	Result of the insert query
+     * @param integer $exe_id
+     * @param integer $position
+     * @return	false|string	Result of the insert query
      */
     public static function saveQuestionAttempt(
         $score,
@@ -588,6 +593,8 @@ 
      * @param	int		Whether this answer is correct (1) or not (0)
      * @param	string	Coordinates of this point (e.g. 123;324)
      * @param	bool update results?
+     * @param integer $exe_id
+     * @param integer $correct
      * @return	boolean	Result of the insert query
      * @uses Course code and user_id from global scope $_cid and $_user
      */
@@ -800,11 +807,11 @@ 
     /**
      * Save the new message for one event and for one language
      *
-     * @param string $eventName
+     * @param string $event_name
      * @param array $users
      * @param string $message
      * @param string $subject
-     * @param string $eventMessageLanguage
+     * @param string $event_message_language
      * @param int $activated
      */
     public static function save_event_type_message($event_name, $users, $message, $subject, $event_message_language, $activated)
@@ -938,10 +945,10 @@ 
     }
 
     /**
-     * @param $user_id
+     * @param integer $user_id
      * @param $exerciseId
-     * @param $lp_id
-     * @param $lp_item_id
+     * @param integer $lp_id
+     * @param integer $lp_item_id
      * @return int
      */
     public static function get_attempt_count_not_finished($user_id, $exerciseId, $lp_id, $lp_item_id)
@@ -1118,6 +1125,7 @@ 
      * @param   int     exercise id
      * @param   int $courseId
      * @param   int     session id
+     * @param integer $user_id
      * @return  array   with the results
      *
      */
@@ -1213,6 +1221,7 @@ 
      * @param   int     exercise id
      * @param   int  $courseId
      * @param   int     session id
+     * @param integer $user_id
      * @return  array   with the results
      *
      */
@@ -1301,6 +1310,8 @@ 
      * @param   int     lp id
      * @param   int     lp item id
      * @param   string 	order asc or desc
+     * @param integer $courseId
+     * @param string $order
      * @return  array   with the results
      *
      */
@@ -1367,7 +1378,7 @@ 
      * @param   int     exercise id
      * @param   int     $courseId
      * @param   int     session id
-     * @return  array   with the results
+     * @return  string   with the results
      *
      */
     public static function count_exercise_attempts_by_user($user_id, $exercise_id, $courseId, $session_id = 0)
@@ -1538,7 +1549,7 @@ 
      * @param   int     exercise id
      * @param   int   course id
      * @param   int     session id
-     * @return  array   with the results
+     * @return  integer   with the results
      *
      */
     public static function get_count_exercises_attempted_by_course($courseId, $session_id = 0)

main/inc/lib/dashboard.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -498,7 +498,7 @@
 	 * @param int 		User id
 	 * @param string	plugin path
 	 * @param integer $user_id
-	 * @return bool
+	 * @return false|string
 	 */
 	public static function close_user_block($user_id, $path)
     {

main/inc/lib/course_request.lib.php

Doc Comments +2 added lines, -1 removed lines

@@ -51,7 +51,8 @@
      * @param string $objetives
      * @param string $target_audience
      * @param int $user_id
-     * @return mixed The database id of the newly created course request or FALSE on failure.
+     * @param boolean $exemplary_content
+     * @return false|string The database id of the newly created course request or FALSE on failure.
      */
     public static function create_course_request(
         $wanted_code,

main/gradebook/lib/user_data_generator.class.php

Doc Comments +4 added lines, -4 removed lines

@@ -285,7 +285,7 @@ 
 
     /**
      * @param $item
-     * @param $ignore_score_color
+     * @param boolean $ignore_score_color
      * @return string
      */
     private function build_average_column($item, $ignore_score_color)
@@ -306,7 +306,7 @@ 
 
     /**
      * @param $item
-     * @param $ignore_score_color
+     * @param boolean $ignore_score_color
      * @return string
      */
     private function build_result_column($item, $ignore_score_color)
@@ -323,7 +323,7 @@ 
 
     /**
      * @param $item
-     * @param $ignore_score_color
+     * @param boolean $ignore_score_color
      * @return string
      */
     private function build_mask_column($item, $ignore_score_color)
@@ -339,7 +339,7 @@ 
 
     /**
      * @param $coursecode
-     * @return mixed
+     * @return string
      */
     private function get_course_name_from_code_cached($coursecode)
     {

main/inc/lib/document.lib.php

Doc Comments +22 added lines, -18 removed lines

@@ -277,7 +277,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??
@@ -1558,7 +1558,7 @@ 
      * Return true if the documentpath have visibility=1 as
      * item_property (you should use the is_visible_by_id)
      *
-     * @param string $document_path the relative complete path of the document
+     * @param string $doc_path the relative complete path of the document
      * @param array  $course the _course array info of the document's course
      * @param int
      * @param string
@@ -1644,6 +1644,7 @@ 
      * @param   int
      * @param   int
      * @param bool
+     * @param integer $user_id
      * @return  bool
      */
     public static function is_visible_by_id(
@@ -1995,7 +1996,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)
     {
@@ -2128,6 +2129,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
      */
@@ -2970,6 +2972,7 @@ 
 
     /**
      * Obtains the text inside the file with the right parser
+     * @param string $doc_path
      */
     public static function get_text_content($doc_path, $doc_mime)
     {
@@ -3221,6 +3224,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')
@@ -4122,7 +4126,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_web_odf_extension_list()
     {
@@ -4131,10 +4135,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'
@@ -4338,7 +4342,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_system_folders()
     {
@@ -4356,7 +4360,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getProtectedFolderFromStudent()
     {
@@ -4512,7 +4516,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)
     {
@@ -5088,6 +5092,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
      */
@@ -5596,9 +5602,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
@@ -5947,7 +5950,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)
     {
@@ -6003,7 +6006,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)
     {
@@ -6019,7 +6023,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)
     {
@@ -6233,7 +6237,7 @@ 
      * @param int $id
      * @param array $courseInfo
      * @param int $sessionId
-     * @return bool
+     * @return boolean|null
      */
     public static function downloadDeletedDocument($id, $courseInfo, $sessionId)
     {
@@ -6252,7 +6256,7 @@ 
      * @param array $courseInfo
      * @param int $sessionId
      *
-     * @return bool
+     * @return false|null
      */
     public static function downloadAllDeletedDocument($courseInfo, $sessionId)
     {
@@ -6291,7 +6295,7 @@ 
      * @param array $courseInfo
      * @param int $sessionId
      *
-     * @return bool
+     * @return false|null
      */
     public static function deleteDocumentsFromSession($courseInfo, $sessionId)
     {

main/gradebook/lib/be/category.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -749,7 +749,7 @@ 
 
     /**
      * @param int $course_id
-     * @return bool|string
+     * @return string|false
      */
     public function show_message_resource_delete($course_id)
     {
@@ -1554,7 +1554,7 @@ 
      * Retrieve all categories inside a course independent category
      * that should be visible to a student.
      * @param integer $cat_id parent category
-     * @param $stud_id student id
+     * @param integer $stud_id student id
      * @param $cats optional: if defined, the categories will be added to this array
      */
     public function get_independent_categories_with_result_for_student($cat_id, $stud_id, $cats = array())