@@ -967,6 +967,7 @@ |
||
967 | 967 | * 'list_type' List type: 'list' (default), 'gallery' |
968 | 968 | * 'list_type_toggle' Display the list type toggle? |
969 | 969 | * 'no_results' Message to display if no results (string|Closure) |
970 | + * @param integer $limit |
|
970 | 971 | * |
971 | 972 | * @return string The rendered list of entities |
972 | 973 | * @access private |
@@ -32,7 +32,7 @@ discard block |
||
32 | 32 | * @param string $context The context for this widget |
33 | 33 | * @param int $access_id If not specified, it is set to the default access level |
34 | 34 | * |
35 | - * @return int|false Widget GUID or false on failure |
|
35 | + * @return integer Widget GUID or false on failure |
|
36 | 36 | * @since 1.8.0 |
37 | 37 | */ |
38 | 38 | function elgg_create_widget($owner_guid, $handler, $context, $access_id = null) { |
@@ -290,7 +290,7 @@ discard block |
||
290 | 290 | * @param string $type The type of entity being created. |
291 | 291 | * @param string $return Value |
292 | 292 | * @param mixed $params Params |
293 | - * @return true|null |
|
293 | + * @return boolean|null |
|
294 | 294 | * @access private |
295 | 295 | */ |
296 | 296 | function _elgg_default_widgets_permissions_override($hook, $type, $return, $params) { |
@@ -524,6 +524,7 @@ |
||
524 | 524 | /** |
525 | 525 | * Loads the cache into object's properties |
526 | 526 | * |
527 | + * @param string $cache_file |
|
527 | 528 | * @return void |
528 | 529 | */ |
529 | 530 | protected function _loadCache($cache_file) |
@@ -117,7 +117,6 @@ |
||
117 | 117 | * @param int $timebefore Lower time limit |
118 | 118 | * @param int $timeafter Upper time limit |
119 | 119 | * @param int $object_id GUID of an object |
120 | - * @param str $ip_address The IP address. |
|
121 | 120 | * @return mixed |
122 | 121 | */ |
123 | 122 | function apiadmin_get_usage_log($by_key = '', $handler = '', $request = '', $method = '', $remote_address = '', |
@@ -129,8 +129,7 @@ discard block |
||
129 | 129 | * |
130 | 130 | * @param type $event |
131 | 131 | * @param type $type |
132 | - * @param ElggRelationship $object |
|
133 | - * @return boolean |
|
132 | + * @return boolean|null |
|
134 | 133 | */ |
135 | 134 | function join_group_event($event, $type, $relationship) { |
136 | 135 | |
@@ -192,7 +191,6 @@ discard block |
||
192 | 191 | * |
193 | 192 | * @param type $event |
194 | 193 | * @param type $type |
195 | - * @param type $object |
|
196 | 194 | */ |
197 | 195 | function leave_group_event($event, $type, $params) { |
198 | 196 | $guids = get_all_children_guids($params['group']); |
@@ -269,8 +269,7 @@ |
||
269 | 269 | * of the parent or anything weird like that |
270 | 270 | * |
271 | 271 | * @param type $user ElggUser |
272 | - * @param type $subgroup_guid |
|
273 | - * @param type $parentgroup_guid |
|
272 | + * @param type $subgroup |
|
274 | 273 | */ |
275 | 274 | function can_move_subgroup($subgroup, $parent, $user = NULL) { |
276 | 275 | if (!elgg_instanceof($user, 'user')) { |
@@ -412,6 +412,10 @@ |
||
412 | 412 | /* |
413 | 413 | * Purpose: To sort education and work experience entities by their start date.. called before cmpEndYear so that the list is ordered by both start and end dates. |
414 | 414 | */ |
415 | +/** |
|
416 | + * @param ElggEntity $foo |
|
417 | + * @param ElggEntity $bar |
|
418 | + */ |
|
415 | 419 | function cmpStartDate($foo, $bar) |
416 | 420 | { |
417 | 421 | $a = get_entity($foo); |
@@ -18,7 +18,7 @@ |
||
18 | 18 | * @param string $return_value optional stdout text |
19 | 19 | * @param array $params supplied params |
20 | 20 | * |
21 | - * @return void |
|
21 | + * @return string|null |
|
22 | 22 | */ |
23 | 23 | public static function daily($hook, $type, $return_value, $params) { |
24 | 24 |
@@ -426,6 +426,8 @@ discard block |
||
426 | 426 | /** |
427 | 427 | * Sends mail using the $Sendmail program. |
428 | 428 | * @access private |
429 | + * @param string $header |
|
430 | + * @param string $body |
|
429 | 431 | * @return bool |
430 | 432 | */ |
431 | 433 | function SendmailSend($header, $body) { |
@@ -457,6 +459,8 @@ discard block |
||
457 | 459 | /** |
458 | 460 | * Sends mail using the PHP mail() function. |
459 | 461 | * @access private |
462 | + * @param string $header |
|
463 | + * @param string $body |
|
460 | 464 | * @return bool |
461 | 465 | */ |
462 | 466 | function MailSend($header, $body) { |
@@ -507,6 +511,8 @@ discard block |
||
507 | 511 | * Chris Ryan). Returns bool. Returns false if there is a |
508 | 512 | * bad MAIL FROM, RCPT, or DATA input. |
509 | 513 | * @access private |
514 | + * @param string $header |
|
515 | + * @param string $body |
|
510 | 516 | * @return bool |
511 | 517 | */ |
512 | 518 | function SmtpSend($header, $body) { |
@@ -677,6 +683,7 @@ discard block |
||
677 | 683 | /** |
678 | 684 | * Creates recipient headers. |
679 | 685 | * @access private |
686 | + * @param string $type |
|
680 | 687 | * @return string |
681 | 688 | */ |
682 | 689 | function AddrAppend($type, $addr) { |
@@ -712,6 +719,8 @@ discard block |
||
712 | 719 | * automatically perform wrapping and for quoted-printable. |
713 | 720 | * Original written by philippe. |
714 | 721 | * @access private |
722 | + * @param string $message |
|
723 | + * @param integer $length |
|
715 | 724 | * @return string |
716 | 725 | */ |
717 | 726 | function WrapText($message, $length, $qp_mode = false) { |
@@ -1040,6 +1049,9 @@ discard block |
||
1040 | 1049 | /** |
1041 | 1050 | * Returns the start of a message boundary. |
1042 | 1051 | * @access private |
1052 | + * @param string $charSet |
|
1053 | + * @param string $contentType |
|
1054 | + * @param string $encoding |
|
1043 | 1055 | */ |
1044 | 1056 | function GetBoundary($boundary, $charSet, $contentType, $encoding) { |
1045 | 1057 | $result = ''; |
@@ -1094,6 +1106,10 @@ discard block |
||
1094 | 1106 | * @access private |
1095 | 1107 | * @return string |
1096 | 1108 | */ |
1109 | + |
|
1110 | + /** |
|
1111 | + * @param string $name |
|
1112 | + */ |
|
1097 | 1113 | function HeaderLine($name, $value) { |
1098 | 1114 | return $name . ': ' . $value . $this->LE; |
1099 | 1115 | } |
@@ -1101,6 +1117,7 @@ discard block |
||
1101 | 1117 | /** |
1102 | 1118 | * Returns a formatted mail line. |
1103 | 1119 | * @access private |
1120 | + * @param string $value |
|
1104 | 1121 | * @return string |
1105 | 1122 | */ |
1106 | 1123 | function TextLine($value) { |
@@ -1259,6 +1276,7 @@ discard block |
||
1259 | 1276 | /** |
1260 | 1277 | * Encode a header string to best of Q, B, quoted or none. |
1261 | 1278 | * @access private |
1279 | + * @param string $str |
|
1262 | 1280 | * @return string |
1263 | 1281 | */ |
1264 | 1282 | function EncodeHeader ($str, $position = 'text') { |
@@ -1596,6 +1614,7 @@ discard block |
||
1596 | 1614 | * Adds the error message to the error container. |
1597 | 1615 | * Returns void. |
1598 | 1616 | * @access private |
1617 | + * @param string $msg |
|
1599 | 1618 | * @return void |
1600 | 1619 | */ |
1601 | 1620 | function SetError($msg) { |
@@ -1623,6 +1642,7 @@ discard block |
||
1623 | 1642 | * PHP 4.1.0+ as well as older versions. Returns an empty string |
1624 | 1643 | * if nothing is found. |
1625 | 1644 | * @access private |
1645 | + * @param string $varName |
|
1626 | 1646 | * @return mixed |
1627 | 1647 | */ |
1628 | 1648 | function ServerVar($varName) { |
@@ -1663,6 +1683,7 @@ discard block |
||
1663 | 1683 | /** |
1664 | 1684 | * Returns a message in the appropriate language. |
1665 | 1685 | * @access private |
1686 | + * @param string $key |
|
1666 | 1687 | * @return string |
1667 | 1688 | */ |
1668 | 1689 | function Lang($key) { |
@@ -1708,6 +1729,7 @@ discard block |
||
1708 | 1729 | /** |
1709 | 1730 | * Evaluates the message and returns modifications for inline images and backgrounds |
1710 | 1731 | * @access public |
1732 | + * @param string $message |
|
1711 | 1733 | * @return $message |
1712 | 1734 | */ |
1713 | 1735 | function MsgHTML($message,$basedir='') { |
@@ -1745,7 +1767,7 @@ discard block |
||
1745 | 1767 | /** |
1746 | 1768 | * Gets the mime type of the embedded or inline image |
1747 | 1769 | * @access private |
1748 | - * @return mime type of ext |
|
1770 | + * @return string type of ext |
|
1749 | 1771 | */ |
1750 | 1772 | function _mime_types($ext = '') { |
1751 | 1773 | $mimes = array( |