@@ -138,7 +138,7 @@ |
||
138 | 138 | |
139 | 139 | /** |
140 | 140 | * Return a list an associative array where keys are the active hook observer class name |
141 | - * @param $eventName |
|
141 | + * @param string $eventName |
|
142 | 142 | * |
143 | 143 | * @return array |
144 | 144 | */ |
@@ -52,6 +52,9 @@ discard block |
||
52 | 52 | } |
53 | 53 | } |
54 | 54 | |
55 | + /** |
|
56 | + * @param string|null $cropParameters |
|
57 | + */ |
|
55 | 58 | public function crop($cropParameters) { |
56 | 59 | $image_size = $this->get_image_size($this->image_wrapper->path); |
57 | 60 | $src_width = $image_size['width']; |
@@ -66,6 +69,9 @@ discard block |
||
66 | 69 | return $image; |
67 | 70 | } |
68 | 71 | |
72 | + /** |
|
73 | + * @param string $convert_file_to |
|
74 | + */ |
|
69 | 75 | public function send_image( |
70 | 76 | $file = '', |
71 | 77 | $compress = -1, |
@@ -147,6 +153,9 @@ discard block |
||
147 | 153 | public $image; |
148 | 154 | public $filter = Imagick::FILTER_LANCZOS; |
149 | 155 | |
156 | + /** |
|
157 | + * @param string $path |
|
158 | + */ |
|
150 | 159 | public function __construct($path) |
151 | 160 | { |
152 | 161 | parent::__construct($path); |
@@ -194,6 +203,10 @@ discard block |
||
194 | 203 | } |
195 | 204 | |
196 | 205 | //@todo implement border logic case for Imagick |
206 | + |
|
207 | + /** |
|
208 | + * @param integer $border |
|
209 | + */ |
|
197 | 210 | public function resize($thumbw, $thumbh, $border, $specific_size = false) |
198 | 211 | { |
199 | 212 | if (!$this->image_validated) return false; |
@@ -275,6 +288,9 @@ discard block |
||
275 | 288 | { |
276 | 289 | public $bg; |
277 | 290 | |
291 | + /** |
|
292 | + * @param string $path |
|
293 | + */ |
|
278 | 294 | function __construct($path) { |
279 | 295 | parent::__construct($path); |
280 | 296 | } |
@@ -332,6 +348,9 @@ discard block |
||
332 | 348 | } |
333 | 349 | } |
334 | 350 | |
351 | + /** |
|
352 | + * @param integer $border |
|
353 | + */ |
|
335 | 354 | public function resize($thumbw, $thumbh, $border, $specific_size = false) |
336 | 355 | { |
337 | 356 | if (!$this->image_validated) return false; |
@@ -408,6 +408,9 @@ discard block |
||
408 | 408 | } # function kses_no_null |
409 | 409 | |
410 | 410 | |
411 | +/** |
|
412 | + * @return string |
|
413 | + */ |
|
411 | 414 | function kses_stripslashes($string) |
412 | 415 | ############################################################################### |
413 | 416 | # This function changes the character sequence \" to just " |
@@ -442,6 +445,9 @@ discard block |
||
442 | 445 | } # function kses_array_lc |
443 | 446 | |
444 | 447 | |
448 | +/** |
|
449 | + * @return string |
|
450 | + */ |
|
445 | 451 | function kses_js_entities($string) |
446 | 452 | ############################################################################### |
447 | 453 | # This function removes the HTML JavaScript entities found in early versions of |
@@ -506,6 +512,9 @@ discard block |
||
506 | 512 | } # function kses_bad_protocol_once2 |
507 | 513 | |
508 | 514 | |
515 | +/** |
|
516 | + * @return string |
|
517 | + */ |
|
509 | 518 | function kses_normalize_entities($string) |
510 | 519 | ############################################################################### |
511 | 520 | # This function normalizes HTML entities. It will convert "AT&T" to the correct |
@@ -431,7 +431,7 @@ discard block |
||
431 | 431 | * |
432 | 432 | * @access public |
433 | 433 | * @param mixed , A string or array of protocols that will be removed from the internal list of allowed protocols. |
434 | - * @return bool Status of removing valid protocols. |
|
434 | + * @return null|boolean Status of removing valid protocols. |
|
435 | 435 | * @see RemoveProtocol() |
436 | 436 | * @since PHP5 OOP 0.2.1 |
437 | 437 | */ |
@@ -579,7 +579,7 @@ discard block |
||
579 | 579 | * This method goes through an array, and changes the keys to all lower case. |
580 | 580 | * |
581 | 581 | * @access private |
582 | - * @param array $in_array Associative array |
|
582 | + * @param array $inarray Associative array |
|
583 | 583 | * @return array Modified array |
584 | 584 | * @since PHP4 OOP 0.0.1 |
585 | 585 | */ |
@@ -1129,9 +1129,7 @@ discard block |
||
1129 | 1129 | * URL protocol white listing system anyway. |
1130 | 1130 | * |
1131 | 1131 | * @access private |
1132 | - * @param string $value The entitiy to be decoded. |
|
1133 | - * @return string Decoded entity |
|
1134 | - * @since PHP4 OOP 0.0.1 |
|
1132 | + * @param string $string |
|
1135 | 1133 | */ |
1136 | 1134 | function _decode_entities($string) |
1137 | 1135 | { |
@@ -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 | { |
@@ -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 | { |