Completed
Push — 1.11.x ( 04eda1...44c218 )
by José
105:08 queued 67:27
created
main/inc/lib/usermanager.lib.php 1 patch
Doc Comments   +29 added lines, -15 removed lines patch added patch discarded remove patch
@@ -138,7 +138,7 @@  discard block
 block discarded – undo
138 138
     /**
139 139
      * Validates the password
140 140
      *
141
-     * @param $encoded
141
+     * @param string $encoded
142 142
      * @param $raw
143 143
      * @param $salt
144 144
      * @return bool
@@ -155,7 +155,7 @@  discard block
 block discarded – undo
155 155
      * @param string $raw
156 156
      * @param User   $user
157 157
      *
158
-     * @return bool
158
+     * @return string
159 159
      */
160 160
     public static function encryptPassword($raw, User $user)
161 161
     {
@@ -1003,6 +1003,7 @@  discard block
 block discarded – undo
1003 1003
      * Disables or enables a user
1004 1004
      * @param int user_id
1005 1005
      * @param int Enable or disable
1006
+     * @param integer $active
1006 1007
      * @return void
1007 1008
      * @assert (-1,0) === false
1008 1009
      * @assert (1,1) === true
@@ -1033,6 +1034,7 @@  discard block
 block discarded – undo
1033 1034
     /**
1034 1035
      * Disables a user
1035 1036
      * @param int User id
1037
+     * @param integer $user_id
1036 1038
      * @return bool
1037 1039
      * @uses UserManager::change_active_state() to actually disable the user
1038 1040
      * @assert (0) === false
@@ -1049,6 +1051,7 @@  discard block
 block discarded – undo
1049 1051
     /**
1050 1052
      * Enable a user
1051 1053
      * @param int User id
1054
+     * @param integer $user_id
1052 1055
      * @return bool
1053 1056
      * @uses UserManager::change_active_state() to actually disable the user
1054 1057
      * @assert (0) === false
@@ -1213,6 +1216,7 @@  discard block
 block discarded – undo
1213 1216
      * Checks whether the user id exists in the database
1214 1217
      *
1215 1218
      * @param int User id
1219
+     * @param integer $userId
1216 1220
      * @return bool True if user id was found, false otherwise
1217 1221
      */
1218 1222
     public static function is_user_id_valid($userId)
@@ -1410,7 +1414,7 @@  discard block
 block discarded – undo
1410 1414
      * @param   array $userInfo user information to avoid query the DB
1411 1415
      * returns the /main/img/unknown.jpg image set it at true
1412 1416
      *
1413
-     * @return    array     Array of 2 elements: 'dir' and 'file' which contain
1417
+     * @return    integer     Array of 2 elements: 'dir' and 'file' which contain
1414 1418
      * the dir and file as the name implies if image does not exist it will
1415 1419
      * return the unknow image if anonymous parameter is true if not it returns an empty array
1416 1420
      */
@@ -1778,7 +1782,7 @@  discard block
 block discarded – undo
1778 1782
      * @param    int $user_id    User id
1779 1783
      * @param    $force    Optional parameter to force building after a removal request
1780 1784
      *
1781
-     * @return    A string containing the XHTML code to dipslay the production list, or FALSE
1785
+     * @return    boolean|string string containing the XHTML code to dipslay the production list, or FALSE
1782 1786
      */
1783 1787
     public static function build_production_list($user_id, $force = false, $showdelete = false)
1784 1788
     {
@@ -1814,7 +1818,7 @@  discard block
 block discarded – undo
1814 1818
     /**
1815 1819
      * Returns an array with the user's productions.
1816 1820
      *
1817
-     * @param    $user_id    User id
1821
+     * @param    integer $user_id    User id
1818 1822
      * @return   array  An array containing the user's productions
1819 1823
      */
1820 1824
     public static function get_user_productions($user_id)
@@ -1969,7 +1973,7 @@  discard block
 block discarded – undo
1969 1973
 
1970 1974
     /**
1971 1975
      * Build a list of extra file already uploaded in $user_folder/{$extra_field}/
1972
-     * @param $user_id
1976
+     * @param integer $user_id
1973 1977
      * @param $extra_field
1974 1978
      * @param bool $force
1975 1979
      * @param bool $showdelete
@@ -2074,7 +2078,7 @@  discard block
 block discarded – undo
2074 2078
      * @param    int       $fieldType  Field's type
2075 2079
      * @param    string    $displayText Field's language var name
2076 2080
      * @param    string    $default Field's default value
2077
-     * @return int
2081
+     * @return boolean
2078 2082
      */
2079 2083
     public static function create_extra_field($variable, $fieldType, $displayText, $default)
2080 2084
     {
@@ -2108,6 +2112,7 @@  discard block
 block discarded – undo
2108 2112
      * @param    boolean    Whether to prefix the fields indexes with "extra_" (might be used by formvalidator)
2109 2113
      * @param    boolean    Whether to return invisible fields as well
2110 2114
      * @param    boolean    Whether to split multiple-selection fields or not
2115
+     * @param boolean $field_filter
2111 2116
      * @return    array    Array of fields => value for the given user
2112 2117
      */
2113 2118
     public static function get_extra_user_data(
@@ -2350,6 +2355,7 @@  discard block
 block discarded – undo
2350 2355
     /**
2351 2356
      * Get extra user data by field variable
2352 2357
      * @param string    field variable
2358
+     * @param string $field_variable
2353 2359
      * @return array    data
2354 2360
      */
2355 2361
     public static function get_extra_user_data_by_field_variable($field_variable)
@@ -2899,7 +2905,7 @@  discard block
 block discarded – undo
2899 2905
      * @param    string    User ID
2900 2906
      * @param   string  course directory
2901 2907
      * @param   string  resourcetype: images, all
2902
-     * @return    int        User ID (or false if not found)
2908
+     * @return    string        User ID (or false if not found)
2903 2909
      */
2904 2910
     public static function get_user_upload_files_by_course($user_id, $course, $resourcetype = 'all')
2905 2911
     {
@@ -2979,7 +2985,7 @@  discard block
 block discarded – undo
2979 2985
     /**
2980 2986
      * Adds a new API key to the users' account
2981 2987
      * @param   int     Optional user ID (defaults to the results of api_get_user_id())
2982
-     * @return  boolean True on success, false on failure
2988
+     * @return  false|string True on success, false on failure
2983 2989
      */
2984 2990
     public static function add_api_key($user_id = null, $api_service = 'dokeos')
2985 2991
     {
@@ -3034,6 +3040,7 @@  discard block
 block discarded – undo
3034 3040
      * Regenerate an API key from the user's account
3035 3041
      * @param   int     user ID (defaults to the results of api_get_user_id())
3036 3042
      * @param   string  API key's internal ID
3043
+     * @param string $api_service
3037 3044
      * @return  int        num
3038 3045
      */
3039 3046
     public static function update_api_key($user_id, $api_service)
@@ -3063,6 +3070,7 @@  discard block
 block discarded – undo
3063 3070
     /**
3064 3071
      * @param   int     user ID (defaults to the results of api_get_user_id())
3065 3072
      * @param   string    API key's internal ID
3073
+     * @param string $api_service
3066 3074
      * @return  int    row ID, or return false if not found
3067 3075
      */
3068 3076
     public static function get_api_key_id($user_id, $api_service)
@@ -3277,7 +3285,7 @@  discard block
 block discarded – undo
3277 3285
      * @param int $field_id
3278 3286
      * @param bool $show_links show links or not
3279 3287
      *
3280
-     * @return array
3288
+     * @return string
3281 3289
      */
3282 3290
     public static function get_user_tags_to_string($user_id, $field_id, $show_links = true)
3283 3291
     {
@@ -3374,7 +3382,7 @@  discard block
 block discarded – undo
3374 3382
      * @param mixed $tag
3375 3383
      * @param int $user_id
3376 3384
      * @param int $field_id field id of the tag
3377
-     * @return bool
3385
+     * @return boolean|null
3378 3386
      */
3379 3387
     public static function add_tag($tag, $user_id, $field_id)
3380 3388
     {
@@ -4190,7 +4198,7 @@  discard block
 block discarded – undo
4190 4198
      * Add subscribed users to a user by relation type
4191 4199
      * @param int $userId The user id
4192 4200
      * @param array $subscribedUsersId The id of suscribed users
4193
-     * @param action $relationType The relation type
4201
+     * @param integer $relationType The relation type
4194 4202
      */
4195 4203
     public static function subscribeUsersToUser($userId, $subscribedUsersId, $relationType, $deleteUsersBeforeInsert = false)
4196 4204
     {
@@ -4255,6 +4263,8 @@  discard block
 block discarded – undo
4255 4263
      * This function check if an user is followed by human resources manager
4256 4264
      * @param     int     User id
4257 4265
      * @param    int        Human resources manager
4266
+     * @param integer $user_id
4267
+     * @param integer $hr_dept_id
4258 4268
      * @return    bool
4259 4269
      */
4260 4270
     public static function is_user_followed_by_drh($user_id, $hr_dept_id)
@@ -4327,6 +4337,8 @@  discard block
 block discarded – undo
4327 4337
      * Determines if a user is a gradebook certified
4328 4338
      * @param int The category id of gradebook
4329 4339
      * @param int The user id
4340
+     * @param integer $cat_id
4341
+     * @param integer $user_id
4330 4342
      * @return boolean
4331 4343
      */
4332 4344
     public static function is_user_certified($cat_id, $user_id)
@@ -4349,6 +4361,8 @@  discard block
 block discarded – undo
4349 4361
      * Gets the info about a gradebook certificate for a user by course
4350 4362
      * @param string The course code
4351 4363
      * @param int The user id
4364
+     * @param integer $course_code
4365
+     * @param integer $user_id
4352 4366
      * @return array  if there is not information return false
4353 4367
      */
4354 4368
     public static function get_info_gradebook_certificate($course_code, $user_id)
@@ -4812,7 +4826,7 @@  discard block
 block discarded – undo
4812 4826
     }
4813 4827
 
4814 4828
     /**
4815
-     * @return array
4829
+     * @return string[]
4816 4830
      */
4817 4831
     static function get_user_field_types()
4818 4832
     {
@@ -5105,7 +5119,7 @@  discard block
 block discarded – undo
5105 5119
 
5106 5120
     /**
5107 5121
      * Get the boss user ID from a followed user id
5108
-     * @param $userId
5122
+     * @param integer $userId
5109 5123
      * @return bool
5110 5124
      */
5111 5125
     public static function getStudentBossList($userId)
@@ -5157,7 +5171,7 @@  discard block
 block discarded – undo
5157 5171
      * Get either a Gravatar URL or complete image tag for a specified email address.
5158 5172
      *
5159 5173
      * @param string $email The email address
5160
-     * @param string $s Size in pixels, defaults to 80px [ 1 - 2048 ]
5174
+     * @param integer $s Size in pixels, defaults to 80px [ 1 - 2048 ]
5161 5175
      * @param string $d Default imageset to use [ 404 | mm | identicon | monsterid | wavatar ]
5162 5176
      * @param string $r Maximum rating (inclusive) [ g | pg | r | x ]
5163 5177
      * @param boole $img True to return a complete IMG tag False for just the URL
Please login to merge, or discard this patch.
main/inc/lib/TicketManager.php 1 patch
Doc Comments   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -254,7 +254,7 @@  discard block
 block discarded – undo
254 254
      * @param $category_id
255 255
      * @param $course_id
256 256
      * @param $project_id
257
-     * @param $other_area
257
+     * @param integer $other_area
258 258
      * @param $email
259 259
      * @param $subject
260 260
      * @param $content
@@ -635,10 +635,10 @@  discard block
 block discarded – undo
635 635
     /**
636 636
      * Insert message between Users and Admins
637 637
      * @param $ticket_id
638
-     * @param $subject
639
-     * @param $content
638
+     * @param string $subject
639
+     * @param string $content
640 640
      * @param $file_attachments
641
-     * @param $user_id
641
+     * @param integer $user_id
642 642
      * @param string $status
643 643
      * @param bool $sendConfirmation
644 644
      * @return bool
@@ -737,9 +737,9 @@  discard block
 block discarded – undo
737 737
     /**
738 738
      * Attachment files when a message is sent
739 739
      * @param $file_attach
740
-     * @param $ticket_id
741
-     * @param $message_id
742
-     * @param $message_attch_id
740
+     * @param integer $ticket_id
741
+     * @param integer $message_id
742
+     * @param integer $message_attch_id
743 743
      * @return array
744 744
      */
745 745
     public static function save_message_attachment_file(
@@ -2002,7 +2002,7 @@  discard block
 block discarded – undo
2002 2002
     }
2003 2003
 
2004 2004
     /**
2005
-     * @param $id
2005
+     * @param integer $id
2006 2006
      * @return Project
2007 2007
      */
2008 2008
     public static function getProject($id)
Please login to merge, or discard this patch.
main/inc/lib/thematic.lib.php 1 patch
Doc Comments   +10 added lines, -4 removed lines patch added patch discarded remove patch
@@ -242,6 +242,8 @@  discard block
 block discarded – undo
242 242
     /**
243 243
      * get thematic list
244 244
      * @param	int		Thematic id (optional), get list by id
245
+     * @param integer $thematic_id
246
+     * @param integer $session_id
245 247
      * @return	array	Thematic data
246 248
      */
247 249
     public static function get_thematic_list(
@@ -798,6 +800,7 @@  discard block
 block discarded – undo
798 800
     /**
799 801
      * delete  thematic advance
800 802
      * @param	int		Thematic advance id
803
+     * @param integer $thematic_advance_id
801 804
      * @return	int		Affected rows
802 805
      */
803 806
     public function thematic_advance_destroy($thematic_advance_id)
@@ -1114,6 +1117,7 @@  discard block
 block discarded – undo
1114 1117
     /**
1115 1118
      * update done thematic advances from thematic details interface
1116 1119
      * @param 	int		Thematic id
1120
+     * @param integer $thematic_advance_id
1117 1121
      * @return	int		Affected rows
1118 1122
      */
1119 1123
     public function update_done_thematic_advances($thematic_advance_id)
@@ -1296,6 +1300,7 @@  discard block
 block discarded – undo
1296 1300
      * Get total average of thematic advances
1297 1301
      * @param	string	Course code (optional)
1298 1302
      * @param	int		Session id	(optional)
1303
+     * @param integer $session_id
1299 1304
      * @return 	float	Average of thematic advances
1300 1305
      */
1301 1306
     public function get_total_average_of_thematic_advances($course_code = null, $session_id = null)
@@ -1403,6 +1408,7 @@  discard block
 block discarded – undo
1403 1408
      * @param	string	Content
1404 1409
      * @param	string	Date and time
1405 1410
      * @param	int		Duration in hours
1411
+     * @param integer $id
1406 1412
      * @return void
1407 1413
      */
1408 1414
     public function set_thematic_advance_attributes(
@@ -1433,7 +1439,7 @@  discard block
 block discarded – undo
1433 1439
 
1434 1440
     /**
1435 1441
      * get thematic id
1436
-     * @return void
1442
+     * @return integer
1437 1443
      */
1438 1444
     public function get_thematic_id()
1439 1445
     {
@@ -1442,7 +1448,7 @@  discard block
 block discarded – undo
1442 1448
 
1443 1449
     /**
1444 1450
      * Get thematic plan titles by default
1445
-     * @return array
1451
+     * @return string[]
1446 1452
      */
1447 1453
     public function get_default_thematic_plan_title()
1448 1454
     {
@@ -1459,7 +1465,7 @@  discard block
 block discarded – undo
1459 1465
 
1460 1466
     /**
1461 1467
      * Get thematic plan icons by default
1462
-     * @return array
1468
+     * @return string[]
1463 1469
      */
1464 1470
     public function get_default_thematic_plan_icon()
1465 1471
     {
@@ -1476,7 +1482,7 @@  discard block
 block discarded – undo
1476 1482
 
1477 1483
     /**
1478 1484
      * Get questions by default for help
1479
-     * @return array
1485
+     * @return string[]
1480 1486
      */
1481 1487
     public function get_default_question()
1482 1488
     {
Please login to merge, or discard this patch.
main/inc/lib/extra_field.lib.php 1 patch
Doc Comments   +7 added lines, -7 removed lines patch added patch discarded remove patch
@@ -140,7 +140,7 @@  discard block
 block discarded – undo
140 140
     }
141 141
 
142 142
     /**
143
-     * @return array
143
+     * @return string[]
144 144
      */
145 145
     public static function getValidExtraFieldTypes()
146 146
     {
@@ -217,7 +217,7 @@  discard block
 block discarded – undo
217 217
 
218 218
     /**
219 219
      * @param array $conditions
220
-     * @param null  $order_field_options_by
220
+     * @param string  $order_field_options_by
221 221
      *
222 222
      * @return array
223 223
      */
@@ -375,7 +375,7 @@  discard block
 block discarded – undo
375 375
     /**
376 376
      * @param string $handler
377 377
      *
378
-     * @return array
378
+     * @return string[]
379 379
      */
380 380
     public static function get_extra_fields_by_handler($handler)
381 381
     {
@@ -574,7 +574,7 @@  discard block
 block discarded – undo
574 574
     }
575 575
 
576 576
     /**
577
-     * @return array
577
+     * @return string[]
578 578
      */
579 579
     public function get_field_types()
580 580
     {
@@ -584,7 +584,7 @@  discard block
 block discarded – undo
584 584
     /**
585 585
      * @param int $id
586 586
      *
587
-     * @return null
587
+     * @return string|null
588 588
      */
589 589
     public function get_field_type_by_id($id)
590 590
     {
@@ -1826,7 +1826,7 @@  discard block
 block discarded – undo
1826 1826
     }
1827 1827
 
1828 1828
     /**
1829
-     * @return array
1829
+     * @return string[]
1830 1830
      */
1831 1831
     public function getJqgridColumnNames()
1832 1832
     {
@@ -2086,7 +2086,7 @@  discard block
 block discarded – undo
2086 2086
     }
2087 2087
 
2088 2088
     /**
2089
-     * @param array $columns
2089
+     * @param string[] $columns
2090 2090
      * @param array  $column_model
2091 2091
      * @param array  $extraFields
2092 2092
      * @return array
Please login to merge, or discard this patch.
main/inc/lib/course.lib.php 1 patch
Doc Comments   +5 added lines, -3 removed lines patch added patch discarded remove patch
@@ -785,7 +785,7 @@  discard block
 block discarded – undo
785 785
      * @param  string $courseCode the course code
786 786
      * @param  int $visible (optional) The course visibility in the catalogue to the user (1=visible, 0=invisible)
787 787
      *
788
-     * @return boolean true if added succesfully, false otherwise.
788
+     * @return boolean|string true if added succesfully, false otherwise.
789 789
      */
790 790
     public static function addUserVisibilityToCourseInCatalogue($userId, $courseCode, $visible = 1)
791 791
     {
@@ -2374,7 +2374,7 @@  discard block
 block discarded – undo
2374 2374
 
2375 2375
     /**
2376 2376
      * Creates a file called mysql_dump.sql in the course folder
2377
-     * @param $course_code The code of the course
2377
+     * @param string $course_code The code of the course
2378 2378
      * @todo Implementation for single database
2379 2379
      */
2380 2380
     public static function create_database_dump($course_code)
@@ -3174,6 +3174,7 @@  discard block
 block discarded – undo
3174 3174
      * @param int $limit
3175 3175
      * @param string $column
3176 3176
      * @param string $direction
3177
+     * @param integer $status
3177 3178
      * @return array    courses
3178 3179
      */
3179 3180
     public static function get_courses_followed_by_drh(
@@ -3777,6 +3778,7 @@  discard block
 block discarded – undo
3777 3778
      *  class userportal-course-item.
3778 3779
      * @param int      User category id
3779 3780
      * @param bool      Whether to show the document quick-loader or not
3781
+     * @param integer $user_category_id
3780 3782
      * @return string
3781 3783
      */
3782 3784
     public static function returnCoursesWithoutCategories($user_category_id, $load_dirs = false)
@@ -4979,7 +4981,7 @@  discard block
 block discarded – undo
4979 4981
     /**
4980 4982
      * Returns the SQL conditions to filter course only visible by the user in the catalogue
4981 4983
      *
4982
-     * @param $courseTableAlias Alias of the course table
4984
+     * @param string $courseTableAlias Alias of the course table
4983 4985
      * @return string SQL conditions
4984 4986
      */
4985 4987
     public static function getCourseVisibilitySQLCondition($courseTableAlias) {
Please login to merge, or discard this patch.
app/check.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -96,6 +96,9 @@
 block discarded – undo
96 96
     echo PHP_EOL;
97 97
 }
98 98
 
99
+/**
100
+ * @param string $message
101
+ */
99 102
 function echo_style($style, $message)
100 103
 {
101 104
     // ANSI color codes
Please login to merge, or discard this patch.
main/inc/lib/sessionmanager.lib.php 1 patch
Doc Comments   +25 added lines, -18 removed lines patch added patch discarded remove patch
@@ -1336,7 +1336,7 @@  discard block
 block discarded – undo
1336 1336
      * @param string    $description
1337 1337
      * @param int       $showDescription
1338 1338
      * @param int       $duration
1339
-     * @param array     $extraFields
1339
+     * @param boolean|null     $extraFields
1340 1340
      * @param int       $sessionAdminId
1341 1341
      * @param boolean $sendSubscriptionNotification Optional.
1342 1342
      *          Whether send a mail notification to users being subscribed
@@ -1565,7 +1565,7 @@  discard block
 block discarded – undo
1565 1565
      * @param array $user_list
1566 1566
      * @param int $session_visibility
1567 1567
      * @param bool $empty_users
1568
-     * @return bool
1568
+     * @return false|null
1569 1569
      */
1570 1570
     public static function suscribe_users_to_session(
1571 1571
         $id_session,
@@ -1837,7 +1837,7 @@  discard block
 block discarded – undo
1837 1837
      * @param array $courseInfo
1838 1838
      * @param int $status
1839 1839
      * @param bool $updateTotal
1840
-     * @return bool
1840
+     * @return false|null
1841 1841
      */
1842 1842
     public static function removeUsersFromCourseSession(
1843 1843
         $userList,
@@ -1903,7 +1903,7 @@  discard block
 block discarded – undo
1903 1903
      * @param string $course_code
1904 1904
      * @param int $session_visibility
1905 1905
      * @param bool $removeUsersNotInList
1906
-     * @return bool
1906
+     * @return false|null
1907 1907
      */
1908 1908
     public static function subscribe_users_to_session_course(
1909 1909
         $user_list,
@@ -2086,7 +2086,7 @@  discard block
 block discarded – undo
2086 2086
      * @param	bool	$removeExistingCoursesWithUsers Whether to unsubscribe
2087 2087
      * existing courses and users (true, default) or not (false)
2088 2088
      * @param $copyEvaluation from base course to session course
2089
-     * @return	void	Nothing, or false on error
2089
+     * @return	false|null	Nothing, or false on error
2090 2090
      * */
2091 2091
     public static function add_courses_to_session(
2092 2092
         $sessionId,
@@ -2282,6 +2282,8 @@  discard block
 block discarded – undo
2282 2282
      *
2283 2283
      * @param int Session id
2284 2284
      * @param int Course id
2285
+     * @param integer $session_id
2286
+     * @param integer $course_id
2285 2287
      * @return bool True in case of success, false otherwise
2286 2288
      */
2287 2289
     public static function unsubscribe_course_from_session($session_id, $course_id)
@@ -2337,7 +2339,7 @@  discard block
 block discarded – undo
2337 2339
      * @param	string	$variable Field's internal variable name
2338 2340
      * @param	int		$fieldType Field's type
2339 2341
      * @param	string	$displayText Field's language var name
2340
-     * @return int     new extra field id
2342
+     * @return boolean     new extra field id
2341 2343
      */
2342 2344
     public static function create_session_extra_field($variable, $fieldType, $displayText)
2343 2345
     {
@@ -2561,7 +2563,7 @@  discard block
 block discarded – undo
2561 2563
      * @param	array	id_checked
2562 2564
      * @param	bool	include delete session
2563 2565
      * @param	bool	optional, true if the function is called by a webservice, false otherwise.
2564
-     * @return	void	Nothing, or false on error
2566
+     * @return	boolean	Nothing, or false on error
2565 2567
      * The parameters is a array to delete sessions
2566 2568
      * */
2567 2569
     public static function delete_session_category($id_checked, $delete_session = false, $from_ws = false)
@@ -3056,6 +3058,7 @@  discard block
 block discarded – undo
3056 3058
      * @param string $orderCondition
3057 3059
      * @param string $keyword
3058 3060
      * @param string $description
3061
+     * @param integer $status
3059 3062
      * @return array sessions
3060 3063
      */
3061 3064
     public static function getSessionsFollowedByUser(
@@ -3268,8 +3271,8 @@  discard block
 block discarded – undo
3268 3271
     /**
3269 3272
      * Gets the list of courses by session filtered by access_url
3270 3273
      *
3271
-     * @param $userId
3272
-     * @param $sessionId
3274
+     * @param integer $userId
3275
+     * @param null|integer $sessionId
3273 3276
      * @param null $from
3274 3277
      * @param null $limit
3275 3278
      * @param null $column
@@ -3394,6 +3397,7 @@  discard block
 block discarded – undo
3394 3397
     /**
3395 3398
      * Gets the count of courses by session filtered by access_url
3396 3399
      * @param int session id
3400
+     * @param integer $session_id
3397 3401
      * @return array list of courses
3398 3402
      */
3399 3403
     public static function getCourseCountBySessionId($session_id, $keyword = null)
@@ -3645,6 +3649,7 @@  discard block
 block discarded – undo
3645 3649
      * Updates a session status
3646 3650
      * @param	int 	session id
3647 3651
      * @param	int 	status
3652
+     * @param integer $status
3648 3653
      */
3649 3654
     public static function set_session_status($session_id, $status)
3650 3655
     {
@@ -3853,7 +3858,7 @@  discard block
 block discarded – undo
3853 3858
      * Protect a session to be edited.
3854 3859
      * @param int $id
3855 3860
      * @param bool $checkSession
3856
-     * @return mixed | bool true if pass the check, api_not_allowed otherwise
3861
+     * @return boolean|null | bool true if pass the check, api_not_allowed otherwise
3857 3862
      */
3858 3863
     public static function protectSession($id, $checkSession = true)
3859 3864
     {
@@ -3961,7 +3966,7 @@  discard block
 block discarded – undo
3961 3966
 
3962 3967
     /**
3963 3968
      * @param $id
3964
-     * @return bool
3969
+     * @return null|boolean
3965 3970
      */
3966 3971
     public static function protect_teacher_session_edit($id)
3967 3972
     {
@@ -4025,7 +4030,7 @@  discard block
 block discarded – undo
4025 4030
      *  true: if the session exists it will be updated.
4026 4031
      *  false: if session exists a new session will be created adding a counter session1, session2, etc
4027 4032
      * @param int $defaultUserId
4028
-     * @param mixed $logger
4033
+     * @param Logger $logger
4029 4034
      * @param array $extraFields convert a file row to an extra field. Example in CSV file there's a SessionID then it will
4030 4035
      * converted to extra_external_session_id if you set this: array('SessionId' => 'extra_external_session_id')
4031 4036
      * @param string $extraFieldId
@@ -5273,7 +5278,6 @@  discard block
 block discarded – undo
5273 5278
      * @param string $lastConnectionDate
5274 5279
      * @param array $sessionIdList
5275 5280
      * @param array $studentIdList
5276
-     * @param int $userStatus STUDENT|COURSEMANAGER constants
5277 5281
      *
5278 5282
      * @return array|int
5279 5283
      */
@@ -5425,7 +5429,7 @@  discard block
 block discarded – undo
5425 5429
     /**
5426 5430
      * Get the list of course tools that have to be dealt with in case of
5427 5431
      * registering any course to a session
5428
-     * @return array The list of tools to be dealt with (literal names)
5432
+     * @return string[] The list of tools to be dealt with (literal names)
5429 5433
      */
5430 5434
     public static function getCourseToolToBeManaged()
5431 5435
     {
@@ -5439,7 +5443,7 @@  discard block
 block discarded – undo
5439 5443
      * Calls the methods bound to each tool when a course is registered into a session
5440 5444
      * @param int $sessionId
5441 5445
      * @param int $courseId
5442
-     * @return void
5446
+     * @return boolean|null
5443 5447
      */
5444 5448
     public static function installCourse($sessionId, $courseId)
5445 5449
     {
@@ -6079,6 +6083,7 @@  discard block
 block discarded – undo
6079 6083
      * @param int $categoryId The internal ID of the session category
6080 6084
      * @param string $target Value to search for in the session field values
6081 6085
      * @param array $extraFields A list of fields to be scanned and returned
6086
+     * @param DateTime $publicationDate
6082 6087
      * @return mixed
6083 6088
      */
6084 6089
     public static function getShortSessionListAndExtraByCategory($categoryId, $target, $extraFields = null, $publicationDate = null)
@@ -6591,6 +6596,8 @@  discard block
 block discarded – undo
6591 6596
      * Converts "start date" and "end date" to "From start date to end date" string
6592 6597
      * @param string $startDate
6593 6598
      * @param string $endDate
6599
+     * @param boolean $showTime
6600
+     * @param boolean $dateHuman
6594 6601
      *
6595 6602
      * @return string
6596 6603
      */
@@ -7407,7 +7414,7 @@  discard block
 block discarded – undo
7407 7414
     /**
7408 7415
      * Get link to the admin page for this session
7409 7416
      * @param   int $id Session ID
7410
-     * @return mixed    URL to the admin page to manage the session, or false on error
7417
+     * @return false|string    URL to the admin page to manage the session, or false on error
7411 7418
      */
7412 7419
     public static function getAdminPath($id)
7413 7420
     {
@@ -7424,7 +7431,7 @@  discard block
 block discarded – undo
7424 7431
      * If a course is provided, build the link to the course
7425 7432
      * @param   int $id Session ID
7426 7433
      * @param   int $courseId Course ID (optional) in case the link has to send straight to the course
7427
-     * @return mixed    URL to the page to use the session, or false on error
7434
+     * @return false|string    URL to the page to use the session, or false on error
7428 7435
      */
7429 7436
     public static function getPath($id, $courseId = 0)
7430 7437
     {
@@ -7522,7 +7529,7 @@  discard block
 block discarded – undo
7522 7529
     /**
7523 7530
      * Return true if coach is allowed to access this session
7524 7531
      * @param int $sessionId
7525
-     * @return bool
7532
+     * @return integer
7526 7533
      */
7527 7534
     public static function isSessionDateOkForCoach($sessionId)
7528 7535
     {
Please login to merge, or discard this patch.
main/inc/lib/course_home.lib.php 1 patch
Doc Comments   +2 added lines, -1 removed lines patch added patch discarded remove patch
@@ -218,7 +218,7 @@  discard block
 block discarded – undo
218 218
     /**
219 219
      * Displays the tools of a certain category.
220 220
      *
221
-     * @return void
221
+     * @return string
222 222
      * @param string $course_tool_category	contains the category of tools to display:
223 223
      * "Public", "PublicButHide", "courseAdmin", "claroAdmin"
224 224
      */
@@ -1210,6 +1210,7 @@  discard block
 block discarded – undo
1210 1210
 
1211 1211
     /**
1212 1212
      * Show a toolbar with shortcuts to the course tool
1213
+     * @param integer $orientation
1213 1214
      */
1214 1215
     public static function show_navigation_tool_shortcuts($orientation = SHORTCUTS_HORIZONTAL)
1215 1216
     {
Please login to merge, or discard this patch.
main/inc/lib/MoodleImport.class.php 1 patch
Doc Comments   +7 added lines, -7 removed lines patch added patch discarded remove patch
@@ -317,7 +317,7 @@  discard block
 block discarded – undo
317 317
      * Read and validate the quiz module XML
318 318
      *
319 319
      * @param resource $moduleXml XML file
320
-     * @return mixed | array if is a valid xml file, false otherwise
320
+     * @return string | array if is a valid xml file, false otherwise
321 321
      */
322 322
     public function readQuizModule($moduleXml)
323 323
     {
@@ -537,9 +537,9 @@  discard block
 block discarded – undo
537 537
      *
538 538
      * @param array $questionList
539 539
      * @param string $questionType
540
-     * @param object $questionInstance Question/Answer instance
540
+     * @param Question $questionInstance Question/Answer instance
541 541
      * @param array $currentQuestion
542
-     * @return integer db response
542
+     * @return boolean|null db response
543 543
      */
544 544
     public function processAnswers($questionList, $questionType, $questionInstance, $currentQuestion)
545 545
     {
@@ -665,7 +665,7 @@  discard block
 block discarded – undo
665 665
     /**
666 666
      * Process Chamilo Unique Answer
667 667
      *
668
-     * @param object $objAnswer
668
+     * @param Answer $objAnswer
669 669
      * @param array $answerValues
670 670
      * @param integer $position
671 671
      * @param integer $questionWeighting
@@ -698,7 +698,7 @@  discard block
 block discarded – undo
698 698
     /**
699 699
      * Process Chamilo True False
700 700
      *
701
-     * @param object $objAnswer
701
+     * @param Answer $objAnswer
702 702
      * @param array $answerValues
703 703
      * @param integer $position
704 704
      * @param integer $questionWeighting
@@ -731,7 +731,7 @@  discard block
 block discarded – undo
731 731
     /**
732 732
      * Process Chamilo FillBlanks
733 733
      *
734
-     * @param object $objAnswer
734
+     * @param Answer $objAnswer
735 735
      * @param array $questionType
736 736
      * @param array $answerValues
737 737
      * @param string $placeholder
@@ -826,7 +826,7 @@  discard block
 block discarded – undo
826 826
      * Litle utility to delete the unuseful tags
827 827
      *
828 828
      * @param $array
829
-     * @param $keys
829
+     * @param string[] $keys
830 830
      */
831 831
     public function traverseArray(&$array, $keys)
832 832
     {
Please login to merge, or discard this patch.