apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: File_Archive_Reader_Uncompress

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

Class Overview

File_Archive_Reader
   |
   --File_Archive_Reader_Relay
      |
      --File_Archive_Reader_Uncompress

Recursively uncompress every file it finds


Methods


Inherited Variables

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::next()
File_Archive_Reader_Relay::skip()

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


[ Top ]


Method Detail

File_Archive_Reader_Uncompress (Constructor)   [line 81]

File_Archive_Reader_Uncompress File_Archive_Reader_Uncompress( mixed &$innerReader, [mixed $uncompressionLevel = -1])


[ Top ]

close   [line 275]

void close( )

  • See: File_Archive_Reader::close()

Overrides File_Archive_Reader_Relay::close() (parent method not documented)
[ Top ]

isKnownExtension   [line 98]

bool isKnownExtension( string $extension)

Check if File_Archive_Reader_Uncompress can read an archive with a specific extension
  • Return: whether this file can be read by File_Archive_Reader_Uncompress
  • Static: This method can be called statically

Parameters:

string   $extension     the extension of the archive to read

[ Top ]

next   [line 177]

void next( )

  • See: File_Archive_Reader::close()

Overrides File_Archive_Reader_Relay::next() (parent method not documented)
[ Top ]

select   [line 244]

void select( mixed $filename, [mixed $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)
[ Top ]

setBaseDir   [line 227]

bool setBaseDir( mixed $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

[ Top ]


Documentation generated on Thu, 24 Feb 2005 12:50:22 -0500 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.