Element index for package apidoc

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ w ]

a

$alreadyRead: in file Gzip.php, variable File_Archive_Reader_Gzip::$alreadyRead
$alreadyRead: in file Bzip2.php, variable File_Archive_Reader_Bzip2::$alreadyRead
addCurrentData: in file Mail.php, method File_Archive_Writer_Mail::addCurrentData()
Called when a file is finished and must be added as attachment to the mail
addHTMLImage: in file Mail.php, method File_Archive_Writer_Mail::addHTMLImage()
addSource: in file Multi.php, method File_Archive_Reader_Multi::addSource()
Add a new reader to the list of readers
appendFileData: in file Zip.php, method File_Archive_Writer_Zip::appendFileData()

top

b

$b: in file Multi.php, variable File_Archive_Writer_Multi::$b
$basePath: in file Files.php, variable File_Archive_Writer_Files::$basePath
$buffer: in file Tar.php, variable File_Archive_Writer_Tar::$buffer
$bzfile: in file Bzip2.php, variable File_Archive_Reader_Bzip2::$bzfile
$bzfile: in file Bzip2.php, variable File_Archive_Writer_Bzip2::$bzfile

top

c

$comment: in file Gzip.php, variable File_Archive_Writer_Gzip::$comment
$compressionLevel: in file Gzip.php, variable File_Archive_Writer_Gzip::$compressionLevel
$compressionLevel: in file Bzip2.php, variable File_Archive_Writer_Bzip2::$compressionLevel
$currentFilename: in file Zip.php, variable File_Archive_Reader_Zip::$currentFilename
$currentStat: in file Zip.php, variable File_Archive_Reader_Zip::$currentStat
clear: in file Memory.php, method File_Archive_Writer_Memory::clear()
Clear the buffer
close: in file Tar.php, method File_Archive_Reader_Tar::close()
close: in file Reader.php, method File_Archive_Reader::close()
Put back the reader in the state it was before the first call
close: in file Multi.php, method File_Archive_Reader_Multi::close()
close: in file Writer.php, method File_Archive_Writer::close()
Close the writer, eventually flush the data, write the footer...
close: in file Uncompress.php, method File_Archive_Reader_Uncompress::close()
close: in file Zip.php, method File_Archive_Reader_Zip::close()
close: in file Tar.php, method File_Archive_Writer_Tar::close()
close: in file Memory.php, method File_Archive_Reader_Memory::close()
close: in file Directory.php, method File_Archive_Reader_Directory::close()
close: in file Bzip2.php, method File_Archive_Reader_Bzip2::close()
close: in file Bzip2.php, method File_Archive_Writer_Bzip2::close()
Actually write the tmp file to the inner writer Close and delete temporary file
close: in file File.php, method File_Archive_Reader_File::close()
close: in file Files.php, method File_Archive_Writer_Files::close()
close: in file Mail.php, method File_Archive_Writer_Mail::close()
close: in file Gzip.php, method File_Archive_Reader_Gzip::close()
close: in file Gzip.php, method File_Archive_Writer_Gzip::close()
Actually write the tmp file to the inner writer Close and delete temporary file
close: in file Multi.php, method File_Archive_Writer_Multi::close()

top

d

$data: in file Zip.php, variable File_Archive_Reader_Zip::$data

top

e

extract: in file Reader.php, method File_Archive_Reader::extract()
Sends the whole reader to $writer
extractFile: in file Reader.php, method File_Archive_Reader::extractFile()
Extract only one file (given by the URL)

top

f

$filename: in file Tar.php, variable File_Archive_Writer_Tar::$filename
File_Archive: in file Archive.php, class File_Archive
Factory to access the most common File_Archive features
File_Archive_Predicate_TARCompatible: in file Tar.php, class File_Archive_Predicate_TARCompatible
File_Archive_Reader: in file Reader.php, class File_Archive_Reader
Abstract base class for all the readers
File_Archive_Reader_Bzip2: in file Bzip2.php, class File_Archive_Reader_Bzip2
Uncompress a file that was compressed in the Bzip2 format
File_Archive_Reader_Directory: in file Directory.php, class File_Archive_Reader_Directory
Recursively reads a directory
File_Archive_Reader_Directory: in file Directory.php, method File_Archive_Reader_Directory::File_Archive_Reader_Directory()
$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.
File_Archive_Reader_File: in file File.php, method File_Archive_Reader_File::File_Archive_Reader_File()
$filename is the physical file to read
File_Archive_Reader_File: in file File.php, class File_Archive_Reader_File
Reader that represents a single file
File_Archive_Reader_Gzip: in file Gzip.php, class File_Archive_Reader_Gzip
Uncompress a file that was compressed in the Gzip format
File_Archive_Reader_Memory: in file Memory.php, class File_Archive_Reader_Memory
A reader that takes its input from a memory buffer
File_Archive_Reader_Memory: in file Memory.php, method File_Archive_Reader_Memory::File_Archive_Reader_Memory()
File_Archive_Reader_Multi: in file Multi.php, class File_Archive_Reader_Multi
Regroups several readers to make them appear as a single one
File_Archive_Reader_Multi: in file Multi.php, method File_Archive_Reader_Multi::File_Archive_Reader_Multi()
File_Archive_Reader_Tar: in file Tar.php, class File_Archive_Reader_Tar
Read a tar archive
File_Archive_Reader_Uncompress: in file Uncompress.php, method File_Archive_Reader_Uncompress::File_Archive_Reader_Uncompress()
File_Archive_Reader_Uncompress: in file Uncompress.php, class File_Archive_Reader_Uncompress
Recursively uncompress every file it finds
File_Archive_Reader_Zip: in file Zip.php, class File_Archive_Reader_Zip
ZIP archive reader
File_Archive_Writer: in file Writer.php, class File_Archive_Writer
Base class for any writer
File_Archive_Writer_Bzip2: in file Bzip2.php, class File_Archive_Writer_Bzip2
Compress a single file to Bzip2 format
File_Archive_Writer_Files: in file Files.php, class File_Archive_Writer_Files
Writer to files
File_Archive_Writer_Files: in file Files.php, method File_Archive_Writer_Files::File_Archive_Writer_Files()
File_Archive_Writer_Gzip: in file Gzip.php, class File_Archive_Writer_Gzip
Compress a single file to Gzip format
File_Archive_Writer_Mail: in file Mail.php, class File_Archive_Writer_Mail
Send the files attached to a mail.
File_Archive_Writer_Mail: in file Mail.php, method File_Archive_Writer_Mail::File_Archive_Writer_Mail()
File_Archive_Writer_Memory: in file Memory.php, method File_Archive_Writer_Memory::File_Archive_Writer_Memory()
File_Archive_Writer_Memory: in file Memory.php, class File_Archive_Writer_Memory
Write the concatenation of the files in a buffer
File_Archive_Writer_Multi: in file Multi.php, class File_Archive_Writer_Multi
Write to several writers
File_Archive_Writer_Multi: in file Multi.php, method File_Archive_Writer_Multi::File_Archive_Writer_Multi()
File_Archive_Writer_Output: in file Output.php, method File_Archive_Writer_Output::File_Archive_Writer_Output()
File_Archive_Writer_Output: in file Output.php, class File_Archive_Writer_Output
Writer to the standard output
File_Archive_Writer_Tar: in file Tar.php, class File_Archive_Writer_Tar
Write the files as a TAR archive
File_Archive_Writer_Zip: in file Zip.php, method File_Archive_Writer_Zip::File_Archive_Writer_Zip()
File_Archive_Writer_Zip: in file Zip.php, class File_Archive_Writer_Zip
ZIP archive writer
filter: in file Archive.php, method File_Archive::filter()
Removes from a source the files that do not follow a given predicat
flush: in file Tar.php, method File_Archive_Writer_Tar::flush()

top

g

