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

Class: File_Archive_Reader_Directory

Source Location: /File_Archive-1.1.0/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::makeWriter()
File_Archive_Reader_Relay::next()
File_Archive_Reader_Relay::skip()

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::makeAppendWriter()
File_Archive_Reader::makeWriter()
Returns a writer that will start writing at the current pos in the source
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]
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 75]

void close( )

  • See: File_Archive_Reader::close()

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

getFilename   [line 133]

void getFilename( )

  • See: File_Archive_Reader::getFilename()

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

makeWriter   [line 138]

void makeWriter( [ $seek = 0])

  • See: File_Archive_Reader::makeWriter

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

Parameters:

   $seek   — 

[ Top ]

next   [line 89]

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 ]


Documentation generated on Mon, 11 Mar 2019 14:20:31 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.