Docs For Class File_Archive

void close(
)

Close the writer, eventually flush the data, write the footer...

This function must be called before the end of the script

Overridden in child classes as:

File_Archive_Writer_Gzip::close(): Actually write the tmp file to the inner writer Close and delete temporary file

File_Archive_Writer_UniqueAppender::close(): Close the writer, eventually flush the data, write the footer...

File_Archive_Writer_Bzip2::close(): Actually write the tmp file to the inner writer Close and delete temporary file

File_Archive_Writer_Multi::close()

File_Archive_Writer_Mail::close()

File_Archive_Writer_Files::close()

File_Archive_Writer_Archive::close()

File_Archive_Writer_Tar::close()

File_Archive_Writer_MemoryArchive::close()

File_Archive_Writer_Ar::close()

[ Top ]

void newFile(
string
$filename, [array
$stat = array()], [string
$mime = "application/octet-stream"])

Create a new file in the writer

Overridden in child classes as:

File_Archive_Writer_Gzip::newFile()

File_Archive_Writer_Memory::newFile()

File_Archive_Writer_UniqueAppender::newFile()

File_Archive_Writer_Bzip2::newFile()

File_Archive_Writer_Multi::newFile()

File_Archive_Writer_Output::newFile()

File_Archive_Writer_Mail::newFile()

File_Archive_Writer_Files::newFile()

File_Archive_Writer_Archive::newFile()

File_Archive_Writer_Ar::newFile()

Parameters:

string	`$filename`	—	Name of the file, eventually including a path
array	`$stat`	—	Its Statistics. None of the indexes are required
string	`$mime`	—	MIME type of the file

[ Top ]

void newFileNeedsMIME(
)

Returns whether the writer newFile function needs the $mime parameter

Default is false

Overridden in child classes as:

File_Archive_Writer_Memory::newFileNeedsMIME()

File_Archive_Writer_UniqueAppender::newFileNeedsMIME()

File_Archive_Writer_Multi::newFileNeedsMIME()

File_Archive_Writer_Output::newFileNeedsMIME()

File_Archive_Writer_Mail::newFileNeedsMIME()

[ Top ]

void newFromTempFile(
string
$tmpfile, string
$filename, [array
$stat = array()], [string
$mime = "application/octet-stream"])

Create a new file in the writer with the content of the physical file $filename and then unlink $filename.

newFromTempFile($tmpfile, $filename, $stat, $mime) is equivalent to newFile($filename, $stat, $mime); writeFile($tmpfile); unlink($tmpfile); but can be more efficient. A typical use is for File_Archive_Writer_Files: it renames the temporary file instead of copy/delete

Overridden in child classes as:

File_Archive_Writer_UniqueAppender::newFromTempFile()

File_Archive_Writer_Files::newFromTempFile()

Parameters:

string	`$tmpfile`	—	Name of the physical file that contains data and will be unlinked
string	`$filename`	—	Name of the file, eventually including a path
array	`$stat`	—	Its Statistics. None of the indexes are required
string	`$mime`	—	MIME type of the file

[ Top ]

void writeData(
String
$data)

Append the specified data to the writer

Overridden in child classes as:

File_Archive_Writer_Gzip::writeData()

File_Archive_Writer_Memory::writeData()

File_Archive_Writer_UniqueAppender::writeData()

File_Archive_Writer_Bzip2::writeData()

File_Archive_Writer_Multi::writeData()

File_Archive_Writer_Output::writeData()

File_Archive_Writer_Mail::writeData()

File_Archive_Writer_Files::writeData()

File_Archive_Writer_Tar::writeData()

File_Archive_Writer_MemoryArchive::writeData()

File_Archive_Writer_Ar::writeData()

Parameters:

String $data — the data to append to the writer

[ Top ]

void writeFile(
string
$filename)

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

Overridden in child classes as:

File_Archive_Writer_UniqueAppender::writeFile()

File_Archive_Writer_Multi::writeFile()

File_Archive_Writer_Output::writeFile()

File_Archive_Writer_Tar::writeFile()

File_Archive_Writer_MemoryArchive::writeFile()

File_Archive_Writer_Ar::writeFile()

Parameters:

string $filename — Name of the file which content must be appended to the writer

[ Top ]

Class: File_Archive_Writer

Class Overview

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Method Detail

close [line 116]

newFile [line 46]

Parameters:

newFileNeedsMIME [line 75]

newFromTempFile [line 64]

Parameters:

writeData [line 85]

Parameters:

writeFile [line 97]

Parameters: