Class: File_Archive_Writer_Gzip

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

Class Overview

File_Archive_Writer
   |
   --File_Archive_Writer_Gzip

Compress a single file to Gzip format

Variables

Methods

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 37]
Compress a single file to Gzip format

[ Top ]

Class Variables

$autoClose =

[line 45]

Type:

mixed

[ Top ]

$compressionLevel = 9

[line 39]

Type:

mixed

[ Top ]

$filename =

[line 46]

Type:

mixed

[ Top ]

$gzfile =

[line 40]

Type:

mixed

[ Top ]

$innerWriter =

[line 44]

Type:

mixed

[ Top ]

$nbFiles = 0

[line 42]

Type:

mixed

[ Top ]

$stat =

[line 47]

Type:

mixed

[ Top ]

$tmpName =

[line 41]

Type:

mixed

[ Top ]

Method Detail

File_Archive_Writer_Gzip (Constructor) [line 58]

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

Parameters:

string	`$filename`	—	Name to give to the archive
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 112]

void close(
)

Actually write the tmp file to the inner writer Close and delete temporary file

See: File_Archive_Writer::close()

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

[ Top ]

newFile [line 90]

void newFile(

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

See: File_Archive_Writer::newFile() Check that one single file is written in the GZip archive

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

Parameters:

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

[ Top ]

setCompressionLevel [line 80]

void setCompressionLevel(
int
$compressionLevel)

Set the compression level

Parameters:

int $compressionLevel — From 0 (no compression) to 9 (best compression)

[ Top ]

writeData [line 133]

void writeData(

$data)

See: File_Archive_Writer::writeData()

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

Parameters:

$data —

[ Top ]