Class: File_Archive_Reader_File

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

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 38]
Reader that represents a single file

[ Top ]

Method Detail

File_Archive_Reader_File (Constructor) [line 67]

File_Archive_Reader_File File_Archive_Reader_File(

$filename, [
$symbolic = null])

$filename is the physical file to read

$symbolic is the name declared by the reader If $symbolic is not specified, $filename is assumed

Parameters:

	`$filename`	—
	`$symbolic`	—

[ Top ]

close [line 81]

void close(
)

See: File_Archive_Reader::close() Close the file handle

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

[ Top ]

getData [line 152]

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

void getDataFilename(
)

See: File_Archive_Reader::getDataFilename() Return the name of the file

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

[ Top ]

getFilename [line 113]

void getFilename(
)

See: File_Archive_Reader::getFilename()

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

[ Top ]

getMime [line 139]

void getMime(
)

See: File_Archive_Reader::getMime

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

[ Top ]

getStat [line 123]

void getStat(
)

See: File_Archive_Reader::getStat() stat()

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

[ Top ]

makeWriter [line 187]

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

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:

	`$fileModif`	—
	`$seek`	—

[ Top ]

next [line 95]

void next(
)

See: File_Archive_Reader::next() The first time next is called, it will open the file handle and return true. Then it will return false Raise an error if the file does not exist

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

[ Top ]

skip [line 174]

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_File

Class Overview

Methods

Inherited Variables

Inherited Methods

Class: File_Archive_Reader

Class Details

Method Detail

File_Archive_Reader_File (Constructor) [line 67]

Parameters:

close [line 81]

getData [line 152]

Parameters:

getDataFilename [line 119]

getFilename [line 113]

getMime [line 139]

getStat [line 123]

makeWriter [line 187]

Parameters:

next [line 95]

skip [line 174]

Parameters: