Completed
Push — 1.11.x ( 033bfd...c69862 )
by José
141:38 queued 100:32
created
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.
main/inc/lib/auth.lib.php 1 patch
Doc Comments   +8 added lines patch added patch discarded remove patch
@@ -183,6 +183,7 @@  discard block
 block discarded – undo
183 183
      * (moving a course to a different course category)
184 184
      * @param  int    $courseId
185 185
      * @param  int       Category id
186
+     * @param integer $newcategory
186 187
      * @return bool      True if it success
187 188
      */
188 189
     public function updateCourseCategory($courseId, $newcategory)
@@ -215,6 +216,9 @@  discard block
 block discarded – undo
215 216
      * @param   string    Direction (up/down)
216 217
      * @param   string    Course code
217 218
      * @param   int       Category id
219
+     * @param string $direction
220
+     * @param string $course2move
221
+     * @param integer $category
218 222
      * @return  bool      True if it success
219 223
      */
220 224
     public function move_course($direction, $course2move, $category)
@@ -285,6 +289,8 @@  discard block
 block discarded – undo
285 289
      * Moves the course one place up or down
286 290
      * @param string    Direction up/down
287 291
      * @param string    Category id
292
+     * @param string $direction
293
+     * @param integer $category2move
288 294
      * @return bool     True If it success
289 295
      */
290 296
     public function move_category($direction, $category2move)
@@ -348,6 +354,8 @@  discard block
 block discarded – undo
348 354
      * Updates the user course category in the chamilo_user database
349 355
      * @param   string  Category title
350 356
      * @param   int     Category id
357
+     * @param string $title
358
+     * @param integer $category_id
351 359
      * @return  bool    True if it success
352 360
      */
353 361
     public function store_edit_course_category($title, $category_id)
Please login to merge, or discard this patch.
main/inc/lib/blog.lib.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -1103,7 +1103,7 @@
 block discarded – undo
1103 1103
      * @param String $type
1104 1104
      * @param Integer $blog_id
1105 1105
      * @param Integer $item_id
1106
-     * @return array
1106
+     * @return double
1107 1107
      */
1108 1108
     public static function display_rating($type, $blog_id, $item_id)
1109 1109
     {
Please login to merge, or discard this patch.
main/inc/lib/course_description.lib.php 1 patch
Doc Comments   +6 added lines, -6 removed lines patch added patch discarded remove patch
@@ -359,7 +359,7 @@  discard block
 block discarded – undo
359 359
 
360 360
     /**
361 361
      * Get description titles by default
362
-     * @return array
362
+     * @return string[]
363 363
      */
364 364
     public function get_default_description_title()
365 365
     {
@@ -378,7 +378,7 @@  discard block
 block discarded – undo
378 378
 
379 379
     /**
380 380
      * Get description titles editable by default
381
-     * @return array
381
+     * @return boolean[]
382 382
      */
383 383
     public function get_default_description_title_editable()
384 384
     {
@@ -397,7 +397,7 @@  discard block
 block discarded – undo
397 397
 
398 398
     /**
399 399
      * Get description icons by default
400
-     * @return array
400
+     * @return string[]
401 401
      */
402 402
     public function get_default_description_icon()
403 403
     {
@@ -417,7 +417,7 @@  discard block
 block discarded – undo
417 417
 
418 418
     /**
419 419
      * Get questions by default for help
420
-     * @return array
420
+     * @return string[]
421 421
      */
422 422
     public function get_default_question()
423 423
     {
@@ -436,7 +436,7 @@  discard block
 block discarded – undo
436 436
 
437 437
     /**
438 438
      * Get informations by default for help
439
-     * @return array
439
+     * @return string[]
440 440
      */
441 441
     public function get_default_information()
442 442
     {
@@ -574,7 +574,7 @@  discard block
 block discarded – undo
574 574
     /**
575 575
      * get progress of a description
576 576
      *
577
-     * @return int
577
+     * @return string
578 578
      */
579 579
     public function get_progress()
580 580
     {
Please login to merge, or discard this patch.