@@ -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( |
@@ -724,6 +724,9 @@ |
||
724 | 724 | $this->message = $this->StripSlashes($_POST['message']); |
725 | 725 | } |
726 | 726 | |
727 | + /** |
|
728 | + * @param string $error |
|
729 | + */ |
|
727 | 730 | function add_error($error) |
728 | 731 | { |
729 | 732 | array_push($this->errors,$error); |
@@ -80,6 +80,10 @@ |
||
80 | 80 | }//else |
81 | 81 | return $ret; |
82 | 82 | } |
83 | + |
|
84 | + /** |
|
85 | + * @param string $answer |
|
86 | + */ |
|
83 | 87 | function Md5CaptchaAnswer($answer) |
84 | 88 | { |
85 | 89 | return md5($this->GetKey().$answer); |
@@ -99,7 +99,7 @@ |
||
99 | 99 | |
100 | 100 | /** |
101 | 101 | * @param $user_guid user's guid |
102 | - * @return query for all the content that the user is associated with |
|
102 | + * @return string for all the content that the user is associated with |
|
103 | 103 | */ |
104 | 104 | function get_content($user_guid) { |
105 | 105 | $dbprefix = elgg_get_config('dbprefix'); |
@@ -6,6 +6,7 @@ discard block |
||
6 | 6 | * @param integer $entity_guid_static |
7 | 7 | * @param integer $entity_guid |
8 | 8 | * |
9 | + * @return integer |
|
9 | 10 | */ |
10 | 11 | function get_forum_in_group($entity_guid_static, $entity_guid) { |
11 | 12 | $entity = get_entity($entity_guid); |
@@ -159,7 +160,7 @@ discard block |
||
159 | 160 | * @param ElggEntity $entity |
160 | 161 | * @param ElggUser $send_to |
161 | 162 | * @param string $entity_url (default value empty) |
162 | - * @return Success true/false |
|
163 | + * @return boolean true/false |
|
163 | 164 | */ |
164 | 165 | function create_digest($invoked_by, $subtype, $entity, $send_to, $entity_url = '') { |
165 | 166 |
@@ -132,7 +132,7 @@ discard block |
||
132 | 132 | * @param mixed $value The current value of the plugin hook |
133 | 133 | * @param mixed $params Data passed from the trigger |
134 | 134 | * |
135 | - * @return mixed if not null, this will be the new value of the plugin hook |
|
135 | + * @return boolean if not null, this will be the new value of the plugin hook |
|
136 | 136 | */ |
137 | 137 | function minor_save_hook_handler($hook, $type, $value, $params) { |
138 | 138 | |
@@ -542,7 +542,6 @@ discard block |
||
542 | 542 | /** |
543 | 543 | * returns the headers for ical |
544 | 544 | * |
545 | - * @param string $type_event |
|
546 | 545 | * @param ElggObject $event |
547 | 546 | * @param string $start_date |
548 | 547 | * @param string $end_date |
@@ -1357,6 +1356,9 @@ discard block |
||
1357 | 1356 | } |
1358 | 1357 | |
1359 | 1358 | |
1359 | +/** |
|
1360 | + * @param string $error_message |
|
1361 | + */ |
|
1360 | 1362 | function notification_logging($error_message) { |
1361 | 1363 | // logging mechanism |
1362 | 1364 | if (elgg_is_active_plugin('wet4')) { |
@@ -1407,8 +1409,6 @@ discard block |
||
1407 | 1409 | * run crontab, retrieve users, send digest, reset timer (update timestamp) |
1408 | 1410 | * |
1409 | 1411 | * @param string $hook The name of the plugin hook |
1410 | - * @param string $type The type of the plugin hook |
|
1411 | - * @param mixed $value The current value of the plugin hook |
|
1412 | 1412 | * @param mixed $params Data passed from the trigger |
1413 | 1413 | */ |
1414 | 1414 | function cp_digest_weekly_cron_handler($hook, $entity_type, $return_value, $params) { |
@@ -1674,7 +1674,6 @@ discard block |
||
1674 | 1674 | * |
1675 | 1675 | * @param string $hook The name of the plugin hook |
1676 | 1676 | * @param string $type The type of the plugin hook |
1677 | - * @param mixed $value The current value of the plugin hook |
|
1678 | 1677 | * @param mixed $params Data passed from the trigger |
1679 | 1678 | */ |
1680 | 1679 | function cpn_email_handler_hook($hook, $type, $notification, $params) { |
@@ -1688,7 +1687,6 @@ discard block |
||
1688 | 1687 | * |
1689 | 1688 | * @param string $hook The name of the plugin hook |
1690 | 1689 | * @param string $type The type of the plugin hook |
1691 | - * @param mixed $value The current value of the plugin hook |
|
1692 | 1690 | * @param mixed $params Data passed from the trigger |
1693 | 1691 | * |
1694 | 1692 | * @return mixed if not null, this will be the new value of the plugin hook |
@@ -9,6 +9,11 @@ |
||
9 | 9 | require_once($CONFIG->pluginspath.'event_calendar/models/model.php'); |
10 | 10 | |
11 | 11 | if(!function_exists('getLastDayOfMonth')){ |
12 | + |
|
13 | + /** |
|
14 | + * @param string $month |
|
15 | + * @param string $year |
|
16 | + */ |
|
12 | 17 | function getLastDayOfMonth($month,$year) { |
13 | 18 | return idate('d', mktime(0, 0, 0, ($month + 1), 0, $year)); |
14 | 19 | } |
@@ -52,7 +52,7 @@ |
||
52 | 52 | * Recursively list through a directory tree producing a hash of all installed files |
53 | 53 | * |
54 | 54 | * @param starting dir $dir |
55 | - * @param buffer $buffer |
|
55 | + * @param string $dir |
|
56 | 56 | */ |
57 | 57 | function diagnostics_md5_dir($dir) { |
58 | 58 | $extensions_allowed = array('.php', '.js', '.css'); |
@@ -524,9 +524,11 @@ discard block |
||
524 | 524 | /** |
525 | 525 | * Register a function to define specific configuration of an entity in solr |
526 | 526 | * |
527 | - * @param type $type - the entity type |
|
528 | - * @param type $subtype - the entity subtype |
|
529 | - * @param type $function - the function to call for updating an entity in solr |
|
527 | + * @param string $type - the entity type |
|
528 | + * @param type string - the entity subtype |
|
529 | + * @param type string - the function to call for updating an entity in solr |
|
530 | + * @param string $subtype |
|
531 | + * @param string $function |
|
530 | 532 | */ |
531 | 533 | function elgg_solr_register_solr_entity_type($type, $subtype, $function) { |
532 | 534 | $solr_entities = elgg_get_config('solr_entities'); |
@@ -779,6 +781,9 @@ discard block |
||
779 | 781 | return true; |
780 | 782 | } |
781 | 783 | |
784 | +/** |
|
785 | + * @param string $message |
|
786 | + */ |
|
782 | 787 | function elgg_solr_debug_log($message) { |
783 | 788 | error_log($message); |
784 | 789 | } |
@@ -1020,6 +1025,10 @@ discard block |
||
1020 | 1025 | return $stats; |
1021 | 1026 | } |
1022 | 1027 | |
1028 | +/** |
|
1029 | + * @param integer $starttime |
|
1030 | + * @param integer $endtime |
|
1031 | + */ |
|
1023 | 1032 | function elgg_solr_get_system_count($options, $starttime, $endtime) { |
1024 | 1033 | $options['wheres'] = array( |
1025 | 1034 | "e.time_created >= {$starttime}", |