@@ -119,6 +119,7 @@ discard block |
||
119 | 119 | /** |
120 | 120 | * Set an error message |
121 | 121 | * @param string Error message |
122 | + * @param string $msg |
|
122 | 123 | */ |
123 | 124 | public function setError($msg) |
124 | 125 | { |
@@ -365,7 +366,7 @@ discard block |
||
365 | 366 | /** |
366 | 367 | * Get a reference to the plugin identified by $name |
367 | 368 | * @param string the ID of the plugin |
368 | - * @return Swift_Events_Listener |
|
369 | + * @return Swift_Event_Listener|null |
|
369 | 370 | */ |
370 | 371 | public function getPlugin($name) |
371 | 372 | { |
@@ -428,6 +429,7 @@ discard block |
||
428 | 429 | /** |
429 | 430 | * Turn a string representation of an email address into a Swift_Address object |
430 | 431 | * @paramm string The email address |
432 | + * @param string $string |
|
431 | 433 | * @return Swift_Address |
432 | 434 | */ |
433 | 435 | public function stringToAddress($string) |
@@ -604,6 +606,7 @@ discard block |
||
604 | 606 | * Add recipients to the email |
605 | 607 | * @param mixed Address(es) |
606 | 608 | * @param string Recipient type (To, Cc, Bcc) |
609 | + * @param string $type |
|
607 | 610 | * @return boolean |
608 | 611 | */ |
609 | 612 | protected function addRecipients($address, $type) |
@@ -159,6 +159,7 @@ discard block |
||
159 | 159 | * Send a new type of event to all objects which are listening for it |
160 | 160 | * @param Swift_Events The event to send |
161 | 161 | * @param string The type of event |
162 | + * @param string $type |
|
162 | 163 | */ |
163 | 164 | public function notifyListeners($e, $type) |
164 | 165 | { |
@@ -176,6 +177,7 @@ discard block |
||
176 | 177 | /** |
177 | 178 | * Check if an option flag has been set |
178 | 179 | * @param string Option name |
180 | + * @param integer $option |
|
179 | 181 | * @return boolean |
180 | 182 | */ |
181 | 183 | public function hasOption($option) |
@@ -202,6 +204,7 @@ discard block |
||
202 | 204 | /** |
203 | 205 | * Set the FQDN of this server as it will identify itself |
204 | 206 | * @param string The FQDN of the server |
207 | + * @param string|boolean $name |
|
205 | 208 | */ |
206 | 209 | public function setDomain($name) |
207 | 210 | { |
@@ -237,6 +240,7 @@ discard block |
||
237 | 240 | * Throws an exception if the response code wanted does not match the one returned |
238 | 241 | * @param Swift_Event_ResponseEvent The full response from the service |
239 | 242 | * @param int The 3 digit response code wanted |
243 | + * @param integer $codes |
|
240 | 244 | * @throws Swift_BadResponseException If the code does not match |
241 | 245 | */ |
242 | 246 | protected function assertCorrectResponse(Swift_Events_ResponseEvent $response, $codes) |
@@ -282,6 +286,7 @@ discard block |
||
282 | 286 | * Execute a command against the service and get the response |
283 | 287 | * @param string The command to execute (leave off any CRLF!!!) |
284 | 288 | * @param int The code to check for in the response, if any. -1 indicates that no response is wanted. |
289 | + * @param integer $code |
|
285 | 290 | * @return Swift_Events_ResponseEvent The server's response (could be multiple lines) |
286 | 291 | * @throws Swift_ConnectionException If a code was expected but does not match the one returned |
287 | 292 | */ |
@@ -479,6 +484,7 @@ discard block |
||
479 | 484 | * @param Swift_Message The message to send (leave out the recipient headers unless you are deliberately overriding them) |
480 | 485 | * @param Swift_RecipientList The addresses to send to |
481 | 486 | * @param Swift_Address The address the mail is from (sender) |
487 | + * @param Swift_Address $from |
|
482 | 488 | * @return int The number of successful recipients |
483 | 489 | */ |
484 | 490 | public function batchSend(Swift_Message $message, Swift_RecipientList $to, $from) |
@@ -41,7 +41,7 @@ |
||
41 | 41 | * Returns false on failure |
42 | 42 | * @param string The username |
43 | 43 | * @param string The password |
44 | - * @param Swift The instance of Swift this authenticator is used in |
|
44 | + * @param Swift Swift instance of Swift this authenticator is used in |
|
45 | 45 | * @return boolean |
46 | 46 | */ |
47 | 47 | public function isAuthenticated($user, $pass, Swift $swift) |
@@ -24,7 +24,7 @@ discard block |
||
24 | 24 | * Returns false on failure |
25 | 25 | * @param string The username |
26 | 26 | * @param string The password |
27 | - * @param Swift The instance of Swift this authenticator is used in |
|
27 | + * @param Swift Swift instance of Swift this authenticator is used in |
|
28 | 28 | * @return boolean |
29 | 29 | */ |
30 | 30 | public function isAuthenticated($user, $pass, Swift $swift) |
@@ -52,6 +52,7 @@ discard block |
||
52 | 52 | * Generate a CRAM-MD5 hash from a challenge |
53 | 53 | * @param string The string to get a hash from |
54 | 54 | * @param string The challenge to use to make the hash |
55 | + * @param string $challenge |
|
55 | 56 | * @return string |
56 | 57 | */ |
57 | 58 | public static function generateCRAMMD5Hash($password, $challenge) |
@@ -23,7 +23,7 @@ |
||
23 | 23 | * Returns false on failure |
24 | 24 | * @param string The username |
25 | 25 | * @param string The password |
26 | - * @param Swift The instance of Swift this authenticator is used in |
|
26 | + * @param Swift Swift instance of Swift this authenticator is used in |
|
27 | 27 | * @return boolean |
28 | 28 | */ |
29 | 29 | public function isAuthenticated($user, $pass, Swift $swift) |
@@ -24,7 +24,7 @@ |
||
24 | 24 | * Returns false on failure |
25 | 25 | * @param string The username |
26 | 26 | * @param string The password |
27 | - * @param Swift The instance of Swift this authenticator is used in |
|
27 | + * @param Swift Swift instance of Swift this authenticator is used in |
|
28 | 28 | * @return boolean |
29 | 29 | */ |
30 | 30 | public function isAuthenticated($user, $pass, Swift $swift) |
@@ -57,6 +57,7 @@ discard block |
||
57 | 57 | /** |
58 | 58 | * Set the server name |
59 | 59 | * @param string The IP or FQDN of the POP3 server |
60 | + * @param string $server |
|
60 | 61 | */ |
61 | 62 | public function setServer($server) |
62 | 63 | { |
@@ -65,6 +66,7 @@ discard block |
||
65 | 66 | /** |
66 | 67 | * Set the port number for the POP3 server |
67 | 68 | * @param int |
69 | + * @param integer $port |
|
68 | 70 | */ |
69 | 71 | public function setPort($port) |
70 | 72 | { |
@@ -89,6 +91,7 @@ discard block |
||
89 | 91 | /** |
90 | 92 | * Set the level of enryption to use (see ENC_OFF or ENC_SSL) |
91 | 93 | * @param int The constant for the encryption level |
94 | + * @param integer $enc |
|
92 | 95 | */ |
93 | 96 | public function setEncryption($enc) |
94 | 97 | { |
@@ -44,7 +44,7 @@ discard block |
||
44 | 44 | |
45 | 45 | /** |
46 | 46 | * Constructor. |
47 | - * @param Swift The current instance of Swift |
|
47 | + * @param Swift Swift current instance of Swift |
|
48 | 48 | */ |
49 | 49 | public function __construct(Swift $swift) |
50 | 50 | { |
@@ -52,7 +52,7 @@ discard block |
||
52 | 52 | } |
53 | 53 | /** |
54 | 54 | * Set the current Swift instance. |
55 | - * @param Swift The instance |
|
55 | + * @param Swift Swift instance |
|
56 | 56 | */ |
57 | 57 | public function setSwift(Swift $swift) |
58 | 58 | { |
@@ -21,16 +21,19 @@ discard block |
||
21 | 21 | * Append bytes to the cache buffer identified by $key |
22 | 22 | * @param string The Cache key |
23 | 23 | * @param string The bytes to append |
24 | + * @param string $key |
|
24 | 25 | */ |
25 | 26 | abstract public function write($key, $data); |
26 | 27 | /** |
27 | 28 | * Clear out the buffer for $key |
28 | 29 | * @param string The cache key |
30 | + * @param string $key |
|
29 | 31 | */ |
30 | 32 | abstract public function clear($key); |
31 | 33 | /** |
32 | 34 | * Check if there is something in the cache for $key |
33 | 35 | * @param string The cache key |
36 | + * @param string $key |
|
34 | 37 | * @return boolean |
35 | 38 | */ |
36 | 39 | abstract public function has($key); |
@@ -38,12 +41,14 @@ discard block |
||
38 | 41 | * Read bytes from the cached buffer and seek forward in the buffer |
39 | 42 | * Returns false once no more bytes are left to read |
40 | 43 | * @param int The number of bytes to read (may be ignored) |
44 | + * @param string $key |
|
41 | 45 | * @return string |
42 | 46 | */ |
43 | 47 | abstract public function read($key, $size=null); |
44 | 48 | /** |
45 | 49 | * A factory method to return an output stream object for the relevant location in the cache |
46 | 50 | * @param string The cache key to fetch the stream for |
51 | + * @param string $key |
|
47 | 52 | * @return Swift_Cache_OutputStream |
48 | 53 | */ |
49 | 54 | public function getOutputStream($key) |