@@ -321,7 +321,7 @@ discard block |
||
321 | 321 | * |
322 | 322 | * @access public |
323 | 323 | * @param mixed , A string or array of protocols that will be removed from the internal list of allowed protocols. |
324 | - * @return bool Status of removing valid protocols. |
|
324 | + * @return null|boolean Status of removing valid protocols. |
|
325 | 325 | * @see RemoveProtocol() |
326 | 326 | * @since PHP5 OOP 1.0.0 |
327 | 327 | */ |
@@ -1133,9 +1133,7 @@ discard block |
||
1133 | 1133 | * URL protocol white listing system anyway. |
1134 | 1134 | * |
1135 | 1135 | * @access private |
1136 | - * @param string $value The entitiy to be decoded. |
|
1137 | - * @return string Decoded entity |
|
1138 | - * @since PHP4 OOP 0.0.1 |
|
1136 | + * @param string $string |
|
1139 | 1137 | */ |
1140 | 1138 | private function decodeEntities($string) |
1141 | 1139 | { |
@@ -121,6 +121,9 @@ |
||
121 | 121 | return $out; |
122 | 122 | } |
123 | 123 | |
124 | + /** |
|
125 | + * @param string $text |
|
126 | + */ |
|
124 | 127 | function output_code_wrap($text) |
125 | 128 | { |
126 | 129 | if(KSESTEST_ENV == 'CLI') |
@@ -266,6 +266,7 @@ discard block |
||
266 | 266 | * @global bool $is_platformAdmin |
267 | 267 | * @global bool $is_allowedCreateCourse |
268 | 268 | * @global object $_user |
269 | + * @param boolean $reset |
|
269 | 270 | */ |
270 | 271 | public static function init_user($user_id, $reset) |
271 | 272 | { |
@@ -355,7 +356,7 @@ discard block |
||
355 | 356 | * @global type $is_allowed_in_course |
356 | 357 | * |
357 | 358 | * @param type $course_id |
358 | - * @param type $reset |
|
359 | + * @param boolean $reset |
|
359 | 360 | */ |
360 | 361 | static function init_course($course_id, $reset) |
361 | 362 | { |
@@ -2,7 +2,6 @@ |
||
2 | 2 | /* For licensing terms, see /license.txt */ |
3 | 3 | |
4 | 4 | use ChamiloSession as Session; |
5 | - |
|
6 | 5 | use Chamilo\UserBundle\Entity\User; |
7 | 6 | |
8 | 7 | /** |
@@ -616,6 +616,8 @@ discard block |
||
616 | 616 | * @param int message id |
617 | 617 | * @param int message user id (receiver user id or sender user id) |
618 | 618 | * @param int group id (optional) |
619 | + * @param integer $message_id |
|
620 | + * @param integer $message_uid |
|
619 | 621 | * @return void |
620 | 622 | */ |
621 | 623 | public static function delete_message_attachment_file($message_id, $message_uid, $group_id = 0) |
@@ -660,7 +662,7 @@ discard block |
||
660 | 662 | * update messages by user id and message id |
661 | 663 | * @param int $user_id |
662 | 664 | * @param int $message_id |
663 | - * @return resource |
|
665 | + * @return false|null |
|
664 | 666 | */ |
665 | 667 | public static function update_message($user_id, $message_id) |
666 | 668 | { |
@@ -680,7 +682,7 @@ discard block |
||
680 | 682 | * @param int $user_id |
681 | 683 | * @param int $message_id |
682 | 684 | * @param string $type |
683 | - * @return bool |
|
685 | + * @return false|null |
|
684 | 686 | */ |
685 | 687 | public static function update_message_status($user_id, $message_id,$type) |
686 | 688 | { |
@@ -717,6 +719,7 @@ discard block |
||
717 | 719 | /** |
718 | 720 | * get messages by group id |
719 | 721 | * @param int group id |
722 | + * @param integer $group_id |
|
720 | 723 | * @return array |
721 | 724 | */ |
722 | 725 | public static function get_messages_by_group($group_id) |
@@ -1433,7 +1436,7 @@ discard block |
||
1433 | 1436 | * Sort date by desc from a multi-dimensional array |
1434 | 1437 | * @param array $array1 first array to compare |
1435 | 1438 | * @param array $array2 second array to compare |
1436 | - * @return bool |
|
1439 | + * @return integer |
|
1437 | 1440 | */ |
1438 | 1441 | public function order_desc_date($array1, $array2) |
1439 | 1442 | { |
@@ -1511,7 +1514,6 @@ discard block |
||
1511 | 1514 | /** |
1512 | 1515 | * @param $id |
1513 | 1516 | * @param array $params |
1514 | - * @param string $display |
|
1515 | 1517 | * @return string |
1516 | 1518 | */ |
1517 | 1519 | public static function generate_invitation_form($id, $params = array()) |
@@ -25,6 +25,7 @@ |
||
25 | 25 | |
26 | 26 | /** |
27 | 27 | * Useful finder - experimental akelos like only use in notification.lib.php send function |
28 | + * @param string $type |
|
28 | 29 | */ |
29 | 30 | public function find($type, $options = null) |
30 | 31 | { |
@@ -634,7 +634,6 @@ discard block |
||
634 | 634 | * @param int $sessionId The session ID |
635 | 635 | * @param int $courseId The course ID |
636 | 636 | * @param int $exerciseId The quiz ID |
637 | - * @param int $answer Answer status (0 = incorrect, 1 = correct, 2 = both) |
|
638 | 637 | * @return string HTML array of results formatted for gridJS |
639 | 638 | * @author César Perales <[email protected]>, Beeznest Team |
640 | 639 | */ |
@@ -1222,6 +1221,7 @@ discard block |
||
1222 | 1221 | * @param int Number of items to select |
1223 | 1222 | * @param string Column to order on |
1224 | 1223 | * @param string Order direction |
1224 | + * @param integer $number_of_items |
|
1225 | 1225 | * @return array Results |
1226 | 1226 | */ |
1227 | 1227 | public static function get_course_data_tracking_overview($from, $number_of_items, $column, $direction) |
@@ -1556,6 +1556,7 @@ discard block |
||
1556 | 1556 | * @param int Number of items to select |
1557 | 1557 | * @param string Column to order on |
1558 | 1558 | * @param string Order direction |
1559 | + * @param integer $number_of_items |
|
1559 | 1560 | * @return array Results |
1560 | 1561 | */ |
1561 | 1562 | public static function get_session_data_tracking_overview($from, $number_of_items, $column, $direction) |
@@ -1576,7 +1577,6 @@ discard block |
||
1576 | 1577 | /** |
1577 | 1578 | * Fills in session reporting data |
1578 | 1579 | * |
1579 | - * @param integer $user_id the id of the user |
|
1580 | 1580 | * @param array $url_params additonal url parameters |
1581 | 1581 | * @param array $row the row information (the other columns) |
1582 | 1582 | * @return string html code |
@@ -2206,6 +2206,7 @@ discard block |
||
2206 | 2206 | * @author Patrick Cool <[email protected]>, Ghent University, Belgium |
2207 | 2207 | * @version Dokeos 1.8.6 |
2208 | 2208 | * @since October 2008 |
2209 | + * @param integer $number_of_items |
|
2209 | 2210 | */ |
2210 | 2211 | public static function get_user_data_tracking_overview($from, $number_of_items, $column, $direction) |
2211 | 2212 | { |
@@ -2308,7 +2309,6 @@ discard block |
||
2308 | 2309 | /** |
2309 | 2310 | * Checks if there are repeted users in a given array |
2310 | 2311 | * @param array $usernames list of the usernames in the uploaded file |
2311 | - * @param array $user_array['username'] and $user_array['sufix'] where sufix is the number part in a login i.e -> jmontoya2 |
|
2312 | 2312 | * @return array with the $usernames array and the $user_array array |
2313 | 2313 | * @author Julio Montoya Armas |
2314 | 2314 | */ |
@@ -38,7 +38,7 @@ |
||
38 | 38 | } |
39 | 39 | |
40 | 40 | /** |
41 | - * @return bool |
|
41 | + * @return false|null |
|
42 | 42 | */ |
43 | 43 | public function create_user_folder() |
44 | 44 | { |
@@ -219,7 +219,7 @@ |
||
219 | 219 | * @param array $user_list recipients: user list of ids |
220 | 220 | * @param string $title |
221 | 221 | * @param string $content |
222 | - * @param array $sender_info |
|
222 | + * @param array $senderInfo |
|
223 | 223 | * result of api_get_user_info() or GroupPortalManager:get_group_data() |
224 | 224 | */ |
225 | 225 | public function save_notification( |
@@ -306,7 +306,7 @@ discard block |
||
306 | 306 | /** |
307 | 307 | * gets the current debug data for this instance |
308 | 308 | * |
309 | - * @return debug data |
|
309 | + * @return string data |
|
310 | 310 | * @access public |
311 | 311 | */ |
312 | 312 | function &getDebug() { |
@@ -319,7 +319,7 @@ discard block |
||
319 | 319 | * gets the current debug data for this instance as an XML comment |
320 | 320 | * this may change the contents of the debug data |
321 | 321 | * |
322 | - * @return debug data as an XML comment |
|
322 | + * @return string data as an XML comment |
|
323 | 323 | * @access public |
324 | 324 | */ |
325 | 325 | function &getDebugAsXMLComment() { |
@@ -352,7 +352,7 @@ discard block |
||
352 | 352 | /** |
353 | 353 | * returns error string if present |
354 | 354 | * |
355 | - * @return mixed error string or false |
|
355 | + * @return string|false error string or false |
|
356 | 356 | * @access public |
357 | 357 | */ |
358 | 358 | function getError(){ |
@@ -365,7 +365,7 @@ discard block |
||
365 | 365 | /** |
366 | 366 | * sets error string |
367 | 367 | * |
368 | - * @return boolean $string error string |
|
368 | + * @return boolean|null $string error string |
|
369 | 369 | * @access private |
370 | 370 | */ |
371 | 371 | function setError($str){ |
@@ -801,7 +801,7 @@ discard block |
||
801 | 801 | * returns false, if not prefixed |
802 | 802 | * |
803 | 803 | * @param string $str The prefixed string |
804 | - * @return mixed The prefix or false if there is no prefix |
|
804 | + * @return string|false The prefix or false if there is no prefix |
|
805 | 805 | * @access public |
806 | 806 | */ |
807 | 807 | function getPrefix($str){ |
@@ -832,7 +832,7 @@ discard block |
||
832 | 832 | * or false if no prefixes registered for the given namespace |
833 | 833 | * |
834 | 834 | * @param string $ns The namespace |
835 | - * @return mixed The prefix, false if the namespace has no prefixes |
|
835 | + * @return string The prefix, false if the namespace has no prefixes |
|
836 | 836 | * @access public |
837 | 837 | */ |
838 | 838 | function getPrefixFromNamespace($ns) { |
@@ -898,7 +898,7 @@ discard block |
||
898 | 898 | * |
899 | 899 | * @param int $timestamp Unix time stamp |
900 | 900 | * @param boolean $utc Whether the time stamp is UTC or local |
901 | -* @return mixed ISO 8601 date string or false |
|
901 | +* @return string|false ISO 8601 date string or false |
|
902 | 902 | * @access public |
903 | 903 | */ |
904 | 904 | function timestamp_to_iso8601($timestamp,$utc=true){ |