@@ -77,7 +77,7 @@ |
||
| 77 | 77 | * @global wpdb $wpdb |
| 78 | 78 | * |
| 79 | 79 | * @param int $link_id ID of the link to delete |
| 80 | - * @return true |
|
| 80 | + * @return boolean |
|
| 81 | 81 | */ |
| 82 | 82 | function wp_delete_link( $link_id ) { |
| 83 | 83 | global $wpdb; |
@@ -83,6 +83,9 @@ |
||
| 83 | 83 | return $result; |
| 84 | 84 | } |
| 85 | 85 | |
| 86 | + /** |
|
| 87 | + * @param string $cmd |
|
| 88 | + */ |
|
| 86 | 89 | function _exec($cmd, $fnction="_exec") { |
| 87 | 90 | if(!$this->_ready) { |
| 88 | 91 | $this->PushError($fnction,'Connect first'); |
@@ -94,6 +94,9 @@ |
||
| 94 | 94 | return $result; |
| 95 | 95 | } |
| 96 | 96 | |
| 97 | + /** |
|
| 98 | + * @param string $cmd |
|
| 99 | + */ |
|
| 97 | 100 | function _exec($cmd, $fnction="_exec") { |
| 98 | 101 | if(!$this->_ready) { |
| 99 | 102 | $this->PushError($fnction,'Connect first'); |
@@ -231,6 +231,9 @@ discard block |
||
| 231 | 231 | return TRUE; |
| 232 | 232 | } |
| 233 | 233 | |
| 234 | + /** |
|
| 235 | + * @param integer $mode |
|
| 236 | + */ |
|
| 234 | 237 | function SetType($mode=FTP_AUTOASCII) { |
| 235 | 238 | if(!in_array($mode, $this->AuthorizedTransferMode)) { |
| 236 | 239 | $this->SendMSG("Wrong type"); |
@@ -256,6 +259,9 @@ discard block |
||
| 256 | 259 | return TRUE; |
| 257 | 260 | } |
| 258 | 261 | |
| 262 | + /** |
|
| 263 | + * @param boolean $pasv |
|
| 264 | + */ |
|
| 259 | 265 | function Passive($pasv=NULL) { |
| 260 | 266 | if(is_null($pasv)) $this->_passive=!$this->_passive; |
| 261 | 267 | else $this->_passive=$pasv; |
@@ -389,6 +395,9 @@ discard block |
||
| 389 | 395 | return true; |
| 390 | 396 | } |
| 391 | 397 | |
| 398 | + /** |
|
| 399 | + * @param string $pathname |
|
| 400 | + */ |
|
| 392 | 401 | function chdir($pathname) { |
| 393 | 402 | if(!$this->_exec("CWD ".$pathname, "chdir")) return FALSE; |
| 394 | 403 | if(!$this->_checkCode()) return FALSE; |
@@ -407,6 +416,10 @@ discard block |
||
| 407 | 416 | return TRUE; |
| 408 | 417 | } |
| 409 | 418 | |
| 419 | + /** |
|
| 420 | + * @param string $from |
|
| 421 | + * @param string $to |
|
| 422 | + */ |
|
| 410 | 423 | function rename($from, $to) { |
| 411 | 424 | if(!$this->_exec("RNFR ".$from, "rename")) return FALSE; |
| 412 | 425 | if(!$this->_checkCode()) return FALSE; |
@@ -417,6 +430,9 @@ discard block |
||
| 417 | 430 | return TRUE; |
| 418 | 431 | } |
| 419 | 432 | |
| 433 | + /** |
|
| 434 | + * @param string $pathname |
|
| 435 | + */ |
|
| 420 | 436 | function filesize($pathname) { |
| 421 | 437 | if(!isset($this->_features["SIZE"])) { |
| 422 | 438 | $this->PushError("filesize", "not supported by server"); |
@@ -437,6 +453,9 @@ discard block |
||
| 437 | 453 | return true; |
| 438 | 454 | } |
| 439 | 455 | |
| 456 | + /** |
|
| 457 | + * @param string $pathname |
|
| 458 | + */ |
|
| 440 | 459 | function mdtm($pathname) { |
| 441 | 460 | if(!isset($this->_features["MDTM"])) { |
| 442 | 461 | $this->PushError("mdtm", "not supported by server"); |
@@ -457,12 +476,18 @@ discard block |
||
| 457 | 476 | return array($DATA[1], $DATA[3]); |
| 458 | 477 | } |
| 459 | 478 | |
| 479 | + /** |
|
| 480 | + * @param string $pathname |
|
| 481 | + */ |
|
| 460 | 482 | function delete($pathname) { |
| 461 | 483 | if(!$this->_exec("DELE ".$pathname, "delete")) return FALSE; |
| 462 | 484 | if(!$this->_checkCode()) return FALSE; |
| 463 | 485 | return TRUE; |
| 464 | 486 | } |
| 465 | 487 | |
| 488 | + /** |
|
| 489 | + * @param string $command |
|
| 490 | + */ |
|
| 466 | 491 | function site($command, $fnction="site") { |
| 467 | 492 | if(!$this->_exec("SITE ".$command, $fnction)) return FALSE; |
| 468 | 493 | if(!$this->_checkCode()) return FALSE; |
@@ -524,6 +549,9 @@ discard block |
||
| 524 | 549 | return $exists; |
| 525 | 550 | } |
| 526 | 551 | |
| 552 | + /** |
|
| 553 | + * @param string $remotefile |
|
| 554 | + */ |
|
| 527 | 555 | function fget($fp, $remotefile,$rest=0) { |
| 528 | 556 | if($this->_can_restore and $rest!=0) fseek($fp, $rest); |
| 529 | 557 | $pi=pathinfo($remotefile); |
@@ -548,6 +576,10 @@ discard block |
||
| 548 | 576 | return $out; |
| 549 | 577 | } |
| 550 | 578 | |
| 579 | + /** |
|
| 580 | + * @param string $remotefile |
|
| 581 | + * @param string $localfile |
|
| 582 | + */ |
|
| 551 | 583 | function get($remotefile, $localfile=NULL, $rest=0) { |
| 552 | 584 | if(is_null($localfile)) $localfile=$remotefile; |
| 553 | 585 | if (@file_exists($localfile)) $this->SendMSG("Warning : local file will be overwritten"); |
@@ -583,6 +615,9 @@ discard block |
||
| 583 | 615 | return $out; |
| 584 | 616 | } |
| 585 | 617 | |
| 618 | + /** |
|
| 619 | + * @param string $remotefile |
|
| 620 | + */ |
|
| 586 | 621 | function fput($remotefile, $fp) { |
| 587 | 622 | if($this->_can_restore and $rest!=0) fseek($fp, $rest); |
| 588 | 623 | $pi=pathinfo($remotefile); |
@@ -607,6 +642,9 @@ discard block |
||
| 607 | 642 | return $ret; |
| 608 | 643 | } |
| 609 | 644 | |
| 645 | + /** |
|
| 646 | + * @param string $localfile |
|
| 647 | + */ |
|
| 610 | 648 | function put($localfile, $remotefile=NULL, $rest=0) { |
| 611 | 649 | if(is_null($remotefile)) $remotefile=$localfile; |
| 612 | 650 | if (!file_exists($localfile)) { |
@@ -718,6 +756,9 @@ discard block |
||
| 718 | 756 | return $ret; |
| 719 | 757 | } |
| 720 | 758 | |
| 759 | + /** |
|
| 760 | + * @param string $remote |
|
| 761 | + */ |
|
| 721 | 762 | function mdel($remote, $continious=false) { |
| 722 | 763 | $list=$this->rawlist($remote, "-la"); |
| 723 | 764 | if($list===false) { |
@@ -823,6 +864,9 @@ discard block |
||
| 823 | 864 | ); |
| 824 | 865 | } |
| 825 | 866 | |
| 867 | + /** |
|
| 868 | + * @param string $remote |
|
| 869 | + */ |
|
| 826 | 870 | function dirlist($remote) { |
| 827 | 871 | $list=$this->rawlist($remote, "-la"); |
| 828 | 872 | if($list===false) { |
@@ -878,6 +922,10 @@ discard block |
||
| 878 | 922 | // <!-- Partie : gestion des erreurs --> |
| 879 | 923 | // <!-- --------------------------------------------------------------------------------------- --> |
| 880 | 924 | // Gnre une erreur pour traitement externe la classe |
| 925 | + /** |
|
| 926 | + * @param string $fctname |
|
| 927 | + * @param string $msg |
|
| 928 | + */ |
|
| 881 | 929 | function PushError($fctname,$msg,$desc=false){ |
| 882 | 930 | $error=array(); |
| 883 | 931 | $error['time']=time(); |
@@ -2339,6 +2339,10 @@ discard block |
||
| 2339 | 2339 | // Description : |
| 2340 | 2340 | // Parameters : |
| 2341 | 2341 | // -------------------------------------------------------------------------------- |
| 2342 | + |
|
| 2343 | + /** |
|
| 2344 | + * @param string $p_mode |
|
| 2345 | + */ |
|
| 2342 | 2346 | function privOpenFd($p_mode) |
| 2343 | 2347 | { |
| 2344 | 2348 | $v_result=1; |
@@ -4150,6 +4154,10 @@ discard block |
||
| 4150 | 4154 | // Parameters : |
| 4151 | 4155 | // Return Values : |
| 4152 | 4156 | // -------------------------------------------------------------------------------- |
| 4157 | + |
|
| 4158 | + /** |
|
| 4159 | + * @param string $p_string |
|
| 4160 | + */ |
|
| 4153 | 4161 | function privExtractFileAsString(&$p_entry, &$p_string, &$p_options) |
| 4154 | 4162 | { |
| 4155 | 4163 | $v_result=1; |
@@ -5041,6 +5049,10 @@ discard block |
||
| 5041 | 5049 | // Parameters : |
| 5042 | 5050 | // Return Values : |
| 5043 | 5051 | // -------------------------------------------------------------------------------- |
| 5052 | + |
|
| 5053 | + /** |
|
| 5054 | + * @param PclZip $p_archive_to_add |
|
| 5055 | + */ |
|
| 5044 | 5056 | function privMerge(&$p_archive_to_add) |
| 5045 | 5057 | { |
| 5046 | 5058 | $v_result=1; |
@@ -5548,6 +5560,11 @@ discard block |
||
| 5548 | 5560 | // 3 : src & dest gzip |
| 5549 | 5561 | // Return Values : |
| 5550 | 5562 | // -------------------------------------------------------------------------------- |
| 5563 | + |
|
| 5564 | + /** |
|
| 5565 | + * @param integer $p_src |
|
| 5566 | + * @param integer $p_dest |
|
| 5567 | + */ |
|
| 5551 | 5568 | function PclZipUtilCopyBlock($p_src, $p_dest, $p_size, $p_mode=0) |
| 5552 | 5569 | { |
| 5553 | 5570 | $v_result = 1; |
@@ -5610,6 +5627,11 @@ discard block |
||
| 5610 | 5627 | // Return Values : |
| 5611 | 5628 | // 1 on success, 0 on failure. |
| 5612 | 5629 | // -------------------------------------------------------------------------------- |
| 5630 | + |
|
| 5631 | + /** |
|
| 5632 | + * @param string $p_src |
|
| 5633 | + * @param string $p_dest |
|
| 5634 | + */ |
|
| 5613 | 5635 | function PclZipUtilRename($p_src, $p_dest) |
| 5614 | 5636 | { |
| 5615 | 5637 | $v_result = 1; |
@@ -752,7 +752,7 @@ |
||
| 752 | 752 | |
| 753 | 753 | /** |
| 754 | 754 | * |
| 755 | - * @return array |
|
| 755 | + * @return string[] |
|
| 756 | 756 | */ |
| 757 | 757 | protected function get_table_classes() { |
| 758 | 758 | $classes = parent::get_table_classes(); |
@@ -374,7 +374,7 @@ discard block |
||
| 374 | 374 | * @since 2.5.0 |
| 375 | 375 | * |
| 376 | 376 | * @param string $mode string The *nix-style file permission. |
| 377 | - * @return int octal representation |
|
| 377 | + * @return string octal representation |
|
| 378 | 378 | */ |
| 379 | 379 | public function getnumchmodfromh( $mode ) { |
| 380 | 380 | $realmode = ''; |
@@ -443,7 +443,7 @@ discard block |
||
| 443 | 443 | * @since 2.5.0 |
| 444 | 444 | * @abstract |
| 445 | 445 | * @param string $file Name of the file to read. |
| 446 | - * @return mixed|bool Returns the read data or false on failure. |
|
| 446 | + * @return boolean Returns the read data or false on failure. |
|
| 447 | 447 | */ |
| 448 | 448 | public function get_contents( $file ) { |
| 449 | 449 | return false; |
@@ -455,7 +455,7 @@ discard block |
||
| 455 | 455 | * @since 2.5.0 |
| 456 | 456 | * @abstract |
| 457 | 457 | * @param string $file Path to the file. |
| 458 | - * @return array|bool the file contents in an array or false on failure. |
|
| 458 | + * @return boolean the file contents in an array or false on failure. |
|
| 459 | 459 | */ |
| 460 | 460 | public function get_contents_array( $file ) { |
| 461 | 461 | return false; |
@@ -480,7 +480,7 @@ discard block |
||
| 480 | 480 | * |
| 481 | 481 | * @since 2.5.0 |
| 482 | 482 | * @abstract |
| 483 | - * @return string|bool The current working directory on success, or false on failure. |
|
| 483 | + * @return boolean The current working directory on success, or false on failure. |
|
| 484 | 484 | */ |
| 485 | 485 | public function cwd() { |
| 486 | 486 | return false; |
@@ -492,7 +492,7 @@ discard block |
||
| 492 | 492 | * @since 2.5.0 |
| 493 | 493 | * @abstract |
| 494 | 494 | * @param string $dir The new current directory. |
| 495 | - * @return bool|string |
|
| 495 | + * @return boolean |
|
| 496 | 496 | */ |
| 497 | 497 | public function chdir( $dir ) { |
| 498 | 498 | return false; |
@@ -506,7 +506,7 @@ discard block |
||
| 506 | 506 | * @param string $file Path to the file. |
| 507 | 507 | * @param mixed $group A group name or number. |
| 508 | 508 | * @param bool $recursive Optional. If set True changes file group recursively. Defaults to False. |
| 509 | - * @return bool|string |
|
| 509 | + * @return boolean |
|
| 510 | 510 | */ |
| 511 | 511 | public function chgrp( $file, $group, $recursive = false ) { |
| 512 | 512 | return false; |
@@ -520,7 +520,7 @@ discard block |
||
| 520 | 520 | * @param string $file Path to the file. |
| 521 | 521 | * @param int $mode Optional. The permissions as octal number, usually 0644 for files, 0755 for dirs. |
| 522 | 522 | * @param bool $recursive Optional. If set True changes file group recursively. Defaults to False. |
| 523 | - * @return bool|string |
|
| 523 | + * @return boolean |
|
| 524 | 524 | */ |
| 525 | 525 | public function chmod( $file, $mode = false, $recursive = false ) { |
| 526 | 526 | return false; |
@@ -532,7 +532,7 @@ discard block |
||
| 532 | 532 | * @since 2.5.0 |
| 533 | 533 | * @abstract |
| 534 | 534 | * @param string $file Path to the file. |
| 535 | - * @return string|bool Username of the user or false on error. |
|
| 535 | + * @return boolean Username of the user or false on error. |
|
| 536 | 536 | */ |
| 537 | 537 | public function owner( $file ) { |
| 538 | 538 | return false; |
@@ -544,7 +544,7 @@ discard block |
||
| 544 | 544 | * @since 2.5.0 |
| 545 | 545 | * @abstract |
| 546 | 546 | * @param string $file Path to the file. |
| 547 | - * @return string|bool The group or false on error. |
|
| 547 | + * @return boolean The group or false on error. |
|
| 548 | 548 | */ |
| 549 | 549 | public function group( $file ) { |
| 550 | 550 | return false; |
@@ -663,7 +663,7 @@ discard block |
||
| 663 | 663 | * @since 2.5.0 |
| 664 | 664 | * @abstract |
| 665 | 665 | * @param string $file Path to file. |
| 666 | - * @return int|bool Unix timestamp representing last access time. |
|
| 666 | + * @return boolean Unix timestamp representing last access time. |
|
| 667 | 667 | */ |
| 668 | 668 | public function atime( $file ) { |
| 669 | 669 | return false; |
@@ -675,7 +675,7 @@ discard block |
||
| 675 | 675 | * @since 2.5.0 |
| 676 | 676 | * @abstract |
| 677 | 677 | * @param string $file Path to file. |
| 678 | - * @return int|bool Unix timestamp representing modification time. |
|
| 678 | + * @return boolean Unix timestamp representing modification time. |
|
| 679 | 679 | */ |
| 680 | 680 | public function mtime( $file ) { |
| 681 | 681 | return false; |
@@ -687,7 +687,7 @@ discard block |
||
| 687 | 687 | * @since 2.5.0 |
| 688 | 688 | * @abstract |
| 689 | 689 | * @param string $file Path to file. |
| 690 | - * @return int|bool Size of the file in bytes. |
|
| 690 | + * @return boolean Size of the file in bytes. |
|
| 691 | 691 | */ |
| 692 | 692 | public function size( $file ) { |
| 693 | 693 | return false; |
@@ -754,7 +754,7 @@ discard block |
||
| 754 | 754 | * Default true. |
| 755 | 755 | * @param bool $recursive Optional. Whether to recursively include file details in nested directories. |
| 756 | 756 | * Default false. |
| 757 | - * @return array|bool { |
|
| 757 | + * @return boolean { |
|
| 758 | 758 | * Array of files. False if unable to list directory contents. |
| 759 | 759 | * |
| 760 | 760 | * @type string $name Name of the file/directory. |
@@ -126,7 +126,7 @@ |
||
| 126 | 126 | /** |
| 127 | 127 | * @param string $file |
| 128 | 128 | * @param string $contents |
| 129 | - * @param bool|int $mode |
|
| 129 | + * @param string|boolean $mode |
|
| 130 | 130 | * @return bool |
| 131 | 131 | */ |
| 132 | 132 | public function put_contents($file, $contents, $mode = false ) { |
@@ -359,7 +359,7 @@ |
||
| 359 | 359 | |
| 360 | 360 | /** |
| 361 | 361 | * @param string $file |
| 362 | - * @return int |
|
| 362 | + * @return false|string |
|
| 363 | 363 | */ |
| 364 | 364 | public function size($file) { |
| 365 | 365 | return $this->ftp->filesize($file); |