Class: File_Archive_Reader_File

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

Class Overview

File_Archive_Reader
   |
   --File_Archive_Reader_File

Reader that represents a single file

Methods

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::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 74]

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

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)

[ Top ]

getData [line 169]

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

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

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

void getMime(
)

See: File_Archive_Reader::getMime

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

[ Top ]

getStat [line 131]

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 ]

next [line 102]

void next(
)

See: File_Archive_Reader::next() The first time next is called, it will open the file handle and return true. Then if 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 195]

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 ]