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

Class: File_Archive_Reader_Directory

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

Class Overview

File_Archive_Reader
   |
   --File_Archive_Reader_Relay
      |
      --File_Archive_Reader_Directory

Recursively reads a directory


Methods


Inherited Variables

Inherited Methods

Class: File_Archive_Reader_Relay

File_Archive_Reader_Relay::File_Archive_Reader_Relay()
File_Archive_Reader_Relay::close()
File_Archive_Reader_Relay::getData()
File_Archive_Reader_Relay::getDataFilename()
File_Archive_Reader_Relay::getFilename()
File_Archive_Reader_Relay::getMime()
File_Archive_Reader_Relay::getStat()
File_Archive_Reader_Relay::makeAppendWriter()
File_Archive_Reader_Relay::makeWriterRemoveBlocks()
File_Archive_Reader_Relay::makeWriterRemoveFiles()
File_Archive_Reader_Relay::next()
File_Archive_Reader_Relay::rewind()
File_Archive_Reader_Relay::skip()
File_Archive_Reader_Relay::tell()

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 38]
Recursively reads a directory


[ Top ]


Method Detail

File_Archive_Reader_Directory (Constructor)   [line 64]

File_Archive_Reader_Directory File_Archive_Reader_Directory( $directory, [ $symbolic = ''], [ $maxRecurs = -1])

$directory is the path of the directory that must be read If $maxRecurs is specified, the subdirectories will be read up to a depth of $maxRecurs. In particular, if $maxRecurs == 0, the subdirectories won't be read.

Parameters:

   $directory   — 
   $symbolic   — 
   $maxRecurs   — 

[ Top ]

close   [line 76]

void close( )

  • See: File_Archive_Reader::close()

Overrides File_Archive_Reader_Relay::close() (parent method not documented)
[ Top ]

getData   [line 186]

void getData( [ $length = -1])

  • See: File_Archive_Reader::getData()

Overrides File_Archive_Reader_Relay::getData() (parent method not documented)

Parameters:

   $length   — 

[ Top ]

getDataFilename   [line 175]

void getDataFilename( )

  • See: File_Archive_Reader::getDataFilename()

Overrides File_Archive_Reader_Relay::getDataFilename() (parent method not documented)
[ Top ]

getFilename   [line 142]

void getFilename( )

  • See: File_Archive_Reader::getFilename()

Overrides File_Archive_Reader_Relay::getFilename() (parent method not documented)
[ Top ]

getLastSource   [line 258]

void &getLastSource( )


[ Top ]

getMime   [line 164]

void getMime( )

  • See: File_Archive_Reader::getMime()

Overrides File_Archive_Reader_Relay::getMime() (parent method not documented)
[ Top ]

getStat   [line 153]

void getStat( )

  • See: File_Archive_Reader::getStat()

Overrides File_Archive_Reader_Relay::getStat() (parent method not documented)
[ Top ]

makeAppendWriter   [line 292]

void makeAppendWriter( )

  • See: File_Archive_Reader::makeAppendWriter

Overrides File_Archive_Reader_Relay::makeAppendWriter() (parent method not documented)
[ Top ]

makeWriterRemoveBlocks   [line 271]

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

  • See: File_Archive_Reader::makeWriterRemoveBlocks()

Overrides File_Archive_Reader_Relay::makeWriterRemoveBlocks() (parent method not documented)

Parameters:

   $blocks   — 
   $seek   — 

[ Top ]

makeWriterRemoveFiles   [line 231]

void makeWriterRemoveFiles( $pred)

  • See: File_Archive_Reader::makeWriterRemoveFiles()

Overrides File_Archive_Reader_Relay::makeWriterRemoveFiles() (parent method not documented)

Parameters:

   $pred   — 

[ Top ]

next   [line 93]

void next( )

  • See: File_Archive_Reader::next() The files are returned in the same order as readdir

Overrides File_Archive_Reader_Relay::next() (parent method not documented)
[ Top ]

rewind   [line 208]

void rewind( [ $length = -1])

  • See: File_Archive_Reader::rewind()

Overrides File_Archive_Reader_Relay::rewind() (parent method not documented)

Parameters:

   $length   — 

[ Top ]

skip   [line 197]

void skip( [ $length = -1])

  • See: File_Archive_Reader::skip()

Overrides File_Archive_Reader_Relay::skip() (parent method not documented)

Parameters:

   $length   — 

[ Top ]

tell   [line 219]

void tell( )

  • See: File_Archive_Reader::tell()

Overrides File_Archive_Reader_Relay::tell() (parent method not documented)
[ Top ]


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