Class: File_Archive_Writer_Archive

Source Location: /File_Archive-0.2.0/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

Methods

Child classes:

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

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::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 ]

Method Detail

File_Archive_Writer_Archive (Constructor) [line 65]

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

Parameters:

String	`$filename`	—	Name to give to the archive (the name will probably be used by the inner writer)
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

[ Top ]

close [line 84]

void close(
)

See: File_Archive_Writer::close()

Overridden in child classes as:

File_Archive_Writer_MemoryArchive::close()

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

[ Top ]

getMime [line 79]

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 ]