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

Class: File_Archive_Reader_Cache

Source Location: /File_Archive-1.5.5/File/Archive/Reader/Cache.php

Class Overview

File_Archive_Reader
   |
   --File_Archive_Reader_Cache

This reader caches the files of another reader


Variables

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 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 41]
This reader caches the files of another reader

It allow fast access to files. This is usefull if the access to the reader is slow (HTTP, FTP...), but will need more IO if the file is only extracted



[ Top ]


Class Variables

$endOfSource =  false

[line 47]


Type:   mixed


[ Top ]

$files = array()

[line 44]


Type:   mixed


[ Top ]

$fromSource =  true

[line 46]


Type:   mixed


[ Top ]

$pos =  0

[line 45]


Type:   mixed


[ Top ]

$source =

[line 48]


Type:   mixed


[ Top ]

$tmpFile =

[line 43]


Type:   mixed


[ Top ]



Method Detail

File_Archive_Reader_Cache (Constructor)   [line 53]

File_Archive_Reader_Cache File_Archive_Reader_Cache( &$source)

$source is the reader to filter

Parameters:

   &$source   — 

[ Top ]

close   [line 210]

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

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

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

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

void getMime( )

  • See: File_Archive_Reader::getMime()

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

getStat   [line 114]

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 ]

makeAppendWriter   [line 229]

void makeAppendWriter( )

  • See: File_Archive_Reader::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 252]

void makeWriterRemoveBlocks( $blocks, [ $seek = 0])

  • See: File_Archive_Reader::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 241]

void makeWriterRemoveFiles( $pred)

  • See: File_Archive_Reader::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 69]

void next( )

  • See: File_Archive_Reader::next()

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

rewind   [line 189]

void rewind( [ $length = -1])

  • See: File_Archive_Reader::rewind()

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

Parameters:

   $length   — 

[ Top ]

skip   [line 163]

void skip( [ $length = -1])

  • See: File_Archive_Reader::skip()

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

Parameters:

   $length   — 

[ Top ]

tell   [line 203]

void tell( )

  • See: File_Archive_Reader::tell()

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


Documentation generated on Mon, 11 Mar 2019 15:48:27 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.