@@ -39,6 +39,9 @@ discard block |
||
39 | 39 | */ |
40 | 40 | if ( ! function_exists('site_url')) |
41 | 41 | { |
42 | + /** |
|
43 | + * @return integer|null |
|
44 | + */ |
|
42 | 45 | function site_url($uri = '') |
43 | 46 | { |
44 | 47 | $CI =& get_instance(); |
@@ -61,6 +64,9 @@ discard block |
||
61 | 64 | */ |
62 | 65 | if ( ! function_exists('base_url')) |
63 | 66 | { |
67 | + /** |
|
68 | + * @return string |
|
69 | + */ |
|
64 | 70 | function base_url($uri = '') |
65 | 71 | { |
66 | 72 | $CI =& get_instance(); |
@@ -262,6 +268,9 @@ discard block |
||
262 | 268 | */ |
263 | 269 | if ( ! function_exists('safe_mailto')) |
264 | 270 | { |
271 | + /** |
|
272 | + * @param string $email |
|
273 | + */ |
|
265 | 274 | function safe_mailto($email, $title = '', $attributes = '') |
266 | 275 | { |
267 | 276 | $title = (string) $title; |
@@ -80,7 +80,7 @@ discard block |
||
80 | 80 | * |
81 | 81 | * @access public |
82 | 82 | * @param array |
83 | - * @return bool |
|
83 | + * @return string|boolean |
|
84 | 84 | */ |
85 | 85 | function insert($items = array()) |
86 | 86 | { |
@@ -135,7 +135,7 @@ discard block |
||
135 | 135 | * |
136 | 136 | * @access private |
137 | 137 | * @param array |
138 | - * @return bool |
|
138 | + * @return false|string |
|
139 | 139 | */ |
140 | 140 | function _insert($items = array()) |
141 | 141 | { |
@@ -469,7 +469,7 @@ discard block |
||
469 | 469 | * that has options associated with it. |
470 | 470 | * |
471 | 471 | * @access public |
472 | - * @return array |
|
472 | + * @return boolean |
|
473 | 473 | */ |
474 | 474 | function has_options($rowid = '') |
475 | 475 | { |
@@ -509,7 +509,7 @@ discard block |
||
509 | 509 | * Returns the supplied number with commas and a decimal point. |
510 | 510 | * |
511 | 511 | * @access public |
512 | - * @return integer |
|
512 | + * @return string |
|
513 | 513 | */ |
514 | 514 | function format_number($n = '') |
515 | 515 | { |
@@ -105,7 +105,7 @@ discard block |
||
105 | 105 | * |
106 | 106 | * @access public |
107 | 107 | * @param array |
108 | - * @return void |
|
108 | + * @return CI_Email |
|
109 | 109 | */ |
110 | 110 | public function initialize($config = array()) |
111 | 111 | { |
@@ -139,7 +139,7 @@ discard block |
||
139 | 139 | * Initialize the Email Data |
140 | 140 | * |
141 | 141 | * @access public |
142 | - * @return void |
|
142 | + * @return CI_Email |
|
143 | 143 | */ |
144 | 144 | public function clear($clear_attachments = FALSE) |
145 | 145 | { |
@@ -175,7 +175,7 @@ discard block |
||
175 | 175 | * @access public |
176 | 176 | * @param string |
177 | 177 | * @param string |
178 | - * @return void |
|
178 | + * @return CI_Email |
|
179 | 179 | */ |
180 | 180 | public function from($from, $name = '') |
181 | 181 | { |
@@ -218,7 +218,7 @@ discard block |
||
218 | 218 | * @access public |
219 | 219 | * @param string |
220 | 220 | * @param string |
221 | - * @return void |
|
221 | + * @return CI_Email |
|
222 | 222 | */ |
223 | 223 | public function reply_to($replyto, $name = '') |
224 | 224 | { |
@@ -255,7 +255,7 @@ discard block |
||
255 | 255 | * |
256 | 256 | * @access public |
257 | 257 | * @param string |
258 | - * @return void |
|
258 | + * @return CI_Email |
|
259 | 259 | */ |
260 | 260 | public function to($to) |
261 | 261 | { |
@@ -293,7 +293,7 @@ discard block |
||
293 | 293 | * |
294 | 294 | * @access public |
295 | 295 | * @param string |
296 | - * @return void |
|
296 | + * @return CI_Email |
|
297 | 297 | */ |
298 | 298 | public function cc($cc) |
299 | 299 | { |
@@ -323,7 +323,7 @@ discard block |
||
323 | 323 | * @access public |
324 | 324 | * @param string |
325 | 325 | * @param string |
326 | - * @return void |
|
326 | + * @return CI_Email |
|
327 | 327 | */ |
328 | 328 | public function bcc($bcc, $limit = '') |
329 | 329 | { |
@@ -360,7 +360,7 @@ discard block |
||
360 | 360 | * |
361 | 361 | * @access public |
362 | 362 | * @param string |
363 | - * @return void |
|
363 | + * @return CI_Email |
|
364 | 364 | */ |
365 | 365 | public function subject($subject) |
366 | 366 | { |
@@ -376,7 +376,7 @@ discard block |
||
376 | 376 | * |
377 | 377 | * @access public |
378 | 378 | * @param string |
379 | - * @return void |
|
379 | + * @return CI_Email |
|
380 | 380 | */ |
381 | 381 | public function message($body) |
382 | 382 | { |
@@ -403,7 +403,7 @@ discard block |
||
403 | 403 | * |
404 | 404 | * @access public |
405 | 405 | * @param string |
406 | - * @return void |
|
406 | + * @return CI_Email |
|
407 | 407 | */ |
408 | 408 | public function attach($filename, $disposition = 'attachment') |
409 | 409 | { |
@@ -421,6 +421,7 @@ discard block |
||
421 | 421 | * @access protected |
422 | 422 | * @param string |
423 | 423 | * @param string |
424 | + * @param string $header |
|
424 | 425 | * @return void |
425 | 426 | */ |
426 | 427 | protected function _set_header($header, $value) |
@@ -461,7 +462,7 @@ discard block |
||
461 | 462 | * |
462 | 463 | * @access public |
463 | 464 | * @param string |
464 | - * @return void |
|
465 | + * @return CI_Email |
|
465 | 466 | */ |
466 | 467 | public function set_alt_message($str = '') |
467 | 468 | { |
@@ -476,7 +477,7 @@ discard block |
||
476 | 477 | * |
477 | 478 | * @access public |
478 | 479 | * @param string |
479 | - * @return void |
|
480 | + * @return CI_Email |
|
480 | 481 | */ |
481 | 482 | public function set_mailtype($type = 'text') |
482 | 483 | { |
@@ -491,7 +492,7 @@ discard block |
||
491 | 492 | * |
492 | 493 | * @access public |
493 | 494 | * @param string |
494 | - * @return void |
|
495 | + * @return CI_Email |
|
495 | 496 | */ |
496 | 497 | public function set_wordwrap($wordwrap = TRUE) |
497 | 498 | { |
@@ -506,7 +507,7 @@ discard block |
||
506 | 507 | * |
507 | 508 | * @access public |
508 | 509 | * @param string |
509 | - * @return void |
|
510 | + * @return CI_Email |
|
510 | 511 | */ |
511 | 512 | public function set_protocol($protocol = 'mail') |
512 | 513 | { |
@@ -521,7 +522,7 @@ discard block |
||
521 | 522 | * |
522 | 523 | * @access public |
523 | 524 | * @param integer |
524 | - * @return void |
|
525 | + * @return null|CI_Email |
|
525 | 526 | */ |
526 | 527 | public function set_priority($n = 3) |
527 | 528 | { |
@@ -548,7 +549,7 @@ discard block |
||
548 | 549 | * |
549 | 550 | * @access public |
550 | 551 | * @param string |
551 | - * @return void |
|
552 | + * @return null|CI_Email |
|
552 | 553 | */ |
553 | 554 | public function set_newline($newline = "\n") |
554 | 555 | { |
@@ -570,7 +571,7 @@ discard block |
||
570 | 571 | * |
571 | 572 | * @access public |
572 | 573 | * @param string |
573 | - * @return void |
|
574 | + * @return null|CI_Email |
|
574 | 575 | */ |
575 | 576 | public function set_crlf($crlf = "\n") |
576 | 577 | { |
@@ -861,6 +862,7 @@ discard block |
||
861 | 862 | * @access public |
862 | 863 | * @param string |
863 | 864 | * @param integer |
865 | + * @param string $str |
|
864 | 866 | * @return string |
865 | 867 | */ |
866 | 868 | public function word_wrap($str, $charlim = '') |
@@ -1008,7 +1010,7 @@ discard block |
||
1008 | 1010 | * Build Final Body and attachments |
1009 | 1011 | * |
1010 | 1012 | * @access protected |
1011 | - * @return void |
|
1013 | + * @return null|false |
|
1012 | 1014 | */ |
1013 | 1015 | protected function _build_message() |
1014 | 1016 | { |
@@ -1193,6 +1195,7 @@ discard block |
||
1193 | 1195 | * @access protected |
1194 | 1196 | * @param string |
1195 | 1197 | * @param integer |
1198 | + * @param string $str |
|
1196 | 1199 | * @return string |
1197 | 1200 | */ |
1198 | 1201 | protected function _prep_quoted_printable($str, $charlim = '') |
@@ -1353,7 +1356,7 @@ discard block |
||
1353 | 1356 | * Send Email |
1354 | 1357 | * |
1355 | 1358 | * @access public |
1356 | - * @return bool |
|
1359 | + * @return boolean|null |
|
1357 | 1360 | */ |
1358 | 1361 | public function send() |
1359 | 1362 | { |
@@ -1396,7 +1399,7 @@ discard block |
||
1396 | 1399 | * Batch Bcc Send. Sends groups of BCCs in batches |
1397 | 1400 | * |
1398 | 1401 | * @access public |
1399 | - * @return bool |
|
1402 | + * @return boolean|null |
|
1400 | 1403 | */ |
1401 | 1404 | public function batch_bcc_send() |
1402 | 1405 | { |
@@ -1675,7 +1678,7 @@ discard block |
||
1675 | 1678 | * |
1676 | 1679 | * @access protected |
1677 | 1680 | * @param string |
1678 | - * @return string |
|
1681 | + * @return boolean |
|
1679 | 1682 | */ |
1680 | 1683 | protected function _smtp_connect() |
1681 | 1684 | { |
@@ -1714,7 +1717,8 @@ discard block |
||
1714 | 1717 | * @access protected |
1715 | 1718 | * @param string |
1716 | 1719 | * @param string |
1717 | - * @return string |
|
1720 | + * @param string $cmd |
|
1721 | + * @return boolean |
|
1718 | 1722 | */ |
1719 | 1723 | protected function _send_command($cmd, $data = '') |
1720 | 1724 | { |
@@ -1840,6 +1844,7 @@ discard block |
||
1840 | 1844 | * |
1841 | 1845 | * @access protected |
1842 | 1846 | * @return bool |
1847 | + * @param string $data |
|
1843 | 1848 | */ |
1844 | 1849 | protected function _send_data($data) |
1845 | 1850 | { |
@@ -1965,6 +1970,7 @@ discard block |
||
1965 | 1970 | * |
1966 | 1971 | * @access protected |
1967 | 1972 | * @param string |
1973 | + * @param string $msg |
|
1968 | 1974 | * @return string |
1969 | 1975 | */ |
1970 | 1976 | protected function _set_error_message($msg, $val = '') |
@@ -233,6 +233,7 @@ discard block |
||
233 | 233 | * @access private |
234 | 234 | * @param string |
235 | 235 | * @param string |
236 | + * @param string $key |
|
236 | 237 | * @return string |
237 | 238 | */ |
238 | 239 | function _xor_encode($string, $key) |
@@ -265,6 +266,8 @@ discard block |
||
265 | 266 | * @access private |
266 | 267 | * @param string |
267 | 268 | * @param string |
269 | + * @param string $string |
|
270 | + * @param string $key |
|
268 | 271 | * @return string |
269 | 272 | */ |
270 | 273 | function _xor_decode($string, $key) |
@@ -312,6 +315,7 @@ discard block |
||
312 | 315 | * @access public |
313 | 316 | * @param string |
314 | 317 | * @param string |
318 | + * @param string $key |
|
315 | 319 | * @return string |
316 | 320 | */ |
317 | 321 | function mcrypt_encode($data, $key) |
@@ -329,6 +333,8 @@ discard block |
||
329 | 333 | * @access public |
330 | 334 | * @param string |
331 | 335 | * @param string |
336 | + * @param string $data |
|
337 | + * @param string $key |
|
332 | 338 | * @return string |
333 | 339 | */ |
334 | 340 | function mcrypt_decode($data, $key) |
@@ -358,6 +364,7 @@ discard block |
||
358 | 364 | * @access private |
359 | 365 | * @param string |
360 | 366 | * @param string |
367 | + * @param string $data |
|
361 | 368 | * @return string |
362 | 369 | */ |
363 | 370 | function _add_cipher_noise($data, $key) |
@@ -389,7 +396,7 @@ discard block |
||
389 | 396 | * |
390 | 397 | * @access public |
391 | 398 | * @param type |
392 | - * @return type |
|
399 | + * @return string |
|
393 | 400 | */ |
394 | 401 | function _remove_cipher_noise($data, $key) |
395 | 402 | { |
@@ -69,7 +69,7 @@ discard block |
||
69 | 69 | * @access public |
70 | 70 | * @param mixed |
71 | 71 | * @param string |
72 | - * @return void |
|
72 | + * @return CI_Form_validation |
|
73 | 73 | */ |
74 | 74 | public function set_rules($field, $label = '', $rules = '') |
75 | 75 | { |
@@ -160,7 +160,7 @@ discard block |
||
160 | 160 | * @access public |
161 | 161 | * @param string |
162 | 162 | * @param string |
163 | - * @return string |
|
163 | + * @return CI_Form_validation |
|
164 | 164 | */ |
165 | 165 | public function set_message($lang, $val = '') |
166 | 166 | { |
@@ -184,7 +184,7 @@ discard block |
||
184 | 184 | * @access public |
185 | 185 | * @param string |
186 | 186 | * @param string |
187 | - * @return void |
|
187 | + * @return CI_Form_validation |
|
188 | 188 | */ |
189 | 189 | public function set_error_delimiters($prefix = '<p>', $suffix = '</p>') |
190 | 190 | { |
@@ -203,7 +203,7 @@ discard block |
||
203 | 203 | * |
204 | 204 | * @access public |
205 | 205 | * @param string the field name |
206 | - * @return void |
|
206 | + * @return string |
|
207 | 207 | */ |
208 | 208 | public function error($field = '', $prefix = '', $suffix = '') |
209 | 209 | { |
@@ -1089,6 +1089,7 @@ discard block |
||
1089 | 1089 | * |
1090 | 1090 | * @access public |
1091 | 1091 | * @param string |
1092 | + * @param string $str |
|
1092 | 1093 | * @return bool |
1093 | 1094 | */ |
1094 | 1095 | public function valid_email($str) |
@@ -178,6 +178,10 @@ discard block |
||
178 | 178 | $this->PDFVersion = '1.3'; |
179 | 179 | } |
180 | 180 | |
181 | +/** |
|
182 | + * @param double $left |
|
183 | + * @param double $top |
|
184 | + */ |
|
181 | 185 | function SetMargins($left, $top, $right=null) |
182 | 186 | { |
183 | 187 | // Set left, top and right margins |
@@ -208,6 +212,9 @@ discard block |
||
208 | 212 | $this->rMargin = $margin; |
209 | 213 | } |
210 | 214 | |
215 | +/** |
|
216 | + * @param boolean $auto |
|
217 | + */ |
|
211 | 218 | function SetAutoPageBreak($auto, $margin=0) |
212 | 219 | { |
213 | 220 | // Set auto page break mode and triggering margin |
@@ -216,6 +223,9 @@ discard block |
||
216 | 223 | $this->PageBreakTrigger = $this->h-$margin; |
217 | 224 | } |
218 | 225 | |
226 | +/** |
|
227 | + * @param string $zoom |
|
228 | + */ |
|
219 | 229 | function SetDisplayMode($zoom, $layout='default') |
220 | 230 | { |
221 | 231 | // Set display mode in viewer |
@@ -229,6 +239,9 @@ discard block |
||
229 | 239 | $this->Error('Incorrect layout display mode: '.$layout); |
230 | 240 | } |
231 | 241 | |
242 | +/** |
|
243 | + * @param boolean $compress |
|
244 | + */ |
|
232 | 245 | function SetCompression($compress) |
233 | 246 | { |
234 | 247 | // Set page compression |
@@ -409,6 +422,11 @@ discard block |
||
409 | 422 | $this->_out($this->DrawColor); |
410 | 423 | } |
411 | 424 | |
425 | +/** |
|
426 | + * @param integer $r |
|
427 | + * @param integer $g |
|
428 | + * @param integer $b |
|
429 | + */ |
|
412 | 430 | function SetFillColor($r, $g=null, $b=null) |
413 | 431 | { |
414 | 432 | // Set color for all filling operations |
@@ -451,6 +469,10 @@ discard block |
||
451 | 469 | $this->_out(sprintf('%.2F w',$width*$this->k)); |
452 | 470 | } |
453 | 471 | |
472 | +/** |
|
473 | + * @param integer $x1 |
|
474 | + * @param integer $x2 |
|
475 | + */ |
|
454 | 476 | function Line($x1, $y1, $x2, $y2) |
455 | 477 | { |
456 | 478 | // Draw a line |
@@ -469,6 +491,9 @@ discard block |
||
469 | 491 | $this->_out(sprintf('%.2F %.2F %.2F %.2F re %s',$x*$this->k,($this->h-$y)*$this->k,$w*$this->k,-$h*$this->k,$op)); |
470 | 492 | } |
471 | 493 | |
494 | +/** |
|
495 | + * @param string $family |
|
496 | + */ |
|
472 | 497 | function AddFont($family, $style='', $file='') |
473 | 498 | { |
474 | 499 | // Add a TrueType, OpenType or Type1 font |
@@ -505,6 +530,9 @@ discard block |
||
505 | 530 | $this->fonts[$fontkey] = $info; |
506 | 531 | } |
507 | 532 | |
533 | +/** |
|
534 | + * @param string $family |
|
535 | + */ |
|
508 | 536 | function SetFont($family, $style='', $size=0) |
509 | 537 | { |
510 | 538 | // Select a font; size given in points |
@@ -584,6 +612,10 @@ discard block |
||
584 | 612 | $this->links[$link] = array($page, $y); |
585 | 613 | } |
586 | 614 | |
615 | +/** |
|
616 | + * @param double $y |
|
617 | + * @param string $link |
|
618 | + */ |
|
587 | 619 | function Link($x, $y, $w, $h, $link) |
588 | 620 | { |
589 | 621 | // Put a link on the page |
@@ -686,6 +718,10 @@ discard block |
||
686 | 718 | $this->x += $w; |
687 | 719 | } |
688 | 720 | |
721 | +/** |
|
722 | + * @param integer $w |
|
723 | + * @param integer $h |
|
724 | + */ |
|
689 | 725 | function MultiCell($w, $h, $txt, $border=0, $align='J', $fill=false) |
690 | 726 | { |
691 | 727 | // Output text with automatic or explicit line breaks |
@@ -984,6 +1020,9 @@ discard block |
||
984 | 1020 | $this->y = $this->h+$y; |
985 | 1021 | } |
986 | 1022 | |
1023 | +/** |
|
1024 | + * @param integer $x |
|
1025 | + */ |
|
987 | 1026 | function SetXY($x, $y) |
988 | 1027 | { |
989 | 1028 | // Set x and y positions |
@@ -1106,6 +1145,10 @@ discard block |
||
1106 | 1145 | } |
1107 | 1146 | } |
1108 | 1147 | |
1148 | +/** |
|
1149 | + * @param string $orientation |
|
1150 | + * @param string $size |
|
1151 | + */ |
|
1109 | 1152 | function _beginpage($orientation, $size) |
1110 | 1153 | { |
1111 | 1154 | $this->page++; |
@@ -1151,6 +1194,9 @@ discard block |
||
1151 | 1194 | $this->state = 1; |
1152 | 1195 | } |
1153 | 1196 | |
1197 | +/** |
|
1198 | + * @param string $font |
|
1199 | + */ |
|
1154 | 1200 | function _loadfont($font) |
1155 | 1201 | { |
1156 | 1202 | // Load a font definition file from the font directory |
@@ -1238,6 +1284,9 @@ discard block |
||
1238 | 1284 | return array('w'=>$a[0], 'h'=>$a[1], 'cs'=>$colspace, 'bpc'=>$bpc, 'f'=>'DCTDecode', 'data'=>$data); |
1239 | 1285 | } |
1240 | 1286 | |
1287 | +/** |
|
1288 | + * @param string $file |
|
1289 | + */ |
|
1241 | 1290 | function _parsepng($file) |
1242 | 1291 | { |
1243 | 1292 | // Extract info from a PNG file |
@@ -233,6 +233,8 @@ discard block |
||
233 | 233 | * @param string |
234 | 234 | * @param string |
235 | 235 | * @param string |
236 | + * @param string $locpath |
|
237 | + * @param string $rempath |
|
236 | 238 | * @return bool |
237 | 239 | */ |
238 | 240 | function upload($locpath, $rempath, $mode = 'auto', $permissions = NULL) |
@@ -456,6 +458,7 @@ discard block |
||
456 | 458 | * @access public |
457 | 459 | * @param string the file path |
458 | 460 | * @param string the permissions |
461 | + * @param integer $perm |
|
459 | 462 | * @return bool |
460 | 463 | */ |
461 | 464 | function chmod($path, $perm) |
@@ -592,6 +595,7 @@ discard block |
||
592 | 595 | * |
593 | 596 | * @access private |
594 | 597 | * @param string |
598 | + * @param string $ext |
|
595 | 599 | * @return string |
596 | 600 | */ |
597 | 601 | function _settype($ext) |
@@ -624,7 +628,7 @@ discard block |
||
624 | 628 | * @access public |
625 | 629 | * @param string path to source |
626 | 630 | * @param string path to destination |
627 | - * @return bool |
|
631 | + * @return false|null |
|
628 | 632 | */ |
629 | 633 | function close() |
630 | 634 | { |
@@ -643,7 +647,8 @@ discard block |
||
643 | 647 | * |
644 | 648 | * @access private |
645 | 649 | * @param string |
646 | - * @return bool |
|
650 | + * @param string $line |
|
651 | + * @return boolean|null |
|
647 | 652 | */ |
648 | 653 | function _error($line) |
649 | 654 | { |
@@ -168,6 +168,8 @@ discard block |
||
168 | 168 | * @param string - element |
169 | 169 | * @param string - Javascript code for mouse over |
170 | 170 | * @param string - Javascript code for mouse out |
171 | + * @param string $over |
|
172 | + * @param string $out |
|
171 | 173 | * @return string |
172 | 174 | */ |
173 | 175 | function hover($element = 'this', $over, $out) |
@@ -675,6 +677,7 @@ discard block |
||
675 | 677 | * @access public |
676 | 678 | * @param string The element to attach the event to |
677 | 679 | * @param boolean If a CDATA section should be added |
680 | + * @param string $script |
|
678 | 681 | * @return string |
679 | 682 | */ |
680 | 683 | function inline($script, $cdata = TRUE) |
@@ -817,7 +820,7 @@ discard block |
||
817 | 820 | * |
818 | 821 | * @access public |
819 | 822 | * @param type |
820 | - * @return type |
|
823 | + * @return boolean |
|
821 | 824 | */ |
822 | 825 | function _is_associative_array($arr) |
823 | 826 | { |
@@ -861,7 +861,7 @@ discard block |
||
861 | 861 | * Creates a jQuery sortable |
862 | 862 | * |
863 | 863 | * @access public |
864 | - * @return void |
|
864 | + * @return string |
|
865 | 865 | */ |
866 | 866 | function sortable($element, $options = array()) |
867 | 867 | { |
@@ -911,6 +911,8 @@ discard block |
||
911 | 911 | * @param string The element to attach the event to |
912 | 912 | * @param string The code to execute |
913 | 913 | * @param string The event to pass |
914 | + * @param string $element |
|
915 | + * @param string $event |
|
914 | 916 | * @return string |
915 | 917 | */ |
916 | 918 | function _add_event($element, $js, $event) |
@@ -1049,6 +1051,7 @@ discard block |
||
1049 | 1051 | * |
1050 | 1052 | * @access private |
1051 | 1053 | * @param string |
1054 | + * @param string $speed |
|
1052 | 1055 | * @return string |
1053 | 1056 | */ |
1054 | 1057 | function _validate_speed($speed) |