Class: File_Archive_Reader_Zip

Source Location: /File_Archive-1.1.0/File/Archive/Reader/Zip.php

Class Overview

File_Archive_Reader
   |
   --File_Archive_Reader_Archive
      |
      --File_Archive_Reader_Zip

ZIP archive reader

Variables

Methods

Inherited Variables

Class: File_Archive_Reader_Archive

File_Archive_Reader_Archive::$source

Inherited Methods

Class: File_Archive_Reader_Archive

File_Archive_Reader_Archive::File_Archive_Reader_Archive()
File_Archive_Reader_Archive::close(): Close the source if it was given closed in the constructor
File_Archive_Reader_Archive::next()

Class: File_Archive_Reader

File_Archive_Reader::close(): Put back the reader in the state it was before the first call
File_Archive_Reader::extract(): Sends the whole reader to $writer
File_Archive_Reader::extractFile(): Extract only one file (given by the URL)
File_Archive_Reader::getData(): Reads some data from the current file
File_Archive_Reader::getDataFilename(): If the current file of the archive is a physical file,
File_Archive_Reader::getFilename(): Returns the name of the file currently read by the reader
File_Archive_Reader::getMime(): Returns the MIME associated with the current file
File_Archive_Reader::getStandardURL(): Returns the standard path
File_Archive_Reader::getStat(): Returns an array of statistics about the file (see the PHP stat function for more information)
File_Archive_Reader::makeAppendWriter()
File_Archive_Reader::makeWriter(): Returns a writer that will start writing at the current pos in the source
File_Archive_Reader::next(): Move to the next file in the reader
File_Archive_Reader::select(): Move to the next file whose name is in directory $filename or is exactly $filename
File_Archive_Reader::sendData(): Sends the current file to the Writer $writer
File_Archive_Reader::skip(): Skip some data and returns how many bytes have been skipped

Class Details

[line 38]
ZIP archive reader

Currently only allows to browse the archive (getData is not available)

[ Top ]

Class Variables

$currentFilename = null

[line 40]

Type:

mixed

[ Top ]

$currentStat = null

[line 41]

Type:

mixed

[ Top ]

$data = null

[line 44]

Type:

mixed

[ Top ]

$files = array()

[line 45]

Type:

mixed

[ Top ]

$header = null

[line 42]

Type:

mixed

[ Top ]

$offset = 0

[line 43]

Type:

mixed

[ Top ]

$seekToEnd = 0

[line 46]

Type:

mixed

[ Top ]

Method Detail

close [line 51]

void close(
[
$innerClose = true])

See: File_Archive_Reader::close()

Overrides File_Archive_Reader_Archive::close() (Close the source if it was given closed in the constructor)

Parameters:

$innerClose —

[ Top ]

getData [line 191]

void getData(
[
$length = -1])

See: File_Archive_Reader::getData()

Overrides File_Archive_Reader::getData() (Reads some data from the current file)

Parameters:

$length —

[ Top ]

getFilename [line 66]

void getFilename(
)

See: File_Archive_Reader::getFilename()

Overrides File_Archive_Reader::getFilename() (Returns the name of the file currently read by the reader)

[ Top ]

getStat [line 70]

void getStat(
)

See: File_Archive_Reader::getStat()

Overrides File_Archive_Reader::getStat() (Returns an array of statistics about the file (see the PHP stat function for more information))

[ Top ]

makeWriter [line 240]

void makeWriter(
[
$seek = 0])

See: File_Archive_Reader::makeWriter

Overrides File_Archive_Reader::makeWriter() (Returns a writer that will start writing at the current pos in the source)

Parameters:

$seek —

[ Top ]

next [line 172]

void next(
)

Go to next file entry in ZIP archive

This function will not stop on a folder entry

See: File_Archive_Reader::next()

Overrides File_Archive_Reader_Archive::next() (parent method not documented)

[ Top ]

nextWithFolders [line 79]

void nextWithFolders(
)

Go to next entry in ZIP archive This function may stop on a folder, so it does not comply to the File_Archive_Reader::next specs

See: File_Archive_Reader::next()

[ Top ]

skip [line 214]

void skip(

$length)

See: File_Archive_Reader::skip()

Overrides File_Archive_Reader::skip() (Skip some data and returns how many bytes have been skipped)

Parameters:

$length —

[ Top ]

uncompressData [line 218]

void uncompressData(
)

[ Top ]