@@ -107,7 +107,7 @@ |
||
| 107 | 107 | * |
| 108 | 108 | * @param integer $pageid PageID to get offsets for |
| 109 | 109 | * |
| 110 | - * @return array First and last offsets |
|
| 110 | + * @return integer[] First and last offsets |
|
| 111 | 111 | * @access public |
| 112 | 112 | */ |
| 113 | 113 | function getPageRangeByPageId($pageid = null) |
@@ -147,6 +147,7 @@ discard block |
||
| 147 | 147 | * the two files do not match, and likewise that the last lines do not |
| 148 | 148 | * match. The caller must trim matching lines from the beginning and end |
| 149 | 149 | * of the portions it is going to specify. |
| 150 | + * @param double $nchunks |
|
| 150 | 151 | */ |
| 151 | 152 | function _diag ($xoff, $xlim, $yoff, $ylim, $nchunks) |
| 152 | 153 | { |
@@ -267,6 +268,10 @@ discard block |
||
| 267 | 268 | * |
| 268 | 269 | * Note that XLIM, YLIM are exclusive bounds. All line numbers are |
| 269 | 270 | * origin-0 and discarded lines are not counted. |
| 271 | + * @param integer $xoff |
|
| 272 | + * @param integer $xlim |
|
| 273 | + * @param integer $yoff |
|
| 274 | + * @param integer $ylim |
|
| 270 | 275 | */ |
| 271 | 276 | function _compareseq ($xoff, $xlim, $yoff, $ylim) |
| 272 | 277 | { |
@@ -143,6 +143,12 @@ discard block |
||
| 143 | 143 | return $output . $this->_endDiff(); |
| 144 | 144 | } |
| 145 | 145 | |
| 146 | + /** |
|
| 147 | + * @param integer $xbeg |
|
| 148 | + * @param integer $xlen |
|
| 149 | + * @param integer $ybeg |
|
| 150 | + * @param integer $ylen |
|
| 151 | + */ |
|
| 146 | 152 | function _block($xbeg, $xlen, $ybeg, $ylen, &$edits) |
| 147 | 153 | { |
| 148 | 154 | $output = $this->_startBlock($this->_blockHeader($xbeg, $xlen, $ybeg, $ylen)); |
@@ -199,6 +205,9 @@ discard block |
||
| 199 | 205 | return $xbeg . ($xlen ? ($ylen ? 'c' : 'd') : 'a') . $ybeg; |
| 200 | 206 | } |
| 201 | 207 | |
| 208 | + /** |
|
| 209 | + * @param string $header |
|
| 210 | + */ |
|
| 202 | 211 | function _startBlock($header) |
| 203 | 212 | { |
| 204 | 213 | return $header . "\n"; |
@@ -74,6 +74,9 @@ discard block |
||
| 74 | 74 | return $header; |
| 75 | 75 | } |
| 76 | 76 | |
| 77 | + /** |
|
| 78 | + * @param string[] $lines |
|
| 79 | + */ |
|
| 77 | 80 | function _lines($lines, $prefix = ' ', $encode = true) |
| 78 | 81 | { |
| 79 | 82 | if ($encode) { |
@@ -141,6 +144,9 @@ discard block |
||
| 141 | 144 | return str_replace($nl, "\n", $renderer->render($diff)) . "\n"; |
| 142 | 145 | } |
| 143 | 146 | |
| 147 | + /** |
|
| 148 | + * @param string $string |
|
| 149 | + */ |
|
| 144 | 150 | function _splitOnWords($string, $newlineEscape = "\n") |
| 145 | 151 | { |
| 146 | 152 | // Ignore \0; otherwise the while loop will never finish. |
@@ -180,6 +180,7 @@ discard block |
||
| 180 | 180 | * @access private |
| 181 | 181 | * @param string Login |
| 182 | 182 | * @param integer Key |
| 183 | + * @param integer $key |
|
| 183 | 184 | * @return string |
| 184 | 185 | */ |
| 185 | 186 | function _xor($login, $key) |
@@ -208,6 +209,7 @@ discard block |
||
| 208 | 209 | * @access private |
| 209 | 210 | * @param string Login |
| 210 | 211 | * @param integer Key |
| 212 | + * @param integer $key |
|
| 211 | 213 | * @return string |
| 212 | 214 | */ |
| 213 | 215 | function _rotx($login, $key) |
@@ -241,6 +243,7 @@ discard block |
||
| 241 | 243 | * @access private |
| 242 | 244 | * @param string Login |
| 243 | 245 | * @param integer Key |
| 246 | + * @param integer $key |
|
| 244 | 247 | * @return string |
| 245 | 248 | */ |
| 246 | 249 | function _rotxpp($login, $key) |
@@ -274,6 +277,7 @@ discard block |
||
| 274 | 277 | * @access private |
| 275 | 278 | * @param string Login |
| 276 | 279 | * @param integer Key |
| 280 | + * @param integer $key |
|
| 277 | 281 | * @return string |
| 278 | 282 | */ |
| 279 | 283 | function _rotxmm($login, $key) |
@@ -306,6 +310,7 @@ discard block |
||
| 306 | 310 | * @access private |
| 307 | 311 | * @param string Login |
| 308 | 312 | * @param integer Key |
| 313 | + * @param integer $key |
|
| 309 | 314 | * @return string |
| 310 | 315 | */ |
| 311 | 316 | function _asciiRotx($login, $key) |
@@ -340,6 +345,7 @@ discard block |
||
| 340 | 345 | * @access private |
| 341 | 346 | * @param string Login |
| 342 | 347 | * @param integer Key |
| 348 | + * @param integer $key |
|
| 343 | 349 | * @return string |
| 344 | 350 | */ |
| 345 | 351 | function _asciiRotxpp($login, $key) |
@@ -374,6 +380,7 @@ discard block |
||
| 374 | 380 | * @access private |
| 375 | 381 | * @param string Login |
| 376 | 382 | * @param integer Key |
| 383 | + * @param integer $key |
|
| 377 | 384 | * @return string |
| 378 | 385 | */ |
| 379 | 386 | function _asciiRotxmm($login, $key) |
@@ -430,6 +437,7 @@ discard block |
||
| 430 | 437 | * |
| 431 | 438 | * @access private |
| 432 | 439 | * @param integer Length of the password |
| 440 | + * @param integer $length |
|
| 433 | 441 | * @return string Returns the password |
| 434 | 442 | */ |
| 435 | 443 | function _createPronounceable($length) |
@@ -475,6 +483,8 @@ discard block |
||
| 475 | 483 | * @param string Character which could be use in the |
| 476 | 484 | * unpronounceable password ex : 'ABCDEFG' |
| 477 | 485 | * or numeric, alphabetical or alphanumeric. |
| 486 | + * @param integer $length |
|
| 487 | + * @param string $chars |
|
| 478 | 488 | * @return string Returns the password |
| 479 | 489 | */ |
| 480 | 490 | function _createUnpronounceable($length, $chars) |
@@ -891,6 +891,7 @@ discard block |
||
| 891 | 891 | /** |
| 892 | 892 | * Creates recipient headers. |
| 893 | 893 | * @access public |
| 894 | + * @param string $type |
|
| 894 | 895 | * @return string |
| 895 | 896 | */ |
| 896 | 897 | public function AddrAppend($type, $addr) { |
@@ -1258,6 +1259,9 @@ discard block |
||
| 1258 | 1259 | /** |
| 1259 | 1260 | * Returns the start of a message boundary. |
| 1260 | 1261 | * @access private |
| 1262 | + * @param string $charSet |
|
| 1263 | + * @param string $contentType |
|
| 1264 | + * @param string $encoding |
|
| 1261 | 1265 | */ |
| 1262 | 1266 | private function GetBoundary($boundary, $charSet, $contentType, $encoding) { |
| 1263 | 1267 | $result = ''; |
@@ -1311,6 +1315,7 @@ discard block |
||
| 1311 | 1315 | /** |
| 1312 | 1316 | * Returns a formatted header line. |
| 1313 | 1317 | * @access public |
| 1318 | + * @param string $name |
|
| 1314 | 1319 | * @return string |
| 1315 | 1320 | */ |
| 1316 | 1321 | public function HeaderLine($name, $value) { |
@@ -1320,6 +1325,7 @@ discard block |
||
| 1320 | 1325 | /** |
| 1321 | 1326 | * Returns a formatted mail line. |
| 1322 | 1327 | * @access public |
| 1328 | + * @param string $value |
|
| 1323 | 1329 | * @return string |
| 1324 | 1330 | */ |
| 1325 | 1331 | public function TextLine($value) { |
@@ -1521,6 +1527,7 @@ discard block |
||
| 1521 | 1527 | /** |
| 1522 | 1528 | * Encode a header string to best (shortest) of Q, B, quoted or none. |
| 1523 | 1529 | * @access public |
| 1530 | + * @param string $str |
|
| 1524 | 1531 | * @return string |
| 1525 | 1532 | */ |
| 1526 | 1533 | public function EncodeHeader($str, $position = 'text') { |
@@ -1647,7 +1654,6 @@ discard block |
||
| 1647 | 1654 | * Encode string to quoted-printable. |
| 1648 | 1655 | * Only uses standard PHP, slow, but will always work |
| 1649 | 1656 | * @access public |
| 1650 | - * @param string $string the text to encode |
|
| 1651 | 1657 | * @param integer $line_max Number of chars allowed on a line before wrapping |
| 1652 | 1658 | * @return string |
| 1653 | 1659 | */ |
@@ -1917,6 +1923,7 @@ discard block |
||
| 1917 | 1923 | /** |
| 1918 | 1924 | * Adds the error message to the error container. |
| 1919 | 1925 | * @access protected |
| 1926 | + * @param string $msg |
|
| 1920 | 1927 | * @return void |
| 1921 | 1928 | */ |
| 1922 | 1929 | protected function SetError($msg) { |
@@ -1966,6 +1973,7 @@ discard block |
||
| 1966 | 1973 | /** |
| 1967 | 1974 | * Returns a message in the appropriate language. |
| 1968 | 1975 | * @access private |
| 1976 | + * @param string $key |
|
| 1969 | 1977 | * @return string |
| 1970 | 1978 | */ |
| 1971 | 1979 | private function Lang($key) { |
@@ -1992,6 +2000,7 @@ discard block |
||
| 1992 | 2000 | /** |
| 1993 | 2001 | * Changes every end of line from CR or LF to CRLF. |
| 1994 | 2002 | * @access private |
| 2003 | + * @param string $str |
|
| 1995 | 2004 | * @return string |
| 1996 | 2005 | */ |
| 1997 | 2006 | private function FixEOL($str) { |
@@ -2203,8 +2212,6 @@ discard block |
||
| 2203 | 2212 | * Set the private key file and password to sign the message. |
| 2204 | 2213 | * |
| 2205 | 2214 | * @access public |
| 2206 | - * @param string $key_filename Parameter File Name |
|
| 2207 | - * @param string $key_pass Password for private key |
|
| 2208 | 2215 | */ |
| 2209 | 2216 | public function DKIM_QP($txt) { |
| 2210 | 2217 | $tmp=""; |
@@ -2318,6 +2325,11 @@ discard block |
||
| 2318 | 2325 | return "X-PHPMAILER-DKIM: phpmailer.worxware.com\r\n".$dkimhdrs.$signed."\r\n"; |
| 2319 | 2326 | } |
| 2320 | 2327 | |
| 2328 | + /** |
|
| 2329 | + * @param integer $isSent |
|
| 2330 | + * @param string $subject |
|
| 2331 | + * @param string $body |
|
| 2332 | + */ |
|
| 2321 | 2333 | protected function doCallback($isSent,$to,$cc,$bcc,$subject,$body) { |
| 2322 | 2334 | if (!empty($this->action_function) && function_exists($this->action_function)) { |
| 2323 | 2335 | $params = array($isSent,$to,$cc,$bcc,$subject,$body); |
@@ -192,7 +192,7 @@ |
||
| 192 | 192 | * @param string $host |
| 193 | 193 | * @param integer $port |
| 194 | 194 | * @param integer $tval |
| 195 | - * @return boolean |
|
| 195 | + * @return boolean|null |
|
| 196 | 196 | */ |
| 197 | 197 | public function Connect ($host, $port = false, $tval = 30) { |
| 198 | 198 | // Are we already connected? |
@@ -321,6 +321,7 @@ discard block |
||
| 321 | 321 | * SMTP CODE FAILURE: 451,554 |
| 322 | 322 | * SMTP CODE ERROR : 500,501,503,421 |
| 323 | 323 | * @access public |
| 324 | + * @param string $msg_data |
|
| 324 | 325 | * @return bool |
| 325 | 326 | */ |
| 326 | 327 | public function Data($msg_data) {
|
@@ -488,6 +489,8 @@ discard block |
||
| 488 | 489 | /** |
| 489 | 490 | * Sends a HELO/EHLO command. |
| 490 | 491 | * @access private |
| 492 | + * @param string $hello |
|
| 493 | + * @param string $host |
|
| 491 | 494 | * @return bool |
| 492 | 495 | */ |
| 493 | 496 | private function SendHello($hello, $host) {
|
@@ -528,6 +531,7 @@ discard block |
||
| 528 | 531 | * SMTP CODE SUCCESS: 552,451,452 |
| 529 | 532 | * SMTP CODE SUCCESS: 500,501,421 |
| 530 | 533 | * @access public |
| 534 | + * @param string $from |
|
| 531 | 535 | * @return bool |
| 532 | 536 | */ |
| 533 | 537 | public function Mail($from) {
|
@@ -742,6 +742,7 @@ discard block |
||
| 742 | 742 | * CRYPT_DES_MODE_ECB or CRYPT_DES_MODE_CBC. If not explictly set, CRYPT_DES_MODE_CBC will be used. |
| 743 | 743 | * |
| 744 | 744 | * @param optional Integer $mode |
| 745 | + * @param integer $mode |
|
| 745 | 746 | * @return Crypt_DES |
| 746 | 747 | * @access public |
| 747 | 748 | */ |
@@ -1445,6 +1446,7 @@ discard block |
||
| 1445 | 1446 | * |
| 1446 | 1447 | * @see Crypt_DES::_unpad() |
| 1447 | 1448 | * @access private |
| 1449 | + * @param string $text |
|
| 1448 | 1450 | */ |
| 1449 | 1451 | function _pad($text) |
| 1450 | 1452 | { |