PHP Class PHPZip\Zip\Stream\ZipStream

Inheritance: extends PHPZip\Zip\Core\AbstractZipArchive
Exibir arquivo Open project: Grandt/PHPZip Class Usage Examples

Public Methods

Method Description
__construct ( String $fileName = '', String $contentType = self::CONTENT_TYPE, String $utf8FileName = null, boolean $inline = false ) Constructor.
__destruct ( ) Destructor.
getMaxStreamBufferLength ( ) : integer
onBeginAddFile ( array $params ) Called by superclass when specialised action is needed at the start of adding a file to the archive.
onBeginBuildResponseHeader ( ) Called by superclass when specialised action is needed at the start of sending the zip stream response header.
onBuildZipEntry ( array $params ) Called by superclass when specialised action is needed while building a zip entry.
onEndAddFile ( array $params ) Called by superclass when specialised action is needed at the end of adding a file to the archive.
onEndBuildResponseHeader ( ) Called by superclass when specialised action is needed at the end of sending the zip stream response header.
onOpenStream ( ) Called by superclass when specialised action is needed while opening a stream.
onProcessFile ( array $params ) Called by superclass when specialised action is needed while processing a file.
setMaxStreamBufferLength ( integer $maxStreamBufferLength )
zipFlush ( ) Flush Zip Data stored in memory, to a temp file.
zipFlushBuffer ( )
zipVerifyMemBuffer ( integer $gzLength ) Verify if the memory buffer is about to be exceeded.
zipWrite ( string $data )

Method Details

__construct() public method

Constructor.
Author: A. Grandt ([email protected])
Author: Greg Kappatos
public __construct ( String $fileName = '', String $contentType = self::CONTENT_TYPE, String $utf8FileName = null, boolean $inline = false )
$fileName String The name of the Zip archive, in ISO-8859-1 (or ASCII) encoding, ie. "archive.zip". Optional, defaults to NULL, which means that no ISO-8859-1 encoded file name will be specified.
$contentType String Content mime type. Optional, defaults to "application/zip".
$utf8FileName String The name of the Zip archive, in UTF-8 encoding. Optional, defaults to NULL, which means that no UTF-8 encoded file name will be specified.
$inline boolean Use Content-Disposition with "inline" instead of "attached". Optional, defaults to FALSE.

__destruct() public method

Perform clean up actions. Please note that frameworks are absolutely prohibited from sending ANYTHING to the output after the Zip is sent.
Author: A. Grandt ([email protected])
public __destruct ( )

getMaxStreamBufferLength() public method

public getMaxStreamBufferLength ( ) : integer
return integer

onBeginAddFile() public method

Called by superclass when specialised action is needed at the start of adding a file to the archive.
Author: A. Grandt ([email protected])
Author: Greg Kappatos
public onBeginAddFile ( array $params )
$params array Array that contains gzLength.

onBeginBuildResponseHeader() public method

Called by superclass when specialised action is needed at the start of sending the zip stream response header.
Author: A. Grandt ([email protected])
Author: Greg Kappatos
public onBeginBuildResponseHeader ( )

onBuildZipEntry() public method

Called by superclass when specialised action is needed while building a zip entry.
Author: A. Grandt ([email protected])
Author: Greg Kappatos
public onBuildZipEntry ( array $params )
$params array Array that contains zipEntry.

onEndAddFile() public method

Called by superclass when specialised action is needed at the end of adding a file to the archive.
Author: A. Grandt ([email protected])
Author: Greg Kappatos
public onEndAddFile ( array $params )
$params array Array that contains gzData.

onEndBuildResponseHeader() public method

Called by superclass when specialised action is needed at the end of sending the zip stream response header.
Author: A. Grandt ([email protected])
Author: Greg Kappatos
public onEndBuildResponseHeader ( )

onOpenStream() public method

Called by superclass when specialised action is needed while opening a stream.
Author: A. Grandt ([email protected])
Author: Greg Kappatos
public onOpenStream ( )

onProcessFile() public method

Called by superclass when specialised action is needed while processing a file.
Author: A. Grandt ([email protected])
Author: Greg Kappatos
public onProcessFile ( array $params )
$params array Array that contains data.

setMaxStreamBufferLength() public method

public setMaxStreamBufferLength ( integer $maxStreamBufferLength )
$maxStreamBufferLength integer

zipFlush() public method

Flush Zip Data stored in memory, to a temp file.
Author: A. Grandt ([email protected])
public zipFlush ( )

zipFlushBuffer() public method

Author: A. Grandt ([email protected])
public zipFlushBuffer ( )

zipVerifyMemBuffer() public method

Verify if the memory buffer is about to be exceeded.
Author: A. Grandt ([email protected])
public zipVerifyMemBuffer ( integer $gzLength )
$gzLength integer length of the pending data.

zipWrite() public method

Author: A. Grandt ([email protected])
public zipWrite ( string $data )
$data string