@@ -124,6 +124,7 @@ |
||
124 | 124 | /** |
125 | 125 | * Set the disposition of the attachment (usually inline or attachment) |
126 | 126 | * @param string The value to use in the Content-Disposition field |
127 | + * @param string $disposition |
|
127 | 128 | */ |
128 | 129 | public function setDisposition($disposition) |
129 | 130 | { |
@@ -33,7 +33,7 @@ discard block |
||
33 | 33 | /** |
34 | 34 | * Retreive an instance of the encoder as a singleton. |
35 | 35 | * New instances are never ever needed since it's monostatic. |
36 | - * @return Message_Encoder |
|
36 | + * @return Swift_Message_Encoder |
|
37 | 37 | */ |
38 | 38 | public static function instance() |
39 | 39 | { |
@@ -225,7 +225,7 @@ discard block |
||
225 | 225 | } |
226 | 226 | /** |
227 | 227 | * Return the QP encoded version of a string with no breaks |
228 | - * @param string The input to encode |
|
228 | + * @param string string input to encode |
|
229 | 229 | * @param boolean True if the data we're encoding is binary |
230 | 230 | * @return string |
231 | 231 | */ |
@@ -281,6 +281,7 @@ discard block |
||
281 | 281 | * @param string Input data to encode |
282 | 282 | * @param int Max line length |
283 | 283 | * @param string The line ending |
284 | + * @param string $data |
|
284 | 285 | * @return string |
285 | 286 | */ |
286 | 287 | public function encode7Bit($data, $chunk=76, $le="\r\n") |
@@ -309,6 +310,7 @@ discard block |
||
309 | 310 | * @param string Input data to encode |
310 | 311 | * @param int Maximum line length |
311 | 312 | * @param string The line ending |
313 | + * @param string $data |
|
312 | 314 | * @return string |
313 | 315 | */ |
314 | 316 | public function encode8Bit($data, $chunk=76, $le="\r\n") |
@@ -369,7 +371,7 @@ discard block |
||
369 | 371 | /** |
370 | 372 | * Detect if a string contains multi-byte non-ascii chars that fall in the UTF-8 ranges |
371 | 373 | * @param string Data to detect UTF-8 sequences in |
372 | - * @return boolean |
|
374 | + * @return integer |
|
373 | 375 | */ |
374 | 376 | public function isUTF8($data) |
375 | 377 | { |
@@ -408,6 +410,7 @@ discard block |
||
408 | 410 | /** |
409 | 411 | * If the characters fall exclusively in the 7bit ascii range, return true |
410 | 412 | * @param string Input to check |
413 | + * @param string $data |
|
411 | 414 | * @return boolean |
412 | 415 | */ |
413 | 416 | public function is7BitAscii($data) |
@@ -440,6 +443,8 @@ discard block |
||
440 | 443 | * SMTP requires the CRLF be used, but using sendmail in -t mode uses LF |
441 | 444 | * This method also escapes dots on a start of line to avoid injection |
442 | 445 | * @param string The data to fix |
446 | + * @param string $data |
|
447 | + * @param string $le |
|
443 | 448 | * @return string |
444 | 449 | */ |
445 | 450 | protected function fixLE($data, $le) |
@@ -448,6 +453,11 @@ discard block |
||
448 | 453 | if ($le != "\n") $data = str_replace("\n", $le, $data); |
449 | 454 | return $data = str_replace($le . ".", $le . "..", $data); |
450 | 455 | } |
456 | + |
|
457 | + /** |
|
458 | + * @param integer $value |
|
459 | + * @param integer $factor |
|
460 | + */ |
|
451 | 461 | protected function getHcf($value, $factor) |
452 | 462 | { |
453 | 463 | return ($value - ($value % $factor)); |
@@ -206,6 +206,7 @@ discard block |
||
206 | 206 | /** |
207 | 207 | * Set the charset used in the headers |
208 | 208 | * @param string The charset name |
209 | + * @param string $charset |
|
209 | 210 | */ |
210 | 211 | public function setCharset($charset) |
211 | 212 | { |
@@ -230,6 +231,7 @@ discard block |
||
230 | 231 | * - Base64 |
231 | 232 | * NOTE: Q, QP, Quoted-Printable are all the same; as are B and Base64 |
232 | 233 | * @param string The encoding format to use |
234 | + * @param string $encoding |
|
233 | 235 | * @return boolean |
234 | 236 | */ |
235 | 237 | public function setEncoding($encoding) |
@@ -293,6 +295,7 @@ discard block |
||
293 | 295 | * Check if a header has a given attribute applied to it |
294 | 296 | * @param string The name of the main header |
295 | 297 | * @param string The name of the attribute |
298 | + * @param string $name |
|
296 | 299 | * @return boolean |
297 | 300 | */ |
298 | 301 | public function hasAttribute($header, $name) |
@@ -312,6 +315,8 @@ discard block |
||
312 | 315 | * Get the value for a given attribute on a given header |
313 | 316 | * @param string The name of the main header |
314 | 317 | * @param string The name of the attribute |
318 | + * @param string $header |
|
319 | + * @param string $name |
|
315 | 320 | * @return string |
316 | 321 | * @throws Swift_Message_MimeException If no header is set |
317 | 322 | */ |
@@ -483,6 +488,8 @@ discard block |
||
483 | 488 | * and testing to get this working rock solid. |
484 | 489 | * @param string The header built without attributes |
485 | 490 | * @param string The lowercase name of the header |
491 | + * @param string $header_line |
|
492 | + * @param string $header_name |
|
486 | 493 | * @return string |
487 | 494 | * @throws Swift_Message_MimeException If no such header exists or there are no attributes |
488 | 495 | */ |
@@ -126,6 +126,7 @@ discard block |
||
126 | 126 | * Replace the current headers with new ones |
127 | 127 | * DO NOT DO THIS UNLESS YOU KNOW WHAT YOU'RE DOING! |
128 | 128 | * @param Swift_Message_Headers The headers to use |
129 | + * @param Swift_Message_Headers $headers |
|
129 | 130 | */ |
130 | 131 | public function setHeaders($headers) |
131 | 132 | { |
@@ -134,6 +135,7 @@ discard block |
||
134 | 135 | /** |
135 | 136 | * Set the line ending character to use |
136 | 137 | * @param string The line ending sequence |
138 | + * @param string $le |
|
137 | 139 | * @return boolean |
138 | 140 | */ |
139 | 141 | public function setLE($le) |
@@ -377,6 +379,7 @@ discard block |
||
377 | 379 | /** |
378 | 380 | * Set the size at which lines wrap around (includes the CRLF) |
379 | 381 | * @param int The length of a line |
382 | + * @param integer $len |
|
380 | 383 | */ |
381 | 384 | public function setLineWrap($len) |
382 | 385 | { |
@@ -64,7 +64,7 @@ |
||
64 | 64 | } |
65 | 65 | /** |
66 | 66 | * Alias for getData() |
67 | - * @return mixed The document body |
|
67 | + * @return string The document body |
|
68 | 68 | */ |
69 | 69 | public function getBody() |
70 | 70 | { |
@@ -55,6 +55,7 @@ discard block |
||
55 | 55 | /** |
56 | 56 | * Add some bytes to the running totals for incoming bandwidth |
57 | 57 | * @param int Bytes in |
58 | + * @param integer $num |
|
58 | 59 | */ |
59 | 60 | public function addBytesIn($num) |
60 | 61 | { |
@@ -64,6 +65,7 @@ discard block |
||
64 | 65 | /** |
65 | 66 | * Add some bytes to the running totals for outgoing bandwidth |
66 | 67 | * @param int Bytes out |
68 | + * @param integer $num |
|
67 | 69 | */ |
68 | 70 | public function addBytesOut($num) |
69 | 71 | { |
@@ -90,6 +92,7 @@ discard block |
||
90 | 92 | * Set the total number of bytes received. |
91 | 93 | * Can be used to reset the counters at runtime. |
92 | 94 | * @param int The bytes in |
95 | + * @param double $num |
|
93 | 96 | */ |
94 | 97 | public function setBytesIn($num) |
95 | 98 | { |
@@ -99,6 +102,7 @@ discard block |
||
99 | 102 | * Set the total number of bytes sent. |
100 | 103 | * Can be used to reset the counters at runtime. |
101 | 104 | * @param int The bytes out |
105 | + * @param double $num |
|
102 | 106 | */ |
103 | 107 | public function setBytesOut($num) |
104 | 108 | { |
@@ -52,6 +52,7 @@ |
||
52 | 52 | /** |
53 | 53 | * Set the number of emails to send before a connection rotation is tried |
54 | 54 | * @param int Number of emails |
55 | + * @param integer $threshold |
|
55 | 56 | */ |
56 | 57 | public function setThreshold($threshold) |
57 | 58 | { |
@@ -95,6 +95,7 @@ discard block |
||
95 | 95 | /** |
96 | 96 | * Check if the body can be replaced in the given mime type. |
97 | 97 | * @param string The mime type |
98 | + * @param string|false $type |
|
98 | 99 | * @return boolean |
99 | 100 | */ |
100 | 101 | public function isPermittedType($type) |
@@ -184,6 +185,7 @@ discard block |
||
184 | 185 | * Perform a str_replace() over the given value. |
185 | 186 | * @param array The list of replacements as (search => replacement) |
186 | 187 | * @param string The string to replace |
188 | + * @param string $value |
|
187 | 189 | * @return string |
188 | 190 | */ |
189 | 191 | protected function replace($replacements, $value) |
@@ -221,6 +221,7 @@ |
||
221 | 221 | * Returns an array with indexes "attributes" and "extensions". |
222 | 222 | * Each element is an array listing the values within it. |
223 | 223 | * @param string The name of the tag |
224 | + * @param string $tag |
|
224 | 225 | * @return array |
225 | 226 | */ |
226 | 227 | public function getTagDefinition($tag) |