$gzfile: in file Gzip.php, variable File_Archive_Reader_Gzip::$gzfile
$gzfile: in file Gzip.php, variable File_Archive_Writer_Gzip::$gzfile
getData: in file Reader.php, method File_Archive_Reader::getData()
Reads some data from the current file
getData: in file Bzip2.php, method File_Archive_Reader_Bzip2::getData()
getData: in file Tar.php, method File_Archive_Reader_Tar::getData()
getData: in file Memory.php, method File_Archive_Reader_Memory::getData()
getData: in file Memory.php, method File_Archive_Writer_Memory::getData()
Retrieve the concatenated data The value is returned by reference for performance problems, but you should not manually modify it
getData: in file Zip.php, method File_Archive_Reader_Zip::getData()
getData: in file File.php, method File_Archive_Reader_File::getData()
getData: in file Gzip.php, method File_Archive_Reader_Gzip::getData()
getDataFilename: in file Reader.php, method File_Archive_Reader::getDataFilename()
If the current file of the archive is a physical file,
getDataFilename: in file File.php, method File_Archive_Reader_File::getDataFilename()
getFilename: in file Zip.php, method File_Archive_Reader_Zip::getFilename()
getFilename: in file Tar.php, method File_Archive_Reader_Tar::getFilename()
getFilename: in file Reader.php, method File_Archive_Reader::getFilename()
Returns the name of the file currently read by the reader
getFilename: in file Memory.php, method File_Archive_Reader_Memory::getFilename()
getFilename: in file Bzip2.php, method File_Archive_Reader_Bzip2::getFilename()
Return the name of the single file contained in the archive deduced from the name of the archive (the extension is removed)
getFilename: in file File.php, method File_Archive_Reader_File::getFilename()
getFilename: in file Directory.php, method File_Archive_Reader_Directory::getFilename()
getFilename: in file Gzip.php, method File_Archive_Reader_Gzip::getFilename()
Return the name of the single file contained in the archive deduced from the name of the archive (the extension is removed)
getMime: in file Tar.php, method File_Archive_Writer_Tar::getMime()
getMime: in file Reader.php, method File_Archive_Reader::getMime()
Returns the MIME associated with the current file
getMime: in file Zip.php, method File_Archive_Writer_Zip::getMime()
getMime: in file File.php, method File_Archive_Reader_File::getMime()
getMime: in file Memory.php, method File_Archive_Reader_Memory::getMime()
getStandardURL: in file Reader.php, method File_Archive_Reader::getStandardURL()
Returns the standard path
getStat: in file Zip.php, method File_Archive_Reader_Zip::getStat()
getStat: in file Memory.php, method File_Archive_Reader_Memory::getStat()
getStat: in file File.php, method File_Archive_Reader_File::getStat()
getStat: in file Reader.php, method File_Archive_Reader::getStat()
Returns an array of statistics about the file (see the PHP stat function for more information)
getStat: in file Tar.php, method File_Archive_Reader_Tar::getStat()

top

h

$header: in file Zip.php, variable File_Archive_Reader_Zip::$header

top

i

isEmpty: in file Memory.php, method File_Archive_Writer_Memory::isEmpty()
Returns true iif the buffer is empty
isKnownExtension: in file Uncompress.php, method File_Archive_Reader_Uncompress::isKnownExtension()
Check if File_Archive_Reader_Uncompress can read an archive with a specific extension
isTrue: in file Tar.php, method File_Archive_Predicate_TARCompatible::isTrue()

top

m

$mime: in file Memory.php, variable File_Archive_Writer_Memory::$mime
makeReader: in file Memory.php, method File_Archive_Writer_Memory::makeReader()
Create a reader from this writer

top

n

