Class: File_Archive_Reader_Relay

Source Location: /File_Archive-1.5.5/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_ChangeName: Base class for readers that need to modify the name of files

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

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)

[ Top ]

getData [line 76]

void getData(
[
$length = -1])

See: File_Archive_Reader::getData()

Overridden in child classes as:

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

Overridden in child classes as:

File_Archive_Reader_Directory::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_ChangeName::getFilename(): Returns the name of the file currently read by the reader

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()

Overridden in child classes as:

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

Overridden in child classes as:

File_Archive_Reader_Directory::getStat()

Overrides File_Archive_Reader::getStat() (Returns an array of statistics about the file (see the PHP stat function for more information))

[ Top ]

makeAppendWriter [line 102]

void makeAppendWriter(
)

See: File_Archive_Reader::makeAppendWriter()

Overridden in child classes as:

File_Archive_Reader_Uncompress::makeAppendWriter()

File_Archive_Reader_Directory::makeAppendWriter()

Overrides 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.)

[ Top ]

makeWriterRemoveBlocks [line 124]

void makeWriterRemoveBlocks(

$blocks, [
$seek = 0])

See: File_Archive_Reader::makeWriterRemoveBlocks()

Overridden in child classes as:

File_Archive_Reader_Directory::makeWriterRemoveBlocks()

Overrides 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)

Parameters:

	`$blocks`	—
	`$seek`	—

[ Top ]

makeWriterRemoveFiles [line 113]

void makeWriterRemoveFiles(

$pred)

See: File_Archive_Reader::makeWriterRemoveFiles()

Overridden in child classes as:

File_Archive_Reader_Uncompress::makeWriterRemoveFiles()

File_Archive_Reader_Directory::makeWriterRemoveFiles()

Overrides 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.)

Parameters:

$pred —

[ 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 or folder in the reader)

[ Top ]

rewind [line 84]

void rewind(
[
$length = -1])

See: File_Archive_Reader::rewind()

Overridden in child classes as:

File_Archive_Reader_Directory::rewind()

Overrides File_Archive_Reader::rewind() (Move the current position back of a given amount of bytes.)

Parameters:

$length —

[ Top ]

skip [line 80]

void skip(
[
$length = -1])

See: File_Archive_Reader::skip()

Overridden in child classes as:

File_Archive_Reader_Directory::skip()

Overrides File_Archive_Reader::skip() (Skip some data and returns how many bytes have been skipped)

Parameters:

$length —

[ Top ]

tell [line 88]

void tell(
)

See: File_Archive_Reader::tell()

Overridden in child classes as:

File_Archive_Reader_Directory::tell()

Overrides File_Archive_Reader::tell() (Returns the current offset in the current file)

[ Top ]