Class: File_Archive_Reader_Relay

Source Location: /File_Archive-1.2.0/File/Archive/Reader/Relay.php

Class Overview

File_Archive_Reader
   |
   --File_Archive_Reader_Relay

This reader appear exactly as $source does

Child classes:

File_Archive_Reader_AddBaseName: Add a directory to the public name of all the files of a reader

File_Archive_Reader_ChangeBaseName: Change a directory name to another

File_Archive_Reader_Select: Reader that keeps the files selected by File_Archive::select function

File_Archive_Reader_Uncompress: Recursively uncompress every file it finds

File_Archive_Reader_Multi: Regroups several readers to make them appear as a single one

File_Archive_Reader_Filter: Filter out the files that do not respect a given predicat

File_Archive_Reader_Directory: Recursively reads a directory

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 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 39]
This reader appear exactly as $source does

This is usefull if you want to dynamically change $source or change its behaviour

[ Top ]

Class Variables

$source =

[line 46]

Var: This reader will have the same comportment as $source
Access: protected

Type:

File_Archive_Reader

[ Top ]

Method Detail

File_Archive_Reader_Relay (Constructor) [line 48]

File_Archive_Reader_Relay File_Archive_Reader_Relay(

&$source)

Parameters:

&$source —

[ Top ]

close [line 84]

void close(
)

See: File_Archive_Reader::close()

Overridden in child classes as:

File_Archive_Reader_Uncompress::close()

File_Archive_Reader_Multi::close()

File_Archive_Reader_Directory::close()

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

[ Top ]

getData [line 76]

void getData(
[
$length = -1])

See: File_Archive_Reader::getData()

Overrides File_Archive_Reader::getData() (Reads some data from the current file)

Parameters:

$length —

[ Top ]

getDataFilename [line 72]

void getDataFilename(
)

See: File_Archive_Reader::getDataFilename()

Overrides File_Archive_Reader::getDataFilename() (If the current file of the archive is a physical file,)

[ Top ]

getFilename [line 60]

void getFilename(
)

See: File_Archive_Reader::getFilename()

Overridden in child classes as:

File_Archive_Reader_AddBaseName::getFilename()

File_Archive_Reader_ChangeBaseName::getFilename()

File_Archive_Reader_Directory::getFilename()

Overrides File_Archive_Reader::getFilename() (Returns the name of the file currently read by the reader)

[ Top ]

getMime [line 68]

void getMime(
)

See: File_Archive_Reader::getMime()

Overrides File_Archive_Reader::getMime() (Returns the MIME associated with the current file)

[ Top ]

getStat [line 64]

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

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

See: File_Archive_Reader::makeWriter

Overridden in child classes as:

File_Archive_Reader_Directory::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:

	`$fileModif`	—
	`$seek`	—

[ Top ]

next [line 56]

void next(
)

See: File_Archive_Reader::next()

Overridden in child classes as:

File_Archive_Reader_Select::next()

File_Archive_Reader_Uncompress::next()

File_Archive_Reader_Multi::next()

File_Archive_Reader_Filter::next()

File_Archive_Reader_Directory::next()

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

[ Top ]

skip [line 80]

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 ]