$nbFiles: in file Bzip2.php, variable File_Archive_Writer_Bzip2::$nbFiles
$nbFiles: in file Gzip.php, variable File_Archive_Writer_Gzip::$nbFiles
newFile: in file Mail.php, method File_Archive_Writer_Mail::newFile()
newFile: in file Memory.php, method File_Archive_Writer_Memory::newFile()
newFile: in file Output.php, method File_Archive_Writer_Output::newFile()
newFile: in file Multi.php, method File_Archive_Writer_Multi::newFile()
newFile: in file Tar.php, method File_Archive_Writer_Tar::newFile()
newFile: in file Gzip.php, method File_Archive_Writer_Gzip::newFile()
newFile: in file Bzip2.php, method File_Archive_Writer_Bzip2::newFile()
newFile: in file Writer.php, method File_Archive_Writer::newFile()
Create a new file in the writer
newFile: in file Files.php, method File_Archive_Writer_Files::newFile()
next: in file Tar.php, method File_Archive_Reader_Tar::next()
next: in file Zip.php, method File_Archive_Reader_Zip::next()
Go to next file entry in ZIP archive
next: in file Reader.php, method File_Archive_Reader::next()
Move to the next file in the reader
next: in file Uncompress.php, method File_Archive_Reader_Uncompress::next()
next: in file Memory.php, method File_Archive_Reader_Memory::next()
The subclass should overwrite this function to change the filename, stat
next: in file Bzip2.php, method File_Archive_Reader_Bzip2::next()
next: in file Directory.php, method File_Archive_Reader_Directory::next()
next: in file File.php, method File_Archive_Reader_File::next()
next: in file Multi.php, method File_Archive_Reader_Multi::next()
next: in file Gzip.php, method File_Archive_Reader_Gzip::next()
nextWithFolders: in file Zip.php, method File_Archive_Reader_Zip::nextWithFolders()
Go to next entry in ZIP archive This function may stop on a folder, so it does not comply to the File_Archive_Reader::next specs

top

o

$offset: in file Zip.php, variable File_Archive_Reader_Zip::$offset

top

p

predAnd: in file Archive.php, method File_Archive::predAnd()
Predicate that evaluates to the logical AND of the parameters You can add other predicates thanks to the File_Archive_Predicate_And::addPredicate() function
predCustom: in file Archive.php, method File_Archive::predCustom()
Custom predicate built by supplying a string expression
predEreg: in file Archive.php, method File_Archive::predEreg()
Evaluates to true iif the name of the file follow a given regular expression
predEregi: in file Archive.php, method File_Archive::predEregi()
Evaluates to true iif the name of the file follow a given regular expression (case insensitive version)
predExtension: in file Archive.php, method File_Archive::predExtension()
Evaluates to true iif the extension of the file is in a given list
predFalse: in file Archive.php, method File_Archive::predFalse()
Predicate that always evaluate to false
predMaxDepth: in file Archive.php, method File_Archive::predMaxDepth()
Evaluates to true iif the file has less that a given number of directories in its path
predMIME: in file Archive.php, method File_Archive::predMIME()
Evaluates to true iif the MIME type of the file is in a given list
predMinSize: in file Archive.php, method File_Archive::predMinSize()
Evaluates to true iif the file is larger than a given size
predMinTime: in file Archive.php, method File_Archive::predMinTime()
Evaluates to true iif the file has been modified after a given time
predNot: in file Archive.php, method File_Archive::predNot()
Negate a predicate
predOr: in file Archive.php, method File_Archive::predOr()
Predicate that evaluates to the logical OR of the parameters You can add other predicates thanks to the File_Archive_Predicate_Or::addPredicate() function
predTrue: in file Archive.php, method File_Archive::predTrue()
Predicate that always evaluate to true

top

r

read: in file Archive.php, method File_Archive::read()
readConcat: in file Archive.php, method File_Archive::readConcat()
Make the files of a source appear as one large file whose content is the concatenation of the content of all the files
readMemory: in file Archive.php, method File_Archive::readMemory()
Contains only one file with data read from a memory buffer
readMulti: in file Archive.php, method File_Archive::readMulti()
Contains several other sources. Take care the sources don't have several files with the same filename. The sources are given as a parameter, or can be added thanks to the reader addSource method
readSource: in file Archive.php, method File_Archive::readSource()
Create a reader to read the URL $URL.
registerStream: in file Archive.php, method File_Archive::registerStream()
Register a stream that allows an interface between File_Archive and PHP streams

top

s

$stat: in file Memory.php, variable File_Archive_Writer_Memory::$stat
$stats: in file Tar.php, variable File_Archive_Writer_Tar::$stats
select: in file Uncompress.php, method File_Archive_Reader_Uncompress::select()
select: in file Reader.php, method File_Archive_Reader::select()
Move to the next file whose name is in directory $filename or is exactly $filename
sendData: in file Reader.php, method File_Archive_Reader::sendData()
Sends the current file to the Writer $writer
sendFooter: in file Zip.php, method File_Archive_Writer_Zip::sendFooter()
setBaseDir: in file Uncompress.php, method File_Archive_Reader_Uncompress::setBaseDir()
Efficiently filter out the files which URL does not start with $baseDir
setComment: in file Zip.php, method File_Archive_Writer_Zip::setComment()
Set a comment on the ZIP file
setCompressionLevel: in file Zip.php, method File_Archive_Writer_Zip::setCompressionLevel()
Change the level of the compression. This may be done between two files
setCompressionLevel: in file Gzip.php, method File_Archive_Writer_Gzip::setCompressionLevel()
Set the compression level
setCompressionLevel: in file Bzip2.php, method File_Archive_Writer_Bzip2::setCompressionLevel()
Set the compression level
setHTMLBody: in file Mail.php, method File_Archive_Writer_Mail::setHTMLBody()
skip: in file Zip.php, method File_Archive_Reader_Zip::skip()
skip: in file Reader.php, method File_Archive_Reader::skip()
Skip some data and returns how many bytes have been skipped
skip: in file File.php, method File_Archive_Reader_File::skip()
skip: in file Memory.php, method File_Archive_Reader_Memory::skip()
skip: in file Tar.php, method File_Archive_Reader_Tar::skip()

top

t

$tmpName: in file Gzip.php, variable File_Archive_Writer_Gzip::$tmpName
$tmpName: in file Gzip.php, variable File_Archive_Reader_Gzip::$tmpName
$tmpName: in file Bzip2.php, variable File_Archive_Writer_Bzip2::$tmpName
$tmpName: in file Bzip2.php, variable File_Archive_Reader_Bzip2::$tmpName
toArchive: in file Archive.php, method File_Archive::toArchive()
Compress the data to a tar, gz, tar/gz or zip format
toFiles: in file Archive.php, method File_Archive::toFiles()
Write the files on the hard drive
toMail: in file Archive.php, method File_Archive::toMail()
Send the files as a mail attachment
toMemory: in file Archive.php, method File_Archive::toMemory()
Send the content of the files to a memory buffer
toMulti: in file Archive.php, method File_Archive::toMulti()
Duplicate the writing operation on two writers
toOutput: in file Archive.php, method File_Archive::toOutput()
Send the content of the files to the standard output (so to the client for a website)
toVariable: in file Archive.php, method File_Archive::toVariable()

top

u

$useBuffer: in file Tar.php, variable File_Archive_Writer_Tar::$useBuffer
uncompressData: in file Zip.php, method File_Archive_Reader_Zip::uncompressData()
unregisterStream: in file Archive.php, method File_Archive::unregisterStream()
Unregister the name returned by registerStream to free memory and resources

top

w

writeData: in file Bzip2.php, method File_Archive_Writer_Bzip2::writeData()
writeData: in file Output.php, method File_Archive_Writer_Output::writeData()
writeData: in file Tar.php, method File_Archive_Writer_Tar::writeData()
writeData: in file Multi.php, method File_Archive_Writer_Multi::writeData()
writeData: in file Memory.php, method File_Archive_Writer_Memory::writeData()
writeData: in file Files.php, method File_Archive_Writer_Files::writeData()
writeData: in file Writer.php, method File_Archive_Writer::writeData()
Append the specified data to the writer
writeData: in file Gzip.php, method File_Archive_Writer_Gzip::writeData()
writeData: in file Mail.php, method File_Archive_Writer_Mail::writeData()
writeFile: in file Writer.php, method File_Archive_Writer::writeFile()
Append the content of the physical file $filename to the writer writeFile($filename) must be equivalent to writeData(file_get_contents($filename)) but can be more efficient
writeFile: in file Multi.php, method File_Archive_Writer_Multi::writeFile()
writeFile: in file Output.php, method File_Archive_Writer_Output::writeFile()
writeFile: in file Tar.php, method File_Archive_Writer_Tar::writeFile()

top