1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
|
<?php
// Start of zip v.1.12.4
class ZipArchive {
const CREATE = 1;
const EXCL = 2;
const CHECKCONS = 4;
const OVERWRITE = 8;
const FL_NOCASE = 1;
const FL_NODIR = 2;
const FL_COMPRESSED = 4;
const FL_UNCHANGED = 8;
const CM_DEFAULT = -1;
const CM_STORE = 0;
const CM_SHRINK = 1;
const CM_REDUCE_1 = 2;
const CM_REDUCE_2 = 3;
const CM_REDUCE_3 = 4;
const CM_REDUCE_4 = 5;
const CM_IMPLODE = 6;
const CM_DEFLATE = 8;
const CM_DEFLATE64 = 9;
const CM_PKWARE_IMPLODE = 10;
const CM_BZIP2 = 12;
const CM_LZMA = 14;
const CM_TERSE = 18;
const CM_LZ77 = 19;
const CM_WAVPACK = 97;
const CM_PPMD = 98;
const ER_OK = 0;
const ER_MULTIDISK = 1;
const ER_RENAME = 2;
const ER_CLOSE = 3;
const ER_SEEK = 4;
const ER_READ = 5;
const ER_WRITE = 6;
const ER_CRC = 7;
const ER_ZIPCLOSED = 8;
const ER_NOENT = 9;
const ER_EXISTS = 10;
const ER_OPEN = 11;
const ER_TMPOPEN = 12;
const ER_ZLIB = 13;
const ER_MEMORY = 14;
const ER_CHANGED = 15;
const ER_COMPNOTSUPP = 16;
const ER_EOF = 17;
const ER_INVAL = 18;
const ER_NOZIP = 19;
const ER_INTERNAL = 20;
const ER_INCONS = 21;
const ER_REMOVE = 22;
const ER_DELETED = 23;
const OPSYS_DOS = 0;
const OPSYS_AMIGA = 1;
const OPSYS_OPENVMS = 2;
const OPSYS_UNIX = 3;
const OPSYS_VM_CMS = 4;
const OPSYS_ATARI_ST = 5;
const OPSYS_OS_2 = 6;
const OPSYS_MACINTOSH = 7;
const OPSYS_Z_SYSTEM = 8;
const OPSYS_Z_CPM = 9;
const OPSYS_WINDOWS_NTFS = 10;
const OPSYS_MVS = 11;
const OPSYS_VSE = 12;
const OPSYS_ACORN_RISC = 13;
const OPSYS_VFAT = 14;
const OPSYS_ALTERNATE_MVS = 15;
const OPSYS_BEOS = 16;
const OPSYS_TANDEM = 17;
const OPSYS_OS_400 = 18;
const OPSYS_OS_X = 19;
const OPSYS_DEFAULT = 3;
/**
* Open a ZIP file archive
* @link http://www.php.net/manual/en/ziparchive.open.php
* @param filename string <p>
* The file name of the ZIP archive to open.
* </p>
* @param flags int[optional] <p>
* The mode to use to open the archive.
*
*
* <p>
* ZipArchive::OVERWRITE
* </p>
* @return mixed Error codes
*
* <p>
* Returns true on success or the error code.
*
*
* <p>
* ZipArchive::ER_EXISTS
* </p>
* <p>
* File already exists.
* </p>
*
*
* <p>
* ZipArchive::ER_INCONS
* </p>
* <p>
* Zip archive inconsistent.
* </p>
*
*
* <p>
* ZipArchive::ER_INVAL
* </p>
* <p>
* Invalid argument.
* </p>
*
*
* <p>
* ZipArchive::ER_MEMORY
* </p>
* <p>
* Malloc failure.
* </p>
*
*
* <p>
* ZipArchive::ER_NOENT
* </p>
* <p>
* No such file.
* </p>
*
*
* <p>
* ZipArchive::ER_NOZIP
* </p>
* <p>
* Not a zip archive.
* </p>
*
*
* <p>
* ZipArchive::ER_OPEN
* </p>
* <p>
* Can't open file.
* </p>
*
*
* <p>
* ZipArchive::ER_READ
* </p>
* <p>
* Read error.
* </p>
*
*
* <p>
* ZipArchive::ER_SEEK
* </p>
* <p>
* Seek error.
* </p>
*
*
* </p>
*/
public function open ($filename, $flags = null) {}
/**
* Set the password for the active archive
* @link http://www.php.net/manual/en/ziparchive.setpassword.php
* @param password string <p>
* The password to add to the archive.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function setPassword ($password) {}
/**
* Close the active archive (opened or newly created)
* @link http://www.php.net/manual/en/ziparchive.close.php
* @return bool Returns true on success, false on failure.
*/
public function close () {}
/**
* Returns the status error message, system and/or zip messages
* @link http://www.php.net/manual/en/ziparchive.getstatusstring.php
* @return string a string with the status message on success&return.falseforfailure;.
*/
public function getStatusString () {}
/**
* Add a new directory
* @link http://www.php.net/manual/en/ziparchive.addemptydir.php
* @param dirname string <p>
* The directory to add.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function addEmptyDir ($dirname) {}
/**
* Add a file to a ZIP archive using its contents
* @link http://www.php.net/manual/en/ziparchive.addfromstring.php
* @param localname string <p>
* The name of the entry to create.
* </p>
* @param contents string <p>
* The contents to use to create the entry. It is used in a binary
* safe mode.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function addFromString ($localname, $contents) {}
/**
* Adds a file to a ZIP archive from the given path
* @link http://www.php.net/manual/en/ziparchive.addfile.php
* @param filename string <p>
* The path to the file to add.
* </p>
* @param localname string[optional] <p>
* If supplied, this is the local name inside the ZIP archive that will override the filename.
* </p>
* @param start int[optional] <p>
* This parameter is not used but is required to extend ZipArchive.
* </p>
* @param length int[optional] <p>
* This parameter is not used but is required to extend ZipArchive.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function addFile ($filename, $localname = null, $start = null, $length = null) {}
/**
* Add files from a directory by glob pattern
* @link http://www.php.net/manual/en/ziparchive.addglob.php
* @param pattern
* @param flags[optional]
* @param options[optional]
*/
public function addGlob ($pattern, $flags, $options) {}
/**
* Add files from a directory by PCRE pattern
* @link http://www.php.net/manual/en/ziparchive.addpattern.php
* @param pattern
* @param path[optional]
* @param options[optional]
*/
public function addPattern ($pattern, $path, $options) {}
/**
* Renames an entry defined by its index
* @link http://www.php.net/manual/en/ziparchive.renameindex.php
* @param index int <p>
* Index of the entry to rename.
* </p>
* @param newname string <p>
* New name.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function renameIndex ($index, $newname) {}
/**
* Renames an entry defined by its name
* @link http://www.php.net/manual/en/ziparchive.renamename.php
* @param name string <p>
* Name of the entry to rename.
* </p>
* @param newname string <p>
* New name.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function renameName ($name, $newname) {}
/**
* Set the comment of a ZIP archive
* @link http://www.php.net/manual/en/ziparchive.setarchivecomment.php
* @param comment string <p>
* The contents of the comment.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function setArchiveComment ($comment) {}
/**
* Returns the Zip archive comment
* @link http://www.php.net/manual/en/ziparchive.getarchivecomment.php
* @param flags int[optional] <p>
* If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged
* comment is returned.
* </p>
* @return string the Zip archive comment&return.falseforfailure;.
*/
public function getArchiveComment ($flags = null) {}
/**
* Set the comment of an entry defined by its index
* @link http://www.php.net/manual/en/ziparchive.setcommentindex.php
* @param index int <p>
* Index of the entry.
* </p>
* @param comment string <p>
* The contents of the comment.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function setCommentIndex ($index, $comment) {}
/**
* Set the comment of an entry defined by its name
* @link http://www.php.net/manual/en/ziparchive.setcommentname.php
* @param name string <p>
* Name of the entry.
* </p>
* @param comment string <p>
* The contents of the comment.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function setCommentName ($name, $comment) {}
/**
* Returns the comment of an entry using the entry index
* @link http://www.php.net/manual/en/ziparchive.getcommentindex.php
* @param index int <p>
* Index of the entry
* </p>
* @param flags int[optional] <p>
* If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged
* comment is returned.
* </p>
* @return string the comment on success&return.falseforfailure;.
*/
public function getCommentIndex ($index, $flags = null) {}
/**
* Returns the comment of an entry using the entry name
* @link http://www.php.net/manual/en/ziparchive.getcommentname.php
* @param name string <p>
* Name of the entry
* </p>
* @param flags int[optional] <p>
* If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged
* comment is returned.
* </p>
* @return string the comment on success&return.falseforfailure;.
*/
public function getCommentName ($name, $flags = null) {}
/**
* delete an entry in the archive using its index
* @link http://www.php.net/manual/en/ziparchive.deleteindex.php
* @param index int <p>
* Index of the entry to delete.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function deleteIndex ($index) {}
/**
* delete an entry in the archive using its name
* @link http://www.php.net/manual/en/ziparchive.deletename.php
* @param name string <p>
* Name of the entry to delete.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function deleteName ($name) {}
/**
* Get the details of an entry defined by its name.
* @link http://www.php.net/manual/en/ziparchive.statname.php
* @param name string <p>
* Name of the entry
* </p>
* @param flags int[optional] <p>
* The flags argument specifies how the name lookup should be done.
* Also, ZipArchive::FL_UNCHANGED may be ORed to it to request
* information about the original file in the archive,
* ignoring any changes made.
*
*
* <p>
* ZipArchive::FL_NOCASE
* </p>
* @return array an array containing the entry details &return.falseforfailure;.
*/
public function statName ($name, $flags = null) {}
/**
* Get the details of an entry defined by its index.
* @link http://www.php.net/manual/en/ziparchive.statindex.php
* @param index int <p>
* Index of the entry
* </p>
* @param flags int[optional] <p>
* ZipArchive::FL_UNCHANGED may be ORed to it to request
* information about the original file in the archive,
* ignoring any changes made.
* </p>
* @return array an array containing the entry details&return.falseforfailure;.
*/
public function statIndex ($index, $flags = null) {}
/**
* Returns the index of the entry in the archive
* @link http://www.php.net/manual/en/ziparchive.locatename.php
* @param name string <p>
* The name of the entry to look up
* </p>
* @param flags int[optional] <p>
* The flags are specified by ORing the following values,
* or 0 for none of them.
*
*
* <p>
* ZipArchive::FL_NOCASE
* </p>
* @return int the index of the entry on success&return.falseforfailure;.
*/
public function locateName ($name, $flags = null) {}
/**
* Returns the name of an entry using its index
* @link http://www.php.net/manual/en/ziparchive.getnameindex.php
* @param index int <p>
* Index of the entry.
* </p>
* @param flags int[optional] <p>
* If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged
* name is returned.
* </p>
* @return string the name on success&return.falseforfailure;.
*/
public function getNameIndex ($index, $flags = null) {}
/**
* Revert all global changes done in the archive.
* @link http://www.php.net/manual/en/ziparchive.unchangearchive.php
* @return bool Returns true on success, false on failure.
*/
public function unchangeArchive () {}
/**
* Undo all changes done in the archive
* @link http://www.php.net/manual/en/ziparchive.unchangeall.php
* @return bool Returns true on success, false on failure.
*/
public function unchangeAll () {}
/**
* Revert all changes done to an entry at the given index
* @link http://www.php.net/manual/en/ziparchive.unchangeindex.php
* @param index int <p>
* Index of the entry.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function unchangeIndex ($index) {}
/**
* Revert all changes done to an entry with the given name.
* @link http://www.php.net/manual/en/ziparchive.unchangename.php
* @param name string <p>
* Name of the entry.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function unchangeName ($name) {}
/**
* Extract the archive contents
* @link http://www.php.net/manual/en/ziparchive.extractto.php
* @param destination string <p>
* Location where to extract the files.
* </p>
* @param entries mixed[optional] <p>
* The entries to extract. It accepts either a single entry name or
* an array of names.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function extractTo ($destination, $entries = null) {}
/**
* Returns the entry contents using its name
* @link http://www.php.net/manual/en/ziparchive.getfromname.php
* @param name string <p>
* Name of the entry
* </p>
* @param length int[optional] <p>
* The length to be read from the entry. If 0, then the
* entire entry is read.
* </p>
* @param flags int[optional] <p>
* The flags to use to open the archive. the following values may
* be ORed to it.
*
*
* <p>
* ZipArchive::FL_UNCHANGED
* </p>
* @return string the contents of the entry on success&return.falseforfailure;.
*/
public function getFromName ($name, $length = null, $flags = null) {}
/**
* Returns the entry contents using its index
* @link http://www.php.net/manual/en/ziparchive.getfromindex.php
* @param index int <p>
* Index of the entry
* </p>
* @param length int[optional] <p>
* The length to be read from the entry. If 0, then the
* entire entry is read.
* </p>
* @param flags int[optional] <p>
* The flags to use to open the archive. the following values may
* be ORed to it.
*
*
* <p>
* ZipArchive::FL_UNCHANGED
* </p>
* @return string the contents of the entry on success&return.falseforfailure;.
*/
public function getFromIndex ($index, $length = null, $flags = null) {}
/**
* Get a file handler to the entry defined by its name (read only).
* @link http://www.php.net/manual/en/ziparchive.getstream.php
* @param name string <p>
* The name of the entry to use.
* </p>
* @return resource a file pointer (resource) on success&return.falseforfailure;.
*/
public function getStream ($name) {}
/**
* Set the external attributes of an entry defined by its name
* @link http://www.php.net/manual/en/ziparchive.setexternalattributesname.php
* @param name string <p>
* Name of the entry.
* </p>
* @param opsys int <p>
* The operating system code defined by one of the ZipArchive::OPSYS_ constants.
* </p>
* @param attr int <p>
* The external attributes. Value depends on operating system.
* </p>
* @param flags int[optional] <p>
* Optional flags. Currently unused.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function setExternalAttributesName ($name, $opsys, $attr, $flags = null) {}
/**
* Set the external attributes of an entry defined by its index
* @link http://www.php.net/manual/en/ziparchive.setexternalattributesindex.php
* @param index int <p>
* Index of the entry.
* </p>
* @param opsys int <p>
* The operating system code defined by one of the ZipArchive::OPSYS_ constants.
* </p>
* @param attr int <p>
* The external attributes. Value depends on operating system.
* </p>
* @param flags int[optional] <p>
* Optional flags. Currently unused.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function setExternalAttributesIndex ($index, $opsys, $attr, $flags = null) {}
/**
* Retrieve the external attributes of an entry defined by its name
* @link http://www.php.net/manual/en/ziparchive.getexternalattributesname.php
* @param name string <p>
* Name of the entry.
* </p>
* @param opsys int <p>
* On success, receive the operating system code defined by one of the ZipArchive::OPSYS_ constants.
* </p>
* @param attr int <p>
* On success, receive the external attributes. Value depends on operating system.
* </p>
* @param flags int[optional] <p>
* If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged
* attributes are returned.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function getExternalAttributesName ($name, &$opsys, &$attr, $flags = null) {}
/**
* Retrieve the external attributes of an entry defined by its index
* @link http://www.php.net/manual/en/ziparchive.getexternalattributesindex.php
* @param index int <p>
* Index of the entry.
* </p>
* @param opsys int <p>
* On success, receive the operating system code defined by one of the ZipArchive::OPSYS_ constants.
* </p>
* @param attr int <p>
* On success, receive the external attributes. Value depends on operating system.
* </p>
* @param flags int[optional] <p>
* If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged
* attributes are returned.
* </p>
* @return bool Returns true on success, false on failure.
*/
public function getExternalAttributesIndex ($index, &$opsys, &$attr, $flags = null) {}
}
/**
* Open a ZIP file archive
* @link http://www.php.net/manual/en/function.zip-open.php
* @param filename string <p>
* The file name of the ZIP archive to open.
* </p>
* @return resource a resource handle for later use with
* zip_read and zip_close
* or returns the number of error if filename does not
* exist or in case of other error.
*/
function zip_open ($filename) {}
/**
* Close a ZIP file archive
* @link http://www.php.net/manual/en/function.zip-close.php
* @param zip resource <p>
* A ZIP file previously opened with zip_open.
* </p>
* @return void
*/
function zip_close ($zip) {}
/**
* Read next entry in a ZIP file archive
* @link http://www.php.net/manual/en/function.zip-read.php
* @param zip resource <p>
* A ZIP file previously opened with zip_open.
* </p>
* @return resource a directory entry resource for later use with the
* zip_entry_... functions, or false if
* there are no more entries to read, or an error code if an error
* occurred.
*/
function zip_read ($zip) {}
/**
* Open a directory entry for reading
* @link http://www.php.net/manual/en/function.zip-entry-open.php
* @param zip resource <p>
* A valid resource handle returned by zip_open.
* </p>
* @param zip_entry resource <p>
* A directory entry returned by zip_read.
* </p>
* @param mode string[optional] <p>
* Any of the modes specified in the documentation of
* fopen.
* </p>
*
* <p>
* Currently, mode is ignored and is always
* "rb". This is due to the fact that zip support
* in PHP is read only access.
* </p>
* @return bool Returns true on success, false on failure.
* </p>
*
* <p>
* Unlike fopen and other similar functions,
* the return value of zip_entry_open only
* indicates the result of the operation and is not needed for
* reading or closing the directory entry.
*/
function zip_entry_open ($zip, $zip_entry, $mode = null) {}
/**
* Close a directory entry
* @link http://www.php.net/manual/en/function.zip-entry-close.php
* @param zip_entry resource <p>
* A directory entry previously opened zip_entry_open.
* </p>
* @return bool Returns true on success, false on failure.
*/
function zip_entry_close ($zip_entry) {}
/**
* Read from an open directory entry
* @link http://www.php.net/manual/en/function.zip-entry-read.php
* @param zip_entry resource <p>
* A directory entry returned by zip_read.
* </p>
* @param length int[optional] <p>
* The number of bytes to return.
* </p>
*
* <p>
* This should be the uncompressed length you wish to read.
* </p>
* @return string the data read, empty string on end of a file, or false on error.
*/
function zip_entry_read ($zip_entry, $length = null) {}
/**
* Retrieve the actual file size of a directory entry
* @link http://www.php.net/manual/en/function.zip-entry-filesize.php
* @param zip_entry resource <p>
* A directory entry returned by zip_read.
* </p>
* @return int The size of the directory entry.
*/
function zip_entry_filesize ($zip_entry) {}
/**
* Retrieve the name of a directory entry
* @link http://www.php.net/manual/en/function.zip-entry-name.php
* @param zip_entry resource <p>
* A directory entry returned by zip_read.
* </p>
* @return string The name of the directory entry.
*/
function zip_entry_name ($zip_entry) {}
/**
* Retrieve the compressed size of a directory entry
* @link http://www.php.net/manual/en/function.zip-entry-compressedsize.php
* @param zip_entry resource <p>
* A directory entry returned by zip_read.
* </p>
* @return int The compressed size.
*/
function zip_entry_compressedsize ($zip_entry) {}
/**
* Retrieve the compression method of a directory entry
* @link http://www.php.net/manual/en/function.zip-entry-compressionmethod.php
* @param zip_entry resource <p>
* A directory entry returned by zip_read.
* </p>
* @return string The compression method.
*/
function zip_entry_compressionmethod ($zip_entry) {}
// End of zip v.1.12.4
?>
|