apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: File_Archive_Reader_Memory

Source Location: /File_Archive-0.2.0/File/Archive/Reader/Memory.php

Class Overview

File_Archive_Reader
   |
   --File_Archive_Reader_Memory

A reader that takes its input from a memory buffer


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 37]
A reader that takes its input from a memory buffer


[ Top ]


Method Detail

File_Archive_Reader_Memory (Constructor)   [line 79]

File_Archive_Reader_Memory File_Archive_Reader_Memory( string &$memory, string $filename, [array $stat = array()], [string $mime = null])


Parameters:

string   $memory     is the content of the file. This parameter is passed as a reference for performance reasons. The content should not be changer after the constructor
string   $filename     is the name of the file
array   $stat     are the statistics of the file. The size will be recomputed from $memory
string   $mime     is the mime type of the file

[ Top ]

close   [line 148]

void close( )

  • See: File_Archive_Reader::close()

Overrides File_Archive_Reader::close() (Put back the reader in the state it was before the first call)
[ Top ]

getData   [line 122]

void getData( [mixed $length = -1])

  • See: File_Archive_Reader::getData()

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

getFilename   [line 106]

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

void getMime( )

  • See: File_Archive_Reader::getMime()

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

getStat   [line 110]

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 ]

next   [line 93]

void next( )

The subclass should overwrite this function to change the filename, stat

and memory


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

skip   [line 139]

void skip( mixed $length)

  • See: File_Archive_Reader::skip()

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


Documentation generated on Thu, 24 Feb 2005 12:50:18 -0500 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.