Class: File_Archive_Reader_Zip

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

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 and close the reader
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::getFileList(): Returns the list of filenames from the current pos to the end of the source The source will be closed after having called this function This function goes through the whole archive (which may be slow).
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(): Return a writer that allows appending files to the archive After having called makeAppendWriter, $this is closed and should not be used until the returned writer is closed.
File_Archive_Reader::makeWriterRemove(): Returns a writer that removes the current file
File_Archive_Reader::makeWriterRemoveBlocks(): Return a writer that has the same properties as the one returned by makeWriter, but after having removed a block of data from the current file. The writer will append data to the current file no data (other than the block) will be removed
File_Archive_Reader::makeWriterRemoveFiles(): Return a writer that has the same properties as the one returned by makeAppendWriter, but after having removed all the files that follow a given predicate.
File_Archive_Reader::next(): Move to the next file or folder in the reader
File_Archive_Reader::remove(): Removes the current file from the reader
File_Archive_Reader::rewind(): Move the current position back of a given amount of bytes.
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
File_Archive_Reader::tell(): Returns the current offset in the current file

Class Details

[line 38]
ZIP archive reader

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

[ Top ]

Class Variables

$centralDirectory = null

[line 48]

Type:

mixed

[ Top ]

$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 53]

void close(
)

See: File_Archive_Reader::close()

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

[ Top ]

getData [line 193]

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 69]

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 73]

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 ]

makeAppendWriter [line 381]

void makeAppendWriter(
)

See: File_Archive_Reader::makeAppendWriter

Overrides File_Archive_Reader::makeAppendWriter() (Return a writer that allows appending files to the archive After having called makeAppendWriter, $this is closed and should not be used until the returned writer is closed.)

[ Top ]

makeWriterRemoveBlocks [line 341]

void makeWriterRemoveBlocks(

$blocks, [
$seek = 0])

See: File_Archive_Reader::makeWriterRemoveBlocks()

Overrides File_Archive_Reader::makeWriterRemoveBlocks() (Return a writer that has the same properties as the one returned by makeWriter, but after having removed a block of data from the current file. The writer will append data to the current file no data (other than the block) will be removed)

Parameters:

	`$blocks`	—
	`$seek`	—

[ Top ]

makeWriterRemoveFiles [line 272]

void makeWriterRemoveFiles(

$pred)

See: File_Archive_Reader::makeWriterRemoveFiles()

Overrides File_Archive_Reader::makeWriterRemoveFiles() (Return a writer that has the same properties as the one returned by makeAppendWriter, but after having removed all the files that follow a given predicate.)

Parameters:

$pred —

[ Top ]

next [line 80]

void next(
)

Go to next entry in ZIP archive

See: File_Archive_Reader::next()

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

[ Top ]

readCentralDirectory [line 441]

void readCentralDirectory(
)

This function will fill the central directory variable

and seek back to where it was called

[ Top ]

rewind [line 229]

void rewind(
[
$length = -1])

See: File_Archive_Reader::rewind()

Overrides File_Archive_Reader::rewind() (Move the current position back of a given amount of bytes.)

Parameters:

$length —

[ Top ]

seekToEndOfCentralDirectory [line 410]

void seekToEndOfCentralDirectory(
)

This function seeks to the start of the [end of central directory] field, just after the \x50\x4b\x05\x06 signature and returns the number of bytes skipped

The stream must initially be positioned before the end of central directory

[ Top ]

skip [line 216]

void skip(
[
$length = -1])

See: File_Archive_Reader::skip()

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

Parameters:

$length —

[ Top ]

tell [line 242]

void tell(
)

See: File_Archive_Reader::tell()

Overrides File_Archive_Reader::tell() (Returns the current offset in the current file)

[ Top ]

uncompressData [line 247]

void uncompressData(
)

[ Top ]

Class: File_Archive_Reader_Zip

Class Overview

Variables

Methods

Inherited Variables

Class: File_Archive_Reader_Archive

Inherited Methods

Class: File_Archive_Reader_Archive

Class: File_Archive_Reader

Class Details

Class Variables

$centralDirectory = null

$currentFilename = null

$currentStat = null

$data = null

$files = array()

$header = null

$offset = 0

$seekToEnd = 0

Method Detail

close [line 53]

getData [line 193]

Parameters:

getFilename [line 69]

getStat [line 73]

makeAppendWriter [line 381]

makeWriterRemoveBlocks [line 341]

Parameters:

makeWriterRemoveFiles [line 272]

Parameters:

next [line 80]

readCentralDirectory [line 441]

rewind [line 229]

Parameters:

seekToEndOfCentralDirectory [line 410]

skip [line 216]

Parameters:

tell [line 242]

uncompressData [line 247]