[edit] Last updated: Fri, 25 May 2012

ZipArchive::getFromIndex

(PHP 5 >= 5.2.0, PECL zip >= 1.3.0)

ZipArchive::getFromIndex — Returns the entry contents using its index

Description

mixed ZipArchive::getFromIndex ( int $index [, int $length = 0 [, int $flags ]] )

Returns the entry contents using its index.

Parameters

index

Index of the entry

length

The length to be read from the entry. If 0, then the entire entry is read.

flags

The flags to use to open the archive. the following values may be ORed to it.

ZIPARCHIVE::FL_UNCHANGED
ZIPARCHIVE::FL_COMPRESSED

Return Values

Returns the contents of the entry on success or FALSE on failure.

Examples

Example #1 Get the file contents


<?php
$zip = new ZipArchive;
if ($zip->open('test.zip') === TRUE) {
    echo $zip->getFromIndex(2);
    $zip->close();
} else {
    echo 'failed';
}
?>

add a note User Contributed Notes ZipArchive::getFromIndex

jana.vasseru 17-Aug-2007 06:26


Note that getFromIndex returns false for directories.

Clay Loveless 18-Mar-2007 10:44


If you'd like to use this method with the flags listed, you need to specify the length of the entry to retrieve as the second parameter, with the flags as the third parameter.



In otherwords, as indicated in the source:



string getFromIndex(string entryname[, int len [, int flags]])

add a note