Class: File_Archive_Reader_Uncompress

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

Class Overview

File_Archive_Reader
   |
   --File_Archive_Reader_Relay
      |
      --File_Archive_Reader_Uncompress

Recursively uncompress every file it finds

Variables

Methods

Inherited Variables

Class: File_Archive_Reader_Relay

File_Archive_Reader_Relay::$source

Inherited Methods

Class: File_Archive_Reader_Relay

File_Archive_Reader_Relay::File_Archive_Reader_Relay()
File_Archive_Reader_Relay::close()
File_Archive_Reader_Relay::getData()
File_Archive_Reader_Relay::getDataFilename()
File_Archive_Reader_Relay::getFilename()
File_Archive_Reader_Relay::getMime()
File_Archive_Reader_Relay::getStat()
File_Archive_Reader_Relay::makeAppendWriter()
File_Archive_Reader_Relay::makeWriterRemoveBlocks()
File_Archive_Reader_Relay::makeWriterRemoveFiles()
File_Archive_Reader_Relay::next()
File_Archive_Reader_Relay::rewind()
File_Archive_Reader_Relay::skip()
File_Archive_Reader_Relay::tell()

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]
Recursively uncompress every file it finds

[ Top ]

Class Variables

$baseDirProgression = 0

[line 84]

Var: We are selecting substr($baseDir, 0, $baseDirProgression)

Type:

int

[ Top ]

$currentFileNotDisplayed = false

[line 90]

Var: Flag set to indicate that the current file has not been displayed

Type:

boolean

[ Top ]

Method Detail

File_Archive_Reader_Uncompress (Constructor) [line 92]

File_Archive_Reader_Uncompress File_Archive_Reader_Uncompress(

&$innerReader, [
$uncompressionLevel = -1])

Parameters:

	`&$innerReader`	—
	`$uncompressionLevel`	—

[ Top ]

close [line 262]

void close(
)

See: File_Archive_Reader::close()

Overrides File_Archive_Reader_Relay::close() (parent method not documented)

[ Top ]

makeAppendWriter [line 291]

void makeAppendWriter(
)

See: File_Archive_Reader::makeAppendWriter()

Overrides File_Archive_Reader_Relay::makeAppendWriter() (parent method not documented)

[ Top ]

makeWriterRemoveFiles [line 305]

void makeWriterRemoveFiles(

$pred)

See: File_Archive_Reader::makeWriterRemoveFiles()

Overrides File_Archive_Reader_Relay::makeWriterRemoveFiles() (parent method not documented)

Parameters:

$pred —

[ Top ]

next [line 156]

void next(
)

See: File_Archive_Reader::close()

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

[ Top ]

select [line 236]

void select(

$filename, [
$close = true])

See: File_Archive_Reader::select()

Overrides File_Archive_Reader::select() (Move to the next file whose name is in directory $filename or is exactly $filename)

Parameters:

	`$filename`	—
	`$close`	—

[ Top ]

setBaseDir [line 215]

bool setBaseDir(

$baseDir)

Efficiently filter out the files which URL does not start with $baseDir

Throws an error if the $baseDir can't be found

Return: Whether baseDir was a directory or a file

Parameters:

$baseDir —

[ Top ]