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 Bzip2.php, variable File_Archive_Reader_Bzip2::$alreadyRead
- $alreadyRead
- in file Gzip.php, variable File_Archive_Reader_Gzip::$alreadyRead
- $autoClose
- in file Gzip.php, variable File_Archive_Writer_Gzip::$autoClose
- $autoClose
- in file Bzip2.php, variable File_Archive_Writer_Bzip2::$autoClose
- 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()
- addPredicate
- in file And.php, method File_Archive_Predicate_And::addPredicate()
Add a new predicate to the list
- addPredicate
- in file Or.php, method File_Archive_Predicate_Or::addPredicate()
Add a new predicate to the list
- addSource
- in file Multi.php, method File_Archive_Reader_Multi::addSource()
Add a new reader to the list of readers
- appendFile
- in file MemoryArchive.php, method File_Archive_Writer_MemoryArchive::appendFile()
The subclass may rewrite this class if it knows an efficient way to treat a physical file.
- appendFileData
- in file Zip.php, method File_Archive_Writer_Zip::appendFileData()
- appendFileData
- in file MemoryArchive.php, method File_Archive_Writer_MemoryArchive::appendFileData()
The subclass must treat the data $data $data is the entire data of the filename $filename $stat is the stat of the file
top
top
c
- $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 Relay.php, method File_Archive_Reader_Relay::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_Writer_Multi::close()
- close
- in file Multi.php, method File_Archive_Reader_Multi::close()
- close
- in file Tar.php, method File_Archive_Writer_Tar::close()
- close
- in file Zip.php, method File_Archive_Reader_Zip::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 MemoryArchive.php, method File_Archive_Writer_MemoryArchive::close()
- close
- in file Tar.php, method File_Archive_Reader_Tar::close()
- close
- in file Memory.php, method File_Archive_Reader_Memory::close()
- close
- in file Concat.php, method File_Archive_Reader_Concat::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 Archive.php, method File_Archive_Writer_Archive::close()
- close
- in file Directory.php, method File_Archive_Reader_Directory::close()
- close
- in file File.php, method File_Archive_Reader_File::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 Files.php, method File_Archive_Writer_Files::close()
- close
- in file Archive.php, method File_Archive_Reader_Archive::close()
top
top
top
f
- $filename
- in file Concat.php, variable File_Archive_Reader_Concat::$filename
- $filename
- in file Gzip.php, variable File_Archive_Writer_Gzip::$filename
- $filename
- in file Tar.php, variable File_Archive_Writer_Tar::$filename
- $filename
- in file Bzip2.php, variable File_Archive_Writer_Bzip2::$filename
- File_Archive
- in file Archive.php, class File_Archive
Factory to access the most common File_Archive features
- File_Archive_Predicate
- in file Predicate.php, class File_Archive_Predicate
A predicate is an object that can evaluate to true or false depending on the file currently read by a File_Archive_Reader
- File_Archive_Predicate_And
- in file Or.php, method File_Archive_Predicate_Or::File_Archive_Predicate_And()
Build the predicate using the optional File_Archive_Predicates given as arguments
- File_Archive_Predicate_And
- in file And.php, class File_Archive_Predicate_And
Evaluates to true iif all predicates given as constructor parameters evaluate to true
- File_Archive_Predicate_And
- in file And.php, method File_Archive_Predicate_And::File_Archive_Predicate_And()
Build the predicate using the optional File_Archive_Predicates given as arguments
- File_Archive_Predicate_Custom
- in file Custom.php, class File_Archive_Predicate_Custom
Custom predicate built by supplying a string expression
- File_Archive_Predicate_Custom
- in file Custom.php, method File_Archive_Predicate_Custom::File_Archive_Predicate_Custom()
- File_Archive_Predicate_Ereg
- in file Ereg.php, class File_Archive_Predicate_Ereg
Keep only the files which name follow a given regular expression
- File_Archive_Predicate_Ereg
- in file Ereg.php, method File_Archive_Predicate_Ereg::File_Archive_Predicate_Ereg()
- File_Archive_Predicate_Eregi
- in file Eregi.php, method File_Archive_Predicate_Eregi::File_Archive_Predicate_Eregi()
- File_Archive_Predicate_Eregi
- in file Eregi.php, class File_Archive_Predicate_Eregi
Keep only the files which name follow a given case insensitive regular expression
- File_Archive_Predicate_Extension
- in file Extension.php, method File_Archive_Predicate_Extension::File_Archive_Predicate_Extension()
- File_Archive_Predicate_Extension
- in file Extension.php, class File_Archive_Predicate_Extension
Keep only the files that have a specific extension
- File_Archive_Predicate_False
- in file False.php, class File_Archive_Predicate_False
Always evaluate to false
- File_Archive_Predicate_MaxDepth
- in file MaxDepth.php, class File_Archive_Predicate_MaxDepth
Remove the URLs with a too high number of nested directories
- File_Archive_Predicate_MaxDepth
- in file MaxDepth.php, method File_Archive_Predicate_MaxDepth::File_Archive_Predicate_MaxDepth()
- File_Archive_Predicate_MIME
- in file MIME.php, method File_Archive_Predicate_MIME::File_Archive_Predicate_MIME()
- File_Archive_Predicate_MIME
- in file MIME.php, class File_Archive_Predicate_MIME
Keep only the files that have a specific MIME type
- File_Archive_Predicate_MinSize
- in file MinSize.php, method File_Archive_Predicate_MinSize::File_Archive_Predicate_MinSize()
- File_Archive_Predicate_MinSize
- in file MinSize.php, class File_Archive_Predicate_MinSize
Keep only the files larger than a given size
- File_Archive_Predicate_MinTime
- in file MinTime.php, method File_Archive_Predicate_MinTime::File_Archive_Predicate_MinTime()
- File_Archive_Predicate_MinTime
- in file MinTime.php, class File_Archive_Predicate_MinTime
Keep only the files modified after a given date (or with unknown modification date)
- File_Archive_Predicate_Not
- in file Not.php, class File_Archive_Predicate_Not
Evaluates to true iif the predicate given in parameter evaluates to false
- File_Archive_Predicate_Not
- in file Not.php, method File_Archive_Predicate_Not::File_Archive_Predicate_Not()
- File_Archive_Predicate_Or
- in file Or.php, class File_Archive_Predicate_Or
Evaluates to true iif one at least of the predicates given as constructor parameters evaluate to true
- File_Archive_Predicate_TARCompatible
- in file Tar.php, class File_Archive_Predicate_TARCompatible
A predicate is an object that can evaluate to true or false depending on the file currently read by a File_Archive_Reader
- File_Archive_Predicate_True
- in file True.php, class File_Archive_Predicate_True
Always evaluate to true
- File_Archive_Reader
- in file Reader.php, class File_Archive_Reader
Abstract base class for all the readers
- File_Archive_Reader_AddBaseName
- in file ChangeName.php, class File_Archive_Reader_AddBaseName
Add a directory to the public name of all the files of a reader
- File_Archive_Reader_AddBaseName
- in file ChangeName.php, method File_Archive_Reader_AddBaseName::File_Archive_Reader_AddBaseName()
- File_Archive_Reader_Archive
- in file Archive.php, class File_Archive_Reader_Archive
Base class for all the archive readers (that read from a single file)
- File_Archive_Reader_Archive
- in file Archive.php, method File_Archive_Reader_Archive::File_Archive_Reader_Archive()
- 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_ChangeBaseName
- in file ChangeName.php, method File_Archive_Reader_ChangeBaseName::File_Archive_Reader_ChangeBaseName()
- File_Archive_Reader_ChangeBaseName
- in file ChangeName.php, class File_Archive_Reader_ChangeBaseName
Change a directory name to another
- File_Archive_Reader_Concat
- in file Concat.php, class File_Archive_Reader_Concat
This reader provides one single file that is the concatenation of the data of
- File_Archive_Reader_Concat
- in file Concat.php, method File_Archive_Reader_Concat::File_Archive_Reader_Concat()
- 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_Directory
- in file Directory.php, class File_Archive_Reader_Directory
Recursively reads a directory
- File_Archive_Reader_File
- in file File.php, class File_Archive_Reader_File
Reader that represents a single file
- 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_Filter
- in file Filter.php, class File_Archive_Reader_Filter
Filter out the files that do not respect a given predicat
- File_Archive_Reader_Filter
- in file Filter.php, method File_Archive_Reader_Filter::File_Archive_Reader_Filter()
$source is the reader to filter
- 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_Relay
- in file Relay.php, class File_Archive_Reader_Relay
This reader appear exactly as $source does
- File_Archive_Reader_Relay
- in file Relay.php, method File_Archive_Reader_Relay::File_Archive_Reader_Relay()
- File_Archive_Reader_Select
- in file Select.php, class File_Archive_Reader_Select
Reader that keeps the files selected by File_Archive::select function
- File_Archive_Reader_Select
- in file Select.php, method File_Archive_Reader_Select::File_Archive_Reader_Select()
$source is the reader to filter
- 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_Archive
- in file Archive.php, class File_Archive_Writer_Archive
Base class for all the transformation writers that will generate one single
- File_Archive_Writer_Archive
- in file Archive.php, method File_Archive_Writer_Archive::File_Archive_Writer_Archive()
- File_Archive_Writer_Bzip2
- in file Bzip2.php, class File_Archive_Writer_Bzip2
Compress a single file to Bzip2 format
- File_Archive_Writer_Bzip2
- in file Bzip2.php, method File_Archive_Writer_Bzip2::File_Archive_Writer_Bzip2()
- File_Archive_Writer_Files
- in file Files.php, method File_Archive_Writer_Files::File_Archive_Writer_Files()
- File_Archive_Writer_Files
- in file Files.php, class File_Archive_Writer_Files
Writer to files
- File_Archive_Writer_Gzip
- in file Gzip.php, method File_Archive_Writer_Gzip::File_Archive_Writer_Gzip()
- 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, method File_Archive_Writer_Mail::File_Archive_Writer_Mail()
- File_Archive_Writer_Mail
- in file Mail.php, class File_Archive_Writer_Mail
Send the files attached to a mail.
- 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_Memory
- in file Memory.php, method File_Archive_Writer_Memory::File_Archive_Writer_Memory()
- File_Archive_Writer_MemoryArchive
- in file MemoryArchive.php, method File_Archive_Writer_MemoryArchive::File_Archive_Writer_MemoryArchive()
- File_Archive_Writer_MemoryArchive
- in file MemoryArchive.php, class File_Archive_Writer_MemoryArchive
Base class for all the archiveWriters that can only work on complete files
- 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, class File_Archive_Writer_Zip
ZIP archive writer
- File_Archive_Writer_Zip
- in file Zip.php, method File_Archive_Writer_Zip::File_Archive_Writer_Zip()
- 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 Relay.php, method File_Archive_Reader_Relay::getData()
- getData
- in file Gzip.php, method File_Archive_Reader_Gzip::getData()
- getData
- in file Memory.php, method File_Archive_Reader_Memory::getData()
- getData
- in file Reader.php, method File_Archive_Reader::getData()
Reads some data from the current file
- 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 Tar.php, method File_Archive_Reader_Tar::getData()
- getData
- in file File.php, method File_Archive_Reader_File::getData()
- getData
- in file Zip.php, method File_Archive_Reader_Zip::getData()
- getData
- in file Concat.php, method File_Archive_Reader_Concat::getData()
- getData
- in file Bzip2.php, method File_Archive_Reader_Bzip2::getData()
- getDataFilename
- in file File.php, method File_Archive_Reader_File::getDataFilename()
- getDataFilename
- in file Relay.php, method File_Archive_Reader_Relay::getDataFilename()
- getDataFilename
- in file Reader.php, method File_Archive_Reader::getDataFilename()
If the current file of the archive is a physical file,
- getFilename
- in file ChangeName.php, method File_Archive_Reader_AddBaseName::getFilename()
- getFilename
- in file Tar.php, method File_Archive_Reader_Tar::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 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 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)
- getFilename
- in file Relay.php, method File_Archive_Reader_Relay::getFilename()
- getFilename
- in file File.php, method File_Archive_Reader_File::getFilename()
- getFilename
- in file Zip.php, method File_Archive_Reader_Zip::getFilename()
- getFilename
- in file Concat.php, method File_Archive_Reader_Concat::getFilename()
- getFilename
- in file Directory.php, method File_Archive_Reader_Directory::getFilename()
- getFilename
- in file ChangeName.php, method File_Archive_Reader_ChangeBaseName::getFilename()
- getMime
- in file Tar.php, method File_Archive_Writer_Tar::getMime()
- getMime
- in file Zip.php, method File_Archive_Writer_Zip::getMime()
- getMime
- in file Relay.php, method File_Archive_Reader_Relay::getMime()
- getMime
- in file Memory.php, method File_Archive_Reader_Memory::getMime()
- getMime
- in file Concat.php, method File_Archive_Reader_Concat::getMime()
- getMime
- in file File.php, method File_Archive_Reader_File::getMime()
- getMime
- in file Archive.php, method File_Archive_Writer_Archive::getMime()
- getMime
- in file Reader.php, method File_Archive_Reader::getMime()
Returns the MIME associated with the current file
- getStandardURL
- in file Reader.php, method File_Archive_Reader::getStandardURL()
Returns the standard path
- getStat
- in file Concat.php, method File_Archive_Reader_Concat::getStat()
- getStat
- in file Zip.php, method File_Archive_Reader_Zip::getStat()
- getStat
- in file File.php, method File_Archive_Reader_File::getStat()
- getStat
- in file Memory.php, method File_Archive_Reader_Memory::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()
- getStat
- in file Relay.php, method File_Archive_Reader_Relay::getStat()
top
top
i
- $innerWriter
- in file Bzip2.php, variable File_Archive_Writer_Bzip2::$innerWriter
- $innerWriter
- in file Gzip.php, variable File_Archive_Writer_Gzip::$innerWriter
- $innerWriter
- in file Archive.php, variable File_Archive_Writer_Archive::$innerWriter
- isEmpty
- in file Memory.php, method File_Archive_Writer_Memory::isEmpty()
Returns true iif the buffer is empty
- isKnownExtension
- in file Archive.php, method File_Archive::isKnownExtension()
Check if a file with a specific extension can be read as an archive with File_Archive::read* This function is case sensitive.
- isTrue
- in file MinTime.php, method File_Archive_Predicate_MinTime::isTrue()
- isTrue
- in file Not.php, method File_Archive_Predicate_Not::isTrue()
- isTrue
- in file Predicate.php, method File_Archive_Predicate::isTrue()
Indicates whether the current file from the reader should be kept
- isTrue
- in file True.php, method File_Archive_Predicate_True::isTrue()
- isTrue
- in file Tar.php, method File_Archive_Predicate_TARCompatible::isTrue()
- isTrue
- in file MinSize.php, method File_Archive_Predicate_MinSize::isTrue()
- isTrue
- in file Or.php, method File_Archive_Predicate_Or::isTrue()
- isTrue
- in file MaxDepth.php, method File_Archive_Predicate_MaxDepth::isTrue()
- isTrue
- in file Ereg.php, method File_Archive_Predicate_Ereg::isTrue()
- isTrue
- in file Custom.php, method File_Archive_Predicate_Custom::isTrue()
- isTrue
- in file Eregi.php, method File_Archive_Predicate_Eregi::isTrue()
- isTrue
- in file Extension.php, method File_Archive_Predicate_Extension::isTrue()
- isTrue
- in file And.php, method File_Archive_Predicate_And::isTrue()
- isTrue
- in file False.php, method File_Archive_Predicate_False::isTrue()
- isTrue
- in file MIME.php, method File_Archive_Predicate_MIME::isTrue()
top
top
n
- $nbFiles
- in file MemoryArchive.php, variable File_Archive_Writer_MemoryArchive::$nbFiles
- $nbFiles
- in file Bzip2.php, variable File_Archive_Writer_Bzip2::$nbFiles
- $nbFiles
- in file Gzip.php, variable File_Archive_Writer_Gzip::$nbFiles
- $newBaseName
- in file ChangeName.php, variable File_Archive_Reader_ChangeBaseName::$newBaseName
- newFile
- in file Mail.php, method File_Archive_Writer_Mail::newFile()
- newFile
- in file Gzip.php, method File_Archive_Writer_Gzip::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 MemoryArchive.php, method File_Archive_Writer_MemoryArchive::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 Writer.php, method File_Archive_Writer::newFile()
Create a new file in the writer
- newFile
- in file Bzip2.php, method File_Archive_Writer_Bzip2::newFile()
- newFile
- in file Files.php, method File_Archive_Writer_Files::newFile()
- newFromTempFile
- in file Writer.php, method File_Archive_Writer::newFromTempFile()
Create a new file in the writer with the content of the physical file $filename and then unlink $filename.
- newFromTempFile
- in file Files.php, method File_Archive_Writer_Files::newFromTempFile()
- next
- in file Relay.php, method File_Archive_Reader_Relay::next()
- next
- in file Zip.php, method File_Archive_Reader_Zip::next()
Go to next file entry in ZIP archive
- next
- in file Uncompress.php, method File_Archive_Reader_Uncompress::next()
- next
- in file Tar.php, method File_Archive_Reader_Tar::next()
- next
- in file Select.php, method File_Archive_Reader_Select::next()
- next
- in file Reader.php, method File_Archive_Reader::next()
Move to the next file in the reader
- 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 Directory.php, method File_Archive_Reader_Directory::next()
- next
- in file Concat.php, method File_Archive_Reader_Concat::next()
- next
- in file Bzip2.php, method File_Archive_Reader_Bzip2::next()
- next
- in file Multi.php, method File_Archive_Reader_Multi::next()
- next
- in file File.php, method File_Archive_Reader_File::next()
- next
- in file Archive.php, method File_Archive_Reader_Archive::next()
- next
- in file Gzip.php, method File_Archive_Reader_Gzip::next()
- next
- in file Filter.php, method File_Archive_Reader_Filter::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
top
p
- $pred
- in file Not.php, variable File_Archive_Predicate_Not::$pred
- 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()
- readArchive
- in file Archive.php, method File_Archive::readArchive()
Create a reader that will read the single file source $source as a specific archive
- 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.
top
s
- $source
- in file Archive.php, variable File_Archive_Reader_Archive::$source
- $source
- in file Relay.php, variable File_Archive_Reader_Relay::$source
- $source
- in file Concat.php, variable File_Archive_Reader_Concat::$source
- $stat
- in file Bzip2.php, variable File_Archive_Writer_Bzip2::$stat
- $stat
- in file Memory.php, variable File_Archive_Writer_Memory::$stat
- $stat
- in file Concat.php, variable File_Archive_Reader_Concat::$stat
- $stat
- in file Gzip.php, variable File_Archive_Writer_Gzip::$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 MemoryArchive.php, method File_Archive_Writer_MemoryArchive::sendFooter()
The subclass may rewrite the sendFooter function if it needs to execute code before closing the archive
- sendFooter
- in file Zip.php, method File_Archive_Writer_Zip::sendFooter()
- sendHeader
- in file MemoryArchive.php, method File_Archive_Writer_MemoryArchive::sendHeader()
The subclass may rewrite the sendHeader function if it needs to execute code before the first file
- 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 Bzip2.php, method File_Archive_Writer_Bzip2::setCompressionLevel()
Set the compression level
- setCompressionLevel
- in file Gzip.php, method File_Archive_Writer_Gzip::setCompressionLevel()
Set the compression level
- setCompressionLevel
- in file Zip.php, method File_Archive_Writer_Zip::setCompressionLevel()
Change the level of the compression. This may be done between two files
- 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 File.php, method File_Archive_Reader_File::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 Relay.php, method File_Archive_Reader_Relay::skip()
- skip
- in file Tar.php, method File_Archive_Reader_Tar::skip()
- skip
- in file Memory.php, method File_Archive_Reader_Memory::skip()
- skip
- in file Concat.php, method File_Archive_Reader_Concat::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
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 Writer.php, method File_Archive_Writer::writeData()
Append the specified data to the writer
- writeData
- in file MemoryArchive.php, method File_Archive_Writer_MemoryArchive::writeData()
- writeData
- in file Multi.php, method File_Archive_Writer_Multi::writeData()
- writeData
- in file Mail.php, method File_Archive_Writer_Mail::writeData()
- writeData
- in file Gzip.php, method File_Archive_Writer_Gzip::writeData()
- writeData
- in file Memory.php, method File_Archive_Writer_Memory::writeData()
- writeData
- in file Files.php, method File_Archive_Writer_Files::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 Tar.php, method File_Archive_Writer_Tar::writeFile()
- writeFile
- in file Output.php, method File_Archive_Writer_Output::writeFile()
- writeFile
- in file Multi.php, method File_Archive_Writer_Multi::writeFile()
- writeFile
- in file MemoryArchive.php, method File_Archive_Writer_MemoryArchive::writeFile()
top
Documentation generated on Mon, 11 Mar 2019 14:20:09 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|