@@ -55,7 +55,7 @@ discard block |
||
55 | 55 | /** |
56 | 56 | * Set the size of data to read at each reading |
57 | 57 | * @param integer Size |
58 | - * @return object This |
|
58 | + * @return IOStream This |
|
59 | 59 | */ |
60 | 60 | public function setReadPacketSize($n) { |
61 | 61 | $this->readPacketSize = $n; |
@@ -231,6 +231,7 @@ discard block |
||
231 | 231 | /** |
232 | 232 | * Send data to the connection. Note that it just writes to buffer that flushes at every baseloop |
233 | 233 | * @param string Data to send. |
234 | + * @param string $s |
|
234 | 235 | * @return boolean Success. |
235 | 236 | */ |
236 | 237 | public function send($s) { |
@@ -248,7 +249,7 @@ discard block |
||
248 | 249 | |
249 | 250 | /** |
250 | 251 | * Finish the session. You shouldn't care about pending buffers, it will be flushed properly. |
251 | - * @return void |
|
252 | + * @return null|boolean |
|
252 | 253 | */ |
253 | 254 | public function finish() { |
254 | 255 | if ($this->finished) { |
@@ -277,6 +278,7 @@ discard block |
||
277 | 278 | * Called when new data received |
278 | 279 | * @todo +on & -> protected? |
279 | 280 | * @param string New received data |
281 | + * @param string $buf |
|
280 | 282 | * @return void |
281 | 283 | */ |
282 | 284 | public function stdin($buf) {} |
@@ -396,6 +398,7 @@ discard block |
||
396 | 398 | * @param resource Bufferevent |
397 | 399 | * @param int Events |
398 | 400 | * @param mixed Attached variable |
401 | + * @param EventBufferEvent|null $bev |
|
399 | 402 | * @return void |
400 | 403 | */ |
401 | 404 | public function onStateEvent($bev, $events) { |
@@ -423,6 +426,7 @@ discard block |
||
423 | 426 | /** |
424 | 427 | * Read data from the connection's buffer |
425 | 428 | * @param integer Max. number of bytes to read |
429 | + * @param integer $n |
|
426 | 430 | * @return string Readed data |
427 | 431 | */ |
428 | 432 | public function read($n) { |
@@ -175,6 +175,10 @@ discard block |
||
175 | 175 | Timer::setTimeout($this->keepaliveTimer); |
176 | 176 | } |
177 | 177 | |
178 | + /** |
|
179 | + * @param null|string $from |
|
180 | + * @param string $cmd |
|
181 | + */ |
|
178 | 182 | public function command($from, $cmd) { |
179 | 183 | if ($from === null) { |
180 | 184 | $from = $this->pool->config->servername->value; |
@@ -326,6 +330,9 @@ discard block |
||
326 | 330 | } |
327 | 331 | } |
328 | 332 | |
333 | + /** |
|
334 | + * @param string $msg |
|
335 | + */ |
|
329 | 336 | public function msgFromBNC($msg) { |
330 | 337 | if ($this->usermask === null) { |
331 | 338 | return; |
@@ -59,6 +59,9 @@ discard block |
||
59 | 59 | } |
60 | 60 | } |
61 | 61 | |
62 | + /** |
|
63 | + * @param string $cmd |
|
64 | + */ |
|
62 | 65 | public function command($cmd) { |
63 | 66 | if (ctype_digit($cmd)) { |
64 | 67 | $cmd = IRC::getCommandByCode((int) $cmd); |
@@ -134,6 +137,10 @@ discard block |
||
134 | 137 | $this->writeln('PING :'.$this->servername); |
135 | 138 | } |
136 | 139 | |
140 | + /** |
|
141 | + * @param string $to |
|
142 | + * @param string $msg |
|
143 | + */ |
|
137 | 144 | public function message($to, $msg) { |
138 | 145 | $this->command('PRIVMSG', $to, $msg); |
139 | 146 | } |
@@ -172,6 +179,9 @@ discard block |
||
172 | 179 | } |
173 | 180 | } |
174 | 181 | |
182 | + /** |
|
183 | + * @param string $mode |
|
184 | + */ |
|
175 | 185 | public function addMode($channel, $target, $mode) { |
176 | 186 | if ($channel) { |
177 | 187 | $this->channel($channel)->addMode($target, $mode); |
@@ -182,6 +192,9 @@ discard block |
||
182 | 192 | } |
183 | 193 | } |
184 | 194 | |
195 | + /** |
|
196 | + * @param string $mode |
|
197 | + */ |
|
185 | 198 | public function removeMode($channel, $target, $mode) { |
186 | 199 | if ($channel) { |
187 | 200 | $this->channel($channel)->removeMode($target, $mode); |
@@ -421,6 +434,10 @@ discard block |
||
421 | 434 | public $self; |
422 | 435 | public $type; |
423 | 436 | public $topic; |
437 | + |
|
438 | + /** |
|
439 | + * @param IRCClientConnection $irc |
|
440 | + */ |
|
424 | 441 | public function __construct($irc, $name) { |
425 | 442 | $this->irc = $irc; |
426 | 443 | $this->name = $name; |
@@ -66,6 +66,7 @@ |
||
66 | 66 | * Called when client sends done- or failed-event. |
67 | 67 | * @param string Name of job. |
68 | 68 | * @param string Result. |
69 | + * @param string $result |
|
69 | 70 | * @return string Result. |
70 | 71 | */ |
71 | 72 | public function done($name, $result) { |
@@ -81,6 +81,9 @@ |
||
81 | 81 | * @param integer Opcode (see constants above) |
82 | 82 | * @param string Data |
83 | 83 | * @param boolean Is an answer expected? |
84 | + * @param string $key |
|
85 | + * @param integer $opcode |
|
86 | + * @param string $data |
|
84 | 87 | * @return integer Request ID |
85 | 88 | * @throws MongoClientAsyncConnectionFinished |
86 | 89 | */ |
@@ -10,6 +10,7 @@ discard block |
||
10 | 10 | * Contructor of MongoClientAsyncCollection |
11 | 11 | * @param string Name of collection |
12 | 12 | * @param object Pool |
13 | + * @param MongoClientAsync $pool |
|
13 | 14 | * @return void |
14 | 15 | */ |
15 | 16 | public function __construct($name, $pool) { |
@@ -143,6 +144,8 @@ discard block |
||
143 | 144 | * @param string Code |
144 | 145 | * @param mixed Callback called when response received |
145 | 146 | * @param string Optional. Distribution key |
147 | + * @param string $code |
|
148 | + * @param Closure $cb |
|
146 | 149 | * @return void |
147 | 150 | */ |
148 | 151 | public function evaluate($code, $cb, $key = '') |
@@ -14,7 +14,9 @@ discard block |
||
14 | 14 | * Constructor |
15 | 15 | * @param string Cursor's ID |
16 | 16 | * @param string Collection's name |
17 | - * @param object Network connection (MongoClientConnection), |
|
17 | + * @param object Network connection (MongoClientConnection), |
|
18 | + * @param string $id |
|
19 | + * @param MongoClientAsyncConnection $conn |
|
18 | 20 | * @return void |
19 | 21 | */ |
20 | 22 | public function __construct($id, $col, $conn) { |
@@ -26,7 +28,7 @@ discard block |
||
26 | 28 | /** |
27 | 29 | * Asks for more objects |
28 | 30 | * @param integer Number of objects |
29 | - * @return void |
|
31 | + * @return boolean |
|
30 | 32 | */ |
31 | 33 | public function getMore($number = 0) { |
32 | 34 | //if ($this->tailable && $this->await) {return true;} |
@@ -59,6 +59,7 @@ discard block |
||
59 | 59 | * Converts binary string to integer |
60 | 60 | * @param string Binary string |
61 | 61 | * @param boolean Optional. Little endian. Default value - true. |
62 | + * @param string $str |
|
62 | 63 | * @return integer Resulting integer |
63 | 64 | */ |
64 | 65 | public function bytes2int($str, $l = TRUE) |
@@ -82,6 +83,7 @@ discard block |
||
82 | 83 | * @param integer Length |
83 | 84 | * @param integer Integer |
84 | 85 | * @param boolean Optional. Little endian. Default value - true. |
86 | + * @param integer $len |
|
85 | 87 | * @return string Resulting binary string |
86 | 88 | */ |
87 | 89 | function int2bytes($len, $int = 0, $l = TRUE) { |
@@ -108,6 +110,7 @@ discard block |
||
108 | 110 | /** |
109 | 111 | * Sends a packet |
110 | 112 | * @param string Data |
113 | + * @param string $packet |
|
111 | 114 | * @return boolean Success |
112 | 115 | */ |
113 | 116 | public function sendPacket($packet) { |
@@ -118,6 +121,7 @@ discard block |
||
118 | 121 | /** |
119 | 122 | * Builds length-encoded binary string |
120 | 123 | * @param string String |
124 | + * @param string $s |
|
121 | 125 | * @return string Resulting binary string |
122 | 126 | */ |
123 | 127 | public function buildLenEncodedBinary($s) { |
@@ -209,6 +213,7 @@ discard block |
||
209 | 213 | * Generates auth. token |
210 | 214 | * @param string Scramble string |
211 | 215 | * @param string Password |
216 | + * @param string $password |
|
212 | 217 | * @return string Result |
213 | 218 | */ |
214 | 219 | public function getAuthToken($scramble, $password) { |
@@ -261,6 +266,7 @@ discard block |
||
261 | 266 | * Sends SQL-query |
262 | 267 | * @param string Query |
263 | 268 | * @param callback Optional. Callback called when response received. |
269 | + * @param string $q |
|
264 | 270 | * @return boolean Success |
265 | 271 | */ |
266 | 272 | public function query($q, $callback = NULL) { |
@@ -62,7 +62,7 @@ discard block |
||
62 | 62 | * @param string Address |
63 | 63 | * @param callback onConnected |
64 | 64 | * @param integer Optional. Priority. |
65 | - * @return mixed Success|Connection. |
|
65 | + * @return boolean Success|Connection. |
|
66 | 66 | */ |
67 | 67 | public function getConnection($url = null, $cb = null, $pri = 0) { |
68 | 68 | if (!is_string($url) && $url !== null && $cb === null) { // if called getConnection(function....) |
@@ -135,6 +135,7 @@ discard block |
||
135 | 135 | /** |
136 | 136 | * Returns available connection from the pool by key |
137 | 137 | * @param string Key |
138 | + * @param Closure $cb |
|
138 | 139 | * @return boolean Success. |
139 | 140 | */ |
140 | 141 | public function getConnectionByKey($key, $cb = null) { |
@@ -161,6 +162,7 @@ discard block |
||
161 | 162 | * @param string Server |
162 | 163 | * @param string Request |
163 | 164 | * @param mixed Callback called when the request complete |
165 | + * @param string $data |
|
164 | 166 | * @return boolean Success. |
165 | 167 | */ |
166 | 168 | public function requestByServer($server, $data, $onResponse = null) { |
@@ -189,6 +191,7 @@ discard block |
||
189 | 191 | * @param string Key |
190 | 192 | * @param string Request |
191 | 193 | * @param mixed Callback called when the request complete |
194 | + * @param string $data |
|
192 | 195 | * @return boolean Success |
193 | 196 | */ |
194 | 197 | public function requestByKey($key, $data, $onResponse = null) { |