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

Class: File_Archive_Reader_Archive

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

Class Overview

File_Archive_Reader
   |
   --File_Archive_Reader_Archive

Base class for all the archive readers (that read from a single file)


Variables

Methods


Child classes:

File_Archive_Reader_Gzip
Uncompress a file that was compressed in the Gzip format
File_Archive_Reader_Tar
Read a tar archive
File_Archive_Reader_Bzip2
Uncompress a file that was compressed in the Bzip2 format
File_Archive_Reader_Zip
ZIP archive reader

Inherited Variables

Inherited Methods

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 37]
Base class for all the archive readers (that read from a single file)


[ Top ]


Class Variables

$source =  null

[line 44]

  • Var: Single file source that contains the archive to uncompress
  • Access: protected

Type:   File_Archive_Reader


[ Top ]



Method Detail

File_Archive_Reader_Archive (Constructor)   [line 77]

File_Archive_Reader_Archive File_Archive_Reader_Archive( &$source, [ $sourceOpened = false])


Parameters:

   &$source   — 
   $sourceOpened   — 

[ Top ]

close   [line 88]

void close( [bool $innerClose = true])

Close the source if it was given closed in the constructor
  • See: File_Archive_Reader::close()

Overridden in child classes as:

File_Archive_Reader_Gzip::close()
File_Archive_Reader_Tar::close()
File_Archive_Reader_Bzip2::close()
File_Archive_Reader_Zip::close()

Overrides File_Archive_Reader::close() (Put back the reader in the state it was before the first call)

Parameters:

bool   $innerClose   —  if false, the inner source won't be closed

[ Top ]

next   [line 66]

void next( )

  • See: File_Archive_Reader::next() Open the source if necessary

Overridden in child classes as:

File_Archive_Reader_Gzip::next()
File_Archive_Reader_Tar::next()
File_Archive_Reader_Bzip2::next()
File_Archive_Reader_Zip::next()
Go to next file entry in ZIP archive

Overrides File_Archive_Reader::next() (Move to the next file in the reader)
[ Top ]


Documentation generated on Mon, 11 Mar 2019 14:20:31 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.