Class: File_Archive_Writer_MemoryArchive

Source Location: /File_Archive-1.5.5/File/Archive/Writer/MemoryArchive.php

Class Overview

File_Archive_Writer
   |
   --File_Archive_Writer_Archive
      |
      --File_Archive_Writer_MemoryArchive

Base class for all the archiveWriters that can only work on complete files

Child classes:

File_Archive_Writer_Zip: ZIP archive writer

Inherited Variables

Class: File_Archive_Writer_Archive

File_Archive_Writer_Archive::$emptyFolders
File_Archive_Writer_Archive::$innerWriter

Inherited Methods

Class: File_Archive_Writer_Archive

File_Archive_Writer_Archive::File_Archive_Writer_Archive()
File_Archive_Writer_Archive::close()
File_Archive_Writer_Archive::getMime()
File_Archive_Writer_Archive::newFile()

Class: File_Archive_Writer

File_Archive_Writer::close(): Close the writer, eventually flush the data, write the footer...
File_Archive_Writer::newFile(): Create a new file in the writer
File_Archive_Writer::newFileNeedsMIME(): Returns whether the writer newFile function needs the $mime parameter
File_Archive_Writer::newFromTempFile(): Create a new file in the writer with the content of the physical file $filename and then unlink $filename.
File_Archive_Writer::writeData(): Append the specified data to the writer
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

Class Details

[line 40]
Base class for all the archiveWriters that can only work on complete files

(the write data function may be called with small chunks of data)

[ Top ]

Class Variables

$nbFiles = 0

[line 67]

Var: Number of times newFile function has been called
Access: protected

Type:

int

[ Top ]

Method Detail

File_Archive_Writer_MemoryArchive (Constructor) [line 72]

File_Archive_Writer_MemoryArchive File_Archive_Writer_MemoryArchive(

$filename, 
&$t, [
$stat = array()], [
$autoClose = true])

See: File_Archive_Writer::File_Archive_Writer()

Parameters:

	`$filename`	—
	`&$t`	—
	`$stat`	—
	`$autoClose`	—

[ Top ]

appendFile [line 204]

void appendFile(

$filename, 
$dataFilename)

The subclass may rewrite this class if it knows an efficient way to treat a physical file.

Access: protected

Overridden in child classes as:

File_Archive_Writer_Zip::appendFile()

Parameters:

	`$filename`	—
	`$dataFilename`	—

[ Top ]

appendFileData [line 181]

void appendFileData(

$filename, 
$stat, 
&$data)

The subclass must treat the data $data $data is the entire data of the filename $filename $stat is the stat of the file

Access: protected

Overridden in child classes as:

File_Archive_Writer_Zip::appendFileData()

Parameters:

	`$filename`	—
	`$stat`	—
	`&$data`	—

[ Top ]

close [line 106]

void close(
)

See: File_Archive_Writer::close()

Overrides File_Archive_Writer_Archive::close() (parent method not documented)

[ Top ]

sendFooter [line 197]

void sendFooter(
)

The subclass may rewrite the sendFooter function if it needs to execute code before closing the archive

Access: protected

Overridden in child classes as:

File_Archive_Writer_Zip::sendFooter()

[ Top ]

sendHeader [line 190]

void sendHeader(
)

The subclass may rewrite the sendHeader function if it needs to execute code before the first file

Access: protected

[ Top ]

writeData [line 149]

void writeData(

$data)

See: File_Archive_Writer::writeData()

Overrides File_Archive_Writer::writeData() (Append the specified data to the writer)

Parameters:

$data —

[ Top ]

writeFile [line 160]

void writeFile(

$filename)

See: File_Archive_Writer::writeFile()

Overrides 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)

Parameters:

$filename —

[ Top ]