Class: File_Archive_Reader_Tar

Source Location: /File_Archive-1.2.0/File/Archive/Reader/Tar.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 to next()
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(): This is equivalent to move to the end of the archive and calling makeWriter
File_Archive_Reader::makeWriter(): Returns a writer that will start writing at the current pos in the source Any data (from current file or any other file) located after current pos will be erased.
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]
Read a tar archive

[ Top ]

Class Variables

$seekToEnd = null

[line 67]

Var: nb bytes to seek back in order to reach the end of the archive or null if the end of the archive has not been reached

Type:

int

[ Top ]

Method Detail

close [line 83]

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

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

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

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

void makeWriter(
[
$seek = 0], [
$fileModif = true])

See: File_Archive_Reader::makeWriter

Overrides File_Archive_Reader::makeWriter() (Returns a writer that will start writing at the current pos in the source Any data (from current file or any other file) located after current pos will be erased.)

Parameters:

	`$seek`	—
	`$fileModif`	—

[ Top ]

next [line 104]

void next(
)

See: File_Archive_Reader::next()

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

[ Top ]

skip [line 72]

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 ]

Class: File_Archive_Reader_Tar

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

$seekToEnd = null

Method Detail

close [line 83]

Parameters:

getData [line 183]

Parameters:

getFilename [line 95]

getStat [line 99]

makeWriter [line 203]

Parameters:

next [line 104]

skip [line 72]

Parameters: