Class: File_Archive_Writer_Archive

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

Class Overview

File_Archive_Writer
   |
   --File_Archive_Writer_Archive

Base class for all the transformation writers that will generate one single

Variables

Methods

Child classes:

File_Archive_Writer_Tar: Write the files as a TAR archive

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

File_Archive_Writer_Ar: Write the files as an AR archive

Inherited Variables

Inherited Methods

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 39]
Base class for all the transformation writers that will generate one single

file

[ Top ]

Class Variables

$emptyFolders = array()

[line 57]

Var: List of empty folders that will be added when closing the archive

Type:

Array

[ Top ]

$innerWriter =

[line 46]

Var: The compressed data will be written to this writer
Access: protected

Type:

File_Archive_Writer

[ Top ]

Method Detail

File_Archive_Writer_Archive (Constructor) [line 71]

File_Archive_Writer_Archive File_Archive_Writer_Archive(
String
$filename, 
&$innerWriter, [array
$stat = array()], [bool
$autoClose = true], File_Archive_Writer
$innerWriter)

Parameters:

String	`$filename`	—	Name to give to the archive (the name will be used by the inner writer) If $filename is null, the innerWriter is considered already opened (and thus newFile will not be called)
File_Archive_Writer	`$innerWriter`	—	The inner writer to which the compressed data will be written
array	`$stat`	—	The stat of the archive (see the PHP stat() function). No element are required in this array
bool	`$autoClose`	—	Indicate if the inner writer must be closed when closing this
	`&$innerWriter`	—

[ Top ]

close [line 110]

void close(
)

See: File_Archive_Writer::close()

Overridden in child classes as:

File_Archive_Writer_Tar::close()

File_Archive_Writer_MemoryArchive::close()

File_Archive_Writer_Ar::close()

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

[ Top ]

getMime [line 105]

the getMime(
)

Return: MIME extension of the files generated by this writer

Overridden in child classes as:

File_Archive_Writer_Tar::getMime()

File_Archive_Writer_Zip::getMime()

[ Top ]

newFile [line 81]

void newFile(

$filename, [
$stat = array()], [
$mime = 'application/octet-stream'])

Overridden in child classes as:

File_Archive_Writer_Ar::newFile()

Overrides File_Archive_Writer::newFile() (Create a new file in the writer)

Parameters:

	`$filename`	—
	`$stat`	—
	`$mime`	—

[ Top ]