Completed
Push — 1.11.x ( 0609ac...d3f3e5 )
by José
161:19 queued 122:35
created
main/inc/lib/myspace.lib.php 1 patch
Doc Comments   +4 added lines, -3 removed lines patch added patch discarded remove patch
@@ -666,7 +666,6 @@  discard block
 block discarded – undo
666 666
      * @param   int $sessionId  The session ID
667 667
      * @param   int $courseId   The course ID
668 668
      * @param   int $exerciseId The quiz ID
669
-     * @param   int $answer Answer status (0 = incorrect, 1 = correct, 2 = both)
670 669
      * @return  string  HTML array of results formatted for gridJS
671 670
      * @author César Perales <[email protected]>, Beeznest Team
672 671
      */
@@ -1254,6 +1253,7 @@  discard block
 block discarded – undo
1254 1253
      * @param int Number of items to select
1255 1254
      * @param string Column to order on
1256 1255
      * @param string Order direction
1256
+     * @param integer $number_of_items
1257 1257
      * @return array Results
1258 1258
      */
1259 1259
     public static function get_course_data_tracking_overview($from, $number_of_items, $column, $direction)
@@ -1588,6 +1588,7 @@  discard block
 block discarded – undo
1588 1588
      * @param int Number of items to select
1589 1589
      * @param string Column to order on
1590 1590
      * @param string Order direction
1591
+     * @param integer $number_of_items
1591 1592
      * @return array Results
1592 1593
      */
1593 1594
     public static function get_session_data_tracking_overview($from, $number_of_items, $column, $direction)
@@ -1608,7 +1609,6 @@  discard block
 block discarded – undo
1608 1609
     /**
1609 1610
      * Fills in session reporting data
1610 1611
      *
1611
-     * @param integer $user_id the id of the user
1612 1612
      * @param array $url_params additonal url parameters
1613 1613
      * @param array $row the row information (the other columns)
1614 1614
      * @return string html code
@@ -2239,6 +2239,7 @@  discard block
 block discarded – undo
2239 2239
      * @author Patrick Cool <[email protected]>, Ghent University, Belgium
2240 2240
      * @version Dokeos 1.8.6
2241 2241
      * @since October 2008
2242
+     * @param integer $number_of_items
2242 2243
      */
2243 2244
     public static function get_user_data_tracking_overview($from, $number_of_items, $column, $direction)
2244 2245
     {
@@ -2341,7 +2342,6 @@  discard block
 block discarded – undo
2341 2342
     /**
2342 2343
      * Checks if there are repeted users in a given array
2343 2344
      * @param  array $usernames list of the usernames in the uploaded file
2344
-     * @param  array $user_array['username'] and $user_array['sufix'] where sufix is the number part in a login i.e -> jmontoya2
2345 2345
      * @return array with the $usernames array and the $user_array array
2346 2346
      * @author Julio Montoya Armas
2347 2347
      */
@@ -2516,6 +2516,7 @@  discard block
 block discarded – undo
2516 2516
 
2517 2517
     /**
2518 2518
      * Adds missing user-information (which isn't required, like password, etc).
2519
+     * @return integer
2519 2520
      */
2520 2521
     function complete_missing_data($user) {
2521 2522
         // 1. Generate a password if it is necessary.
Please login to merge, or discard this patch.
main/inc/lib/fileManage.lib.php 1 patch
Doc Comments   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -39,8 +39,8 @@  discard block
 block discarded – undo
39 39
  * Deletes a file or a directory
40 40
  *
41 41
  * @author - Hugues Peeters
42
- * @param  $file (String) - the path of file or directory to delete
43
- * @return boolean - true if the delete succeed, false otherwise.
42
+ * @param  string $file (String) - the path of file or directory to delete
43
+ * @return boolean|null - true if the delete succeed, false otherwise.
44 44
  * @see    - delete() uses check_name_exist() and removeDir() functions
45 45
  */
46 46
 function my_delete($file)
@@ -127,7 +127,7 @@  discard block
 block discarded – undo
127 127
  * @author Hugues Peeters <[email protected]>
128 128
  * @param  string $file_path complete path of the file or the directory
129 129
  * @param  string $new_file_name new name for the file or the directory
130
- * @return boolean true if succeed, false otherwise
130
+ * @return string|false true if succeed, false otherwise
131 131
  * @see rename() uses the check_name_exist() and php2phps() functions
132 132
  */
133 133
 function my_rename($file_path, $new_file_name) {
@@ -174,7 +174,7 @@  discard block
 block discarded – undo
174 174
  * @param  string $target the path of the new area
175 175
  * @param  bool $forceMove Whether to force a move or to make a copy (safer but slower) and then delete the original
176 176
  * @param	bool $moveContent In some cases (including migrations), we need to move the *content* and not the folder itself
177
- * @return bool true if the move succeed, false otherwise.
177
+ * @return boolean|null true if the move succeed, false otherwise.
178 178
  * @see move() uses check_name_exist() and copyDirTo() functions
179 179
  */
180 180
 function move($source, $target, $forceMove = false, $moveContent = false)
Please login to merge, or discard this patch.
main/inc/lib/skill.lib.php 1 patch
Doc Comments   +4 added lines, -3 removed lines patch added patch discarded remove patch
@@ -326,6 +326,7 @@  discard block
 block discarded – undo
326 326
 
327 327
     /**
328 328
      * Gets an element
329
+     * @param integer $gradebook_id
329 330
      */
330 331
     public function get_skill_info($skill_id, $gradebook_id)
331 332
     {
@@ -544,7 +545,7 @@  discard block
 block discarded – undo
544 545
      * Gets an element
545 546
      * @param int $id
546 547
      *
547
-     * @return array|mixed
548
+     * @return integer
548 549
      */
549 550
     public function get($id)
550 551
     {
@@ -885,7 +886,7 @@  discard block
 block discarded – undo
885 886
     /**
886 887
      * Get user's skills
887 888
      *
888
-     * @param int $userId User's id
889
+     * @param integer $user_id User's id
889 890
      * @param bool $get_skill_data
890 891
      */
891 892
     public function get_user_skills($user_id, $get_skill_data = false)
@@ -1090,7 +1091,7 @@  discard block
 block discarded – undo
1090 1091
      * @param bool return a flat array or not
1091 1092
      * @param int depth of the skills
1092 1093
      * @param bool filter status
1093
-     * @return json
1094
+     * @return string
1094 1095
      */
1095 1096
     public function get_skills_tree_json($user_id = null, $skill_id = null, $return_flat_array = false, $main_depth = 2, $filter_status = false)
1096 1097
     {
Please login to merge, or discard this patch.
main/inc/lib/system_announcements.lib.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -306,7 +306,7 @@
 block discarded – undo
306 306
      * @param int    Whether the announcement should be visible to anonymous users (1) or not (0)
307 307
      * @param string The language for which the announvement should be shown. Leave null for all langages
308 308
      * @param int    Whether to send an e-mail to all users (1) or not (0)
309
-     * @return mixed  insert_id on success, false on failure
309
+     * @return false|string  insert_id on success, false on failure
310 310
      */
311 311
     public static function add_announcement(
312 312
         $title,
Please login to merge, or discard this patch.
main/inc/lib/system/session.class.php 1 patch
Doc Comments   +4 added lines, -1 removed lines patch added patch discarded remove patch
@@ -14,6 +14,9 @@  discard block
 block discarded – undo
14 14
 class Session implements \ArrayAccess
15 15
 {
16 16
 
17
+    /**
18
+     * @param string $variable
19
+     */
17 20
     static function read($variable, $default = null)
18 21
     {
19 22
         return isset($_SESSION[$variable]) ? $_SESSION[$variable] : $default;
@@ -39,7 +42,7 @@  discard block
 block discarded – undo
39 42
      * Returns true if session has variable set up, false otherwise.
40 43
      *
41 44
      * @param string $variable
42
-     * @return mixed value
45
+     * @return boolean value
43 46
      */
44 47
     static function has($variable)
45 48
     {
Please login to merge, or discard this patch.
main/exercise/export/exercise_import.inc.php 1 patch
Doc Comments   -1 removed lines patch added patch discarded remove patch
@@ -949,7 +949,6 @@
 block discarded – undo
949 949
 /**
950 950
  * Processes an IMS/QTI manifest file: store links to new files to be able to transform them into questions text
951 951
  * @param string $filePath The absolute filepath
952
- * @param array $links List of filepaths changes
953 952
  * @return bool
954 953
  */
955 954
 function qtiProcessManifest($filePath)
Please login to merge, or discard this patch.
main/inc/lib/api.lib.php 1 patch
Doc Comments   +6 added lines, -3 removed lines patch added patch discarded remove patch
@@ -1240,6 +1240,7 @@  discard block
 block discarded – undo
1240 1240
  * Gets the list of courses a specific user is subscribed to
1241 1241
  * @param int       User ID
1242 1242
  * @param boolean   $fetch_session Whether to get session courses or not - NOT YET IMPLEMENTED
1243
+ * @param integer $userid
1243 1244
  * @return array    Array of courses in the form [0]=>('code'=>xxx,'db'=>xxx,'dir'=>xxx,'status'=>d)
1244 1245
  */
1245 1246
 function api_get_user_courses($userid, $fetch_session = true)
@@ -2949,7 +2950,7 @@  discard block
 block discarded – undo
2949 2950
 * on the session visibility
2950 2951
 * @param bool $tutor  Whether to check if the user has the tutor role
2951 2952
 * @param bool  $coach Whether to check if the user has the coach role
2952
-* @return boolean true: the user has the rights to edit, false: he does not
2953
+* @return boolean|null true: the user has the rights to edit, false: he does not
2953 2954
 */
2954 2955
 function api_is_allowed_to_session_edit($tutor = false, $coach = false)
2955 2956
 {
@@ -6606,7 +6607,7 @@  discard block
 block discarded – undo
6606 6607
 /**
6607 6608
  * Returns an array of global configuration settings which should be ignored
6608 6609
  * when printing the configuration settings screens
6609
- * @return array Array of strings, each identifying one of the excluded settings
6610
+ * @return string[] Array of strings, each identifying one of the excluded settings
6610 6611
  */
6611 6612
 function api_get_locked_settings() {
6612 6613
     return array(
@@ -6647,6 +6648,7 @@  discard block
 block discarded – undo
6647 6648
  * false if he isn't. If the user ID is given and is an integer, then the same
6648 6649
  * ID is simply returned
6649 6650
  * @param  integer User ID
6651
+ * @param integer $user_id
6650 6652
  * @return boolean Integer User ID is logged in, or false otherwise
6651 6653
  */
6652 6654
 function api_user_is_login($user_id = null) {
@@ -7091,6 +7093,7 @@  discard block
 block discarded – undo
7091 7093
 /**
7092 7094
  * Gets memory limit in bytes
7093 7095
  * @param string The memory size (128M, 1G, 1000K, etc)
7096
+ * @param string $mem
7094 7097
  * @return int
7095 7098
  * @assert (null) === false
7096 7099
  * @assert ('1t')  === 1099511627776
@@ -8033,7 +8036,7 @@  discard block
 block discarded – undo
8033 8036
 /**
8034 8037
  * Like strip_tags(), but leaves an additional space and removes only the given tags
8035 8038
  * @param string $string
8036
- * @param array $tags Tags to be removed
8039
+ * @param string[] $tags Tags to be removed
8037 8040
  * @return  string The original string without the given tags
8038 8041
  */
8039 8042
 function stripGivenTags($string, $tags) {
Please login to merge, or discard this patch.
main/inc/lib/MoodleImport.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/TicketManager.php 1 patch
Doc Comments   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -642,10 +642,10 @@  discard block
 block discarded – undo
642 642
     /**
643 643
      * Insert message between Users and Admins
644 644
      * @param $ticket_id
645
-     * @param $subject
646
-     * @param $content
645
+     * @param string $subject
646
+     * @param string $content
647 647
      * @param $file_attachments
648
-     * @param $user_id
648
+     * @param integer $user_id
649 649
      * @param string $status
650 650
      * @param bool $sendConfirmation
651 651
      * @return bool
@@ -744,9 +744,9 @@  discard block
 block discarded – undo
744 744
     /**
745 745
      * Attachment files when a message is sent
746 746
      * @param $file_attach
747
-     * @param $ticket_id
748
-     * @param $message_id
749
-     * @param $message_attch_id
747
+     * @param integer $ticket_id
748
+     * @param integer $message_id
749
+     * @param integer $message_attch_id
750 750
      * @return array
751 751
      */
752 752
     public static function save_message_attachment_file(
@@ -2006,7 +2006,7 @@  discard block
 block discarded – undo
2006 2006
     }
2007 2007
 
2008 2008
     /**
2009
-     * @param $id
2009
+     * @param integer $id
2010 2010
      * @return Project
2011 2011
      */
2012 2012
     public static function getProject($id)
@@ -2125,7 +2125,7 @@  discard block
 block discarded – undo
2125 2125
     }
2126 2126
 
2127 2127
     /**
2128
-     * @param $id
2128
+     * @param integer $id
2129 2129
      * @return Project
2130 2130
      */
2131 2131
     public static function getStatus($id)
@@ -2249,7 +2249,7 @@  discard block
 block discarded – undo
2249 2249
     }
2250 2250
 
2251 2251
     /**
2252
-     * @param $id
2252
+     * @param integer $id
2253 2253
      * @return Priority
2254 2254
      */
2255 2255
     public static function getPriority($id)
Please login to merge, or discard this patch.