Collaboration diagram for ZipStream\ZipStream:

Public Member Functions
	__construct (?string $name=null, ?ArchiveOptions $opt=null)
	Create a new ZipStream object. More...

	addFile (string $name, string $data, ?FileOptions $options=null)
	addFile More...

	addFileFromPath (string $name, string $path, ?FileOptions $options=null)
	addFileFromPath More...

	addFileFromStream (string $name, $stream, ?FileOptions $options=null)
	addFileFromStream More...

	addFileFromPsr7Stream (string $name, StreamInterface $stream, ?FileOptions $options=null)
	addFileFromPsr7Stream More...

	finish ()
	finish More...

	send (string $str)
	Send string, sending HTTP headers if necessary. More...

	isLargeFile (string $path)
	Is this file larger than large_file_size? More...

	addToCdr (File $file)
	Save file attributes for trailing CDR record. More...

Static Public Member Functions
static	packFields (array $fields)
	Create a format string and argument list for pack(), then call pack() and return the result. More...

Data Fields
const	ZIP_VERSION_MADE_BY = 0x603
	This number corresponds to the ZIP version/OS used (2 bytes) From: https://www.iana.org/assignments/media-types/application/zip The upper byte (leftmost one) indicates the host system (OS) for the file. More...

const	FILE_HEADER_SIGNATURE = 0x04034b50
	The following signatures end with 0x4b50, which in ASCII is PK, the initials of the inventor Phil Katz. More...

const	CDR_FILE_SIGNATURE = 0x02014b50

const	CDR_EOF_SIGNATURE = 0x06054b50

const	DATA_DESCRIPTOR_SIGNATURE = 0x08074b50

const	ZIP64_CDR_EOF_SIGNATURE = 0x06064b50

const	ZIP64_CDR_LOCATOR_SIGNATURE = 0x07064b50

	$opt

	$files = []

	$cdr_ofs

	$ofs

Protected Member Functions
	addCdr64Eof ()
	Send ZIP64 CDR EOF (Central Directory Record End-of-File) record. More...

	sendHttpHeaders ()
	Send HTTP headers for this stream. More...

	addCdr64Locator ()
	Send ZIP64 CDR Locator (Central Directory Record Locator) record. More...

	addCdrEof ()
	Send CDR EOF (Central Directory Record End-of-File) record. More...

	clear ()
	Clear all internal variables. More...

Protected Attributes
	$need_headers

	$output_name

Detailed Description

ZipStream.

Streamed, dynamically generated zip archives.

Usage:

Streaming zip archives is a simple, three-step process:

Create the zip stream:

$zip = new ZipStream('example.zip');
Add one or more files to the archive:
- add first file $data = file_get_contents('some_file.gif'); $zip->addFile('some_file.gif', $data);
- add second file $data = file_get_contents('some_file.gif'); $zip->addFile('another_file.png', $data);
Finish the zip stream:

$zip->finish();

You can also add an archive comment, add comments to individual files, and adjust the timestamp of files. See the API documentation for each method below for additional information.

Example:

// create a new zip stream object $zip = new ZipStream('some_files.zip');

// list of local files $files = array('foo.txt', 'bar.jpg');

// read and add each file to the archive foreach ($files as $path) $zip->addFile($path, file_get_contents($path));

// write archive footer to stream $zip->finish();

Definition at line 58 of file ZipStream.php.

Constructor & Destructor Documentation

◆ __construct()

ZipStream\ZipStream::__construct	(	?string	$name = `null`,
		?ArchiveOptions	$opt = `null`
	)

Create a new ZipStream object.

Parameters:

Parameters

String	$name	- Name of output file (optional).
ArchiveOptions	$opt	- Archive Options

Large File Support:

By default, the method addFileFromPath() will send send files larger than 20 megabytes along raw rather than attempting to compress them. You can change both the maximum size and the compression behavior using the largeFile* options above, with the following caveats:

For "small" files (e.g. files smaller than largeFileSize), the memory use can be up to twice that of the actual file. In other words, adding a 10 megabyte file to the archive could potentially occupy 20 megabytes of memory.
Enabling compression on large files (e.g. files larger than large_file_size) is extremely slow, because ZipStream has to pass over the large file once to calculate header information, and then again to compress and send the actual data.

Examples:

// create a new zip file named 'foo.zip' $zip = new ZipStream('foo.zip');

// create a new zip file named 'bar.zip' with a comment $opt->setComment = 'this is a comment for the zip file.'; $zip = new ZipStream('bar.zip', $opt);

Notes:

In order to let this library send HTTP headers, a filename must be given and the option sendHttpHeaders must be true. This behavior is to allow software to send its own headers (including the filename), and still use this library.

Definition at line 171 of file ZipStream.php.

References $name.

     {
         $this->opt = $opt ?: new ArchiveOptions();
 
         $this->output_name = $name;
         $this->need_headers = $name && $this->opt->isSendHttpHeaders();
 
         $this->cdr_ofs = new Bigint();
         $this->ofs = new Bigint();
     }

Member Function Documentation

◆ addCdr64Eof()

ZipStream\ZipStream::addCdr64Eof ( )

protected

Send ZIP64 CDR EOF (Central Directory Record End-of-File) record.

Returns: void

Definition at line 386 of file ZipStream.php.

References $ret, and ZipStream\Option\Version\ZIP64.

                                     : void
     {
         $num_files = count($this->files);
         $cdr_length = $this->cdr_ofs;
         $cdr_offset = $this->ofs;
 
         $fields = [
             ['V', static::ZIP64_CDR_EOF_SIGNATURE],     // ZIP64 end of central file header signature
             ['P', 44],                                  // Length of data below this header (length of block - 12) = 44
             ['v', static::ZIP_VERSION_MADE_BY],         // Made by version
             ['v', Version::ZIP64],                      // Extract by version
             ['V', 0x00],                                // disk number
             ['V', 0x00],                                // no of disks
             ['P', $num_files],                          // no of entries on disk
             ['P', $num_files],                          // no of entries in cdr
             ['P', $cdr_length],                         // CDR size
             ['P', $cdr_offset],                         // CDR offset
         ];
 
         $ret = static::packFields($fields);
         $this->send($ret);
     }

◆ addCdr64Locator()

ZipStream\ZipStream::addCdr64Locator ( )

protected

Send ZIP64 CDR Locator (Central Directory Record Locator) record.

Returns: void

Definition at line 514 of file ZipStream.php.

References $ret.

                                         : void
     {
         $cdr_offset = $this->ofs->add($this->cdr_ofs);
 
         $fields = [
             ['V', static::ZIP64_CDR_LOCATOR_SIGNATURE], // ZIP64 end of central file header signature
             ['V', 0x00],                                // Disc number containing CDR64EOF
             ['P', $cdr_offset],                         // CDR offset
             ['V', 1],                                   // Total number of disks
         ];
 
         $ret = static::packFields($fields);
         $this->send($ret);
     }

◆ addCdrEof()

ZipStream\ZipStream::addCdrEof ( )

protected

Send CDR EOF (Central Directory Record End-of-File) record.

Returns: void

Definition at line 534 of file ZipStream.php.

References $comment, and $ret.

                                   : void
     {
         $num_files = count($this->files);
         $cdr_length = $this->cdr_ofs;
         $cdr_offset = $this->ofs;
 
         // grab comment (if specified)
         $comment = $this->opt->getComment();
 
         $fields = [
             ['V', static::CDR_EOF_SIGNATURE],   // end of central file header signature
             ['v', 0x00],                        // disk number
             ['v', 0x00],                        // no of disks
             ['v', min($num_files, 0xFFFF)],     // no of entries on disk
             ['v', min($num_files, 0xFFFF)],     // no of entries in cdr
             ['V', $cdr_length->getLowFF()],     // CDR size
             ['V', $cdr_offset->getLowFF()],     // CDR offset
             ['v', strlen($comment)],            // Zip Comment size
         ];
 
         $ret = static::packFields($fields) . $comment;
         $this->send($ret);
     }

◆ addFile()

ZipStream\ZipStream::addFile	(	string	$name,
		string	$data,
		?FileOptions	$options = `null`
	)

addFile

Add a file to the archive.

Parameters

String	$name	- path of file in archive (including directory).
String	$data	- contents of file
FileOptions	$options	File Options: time - Last-modified timestamp (seconds since the epoch) of this file. Defaults to the current time. comment - Comment related to this file. method - Storage method for file ("store" or "deflate")

Examples:

// add a file named 'foo.txt' $data = file_get_contents('foo.txt'); $zip->addFile('foo.txt', $data);

// add a file named 'bar.jpg' with a comment and a last-modified // time of two hours ago $data = file_get_contents('bar.jpg'); $opt->setTime = time() - 2 * 3600; $opt->setComment = 'this is a comment about bar.jpg'; $zip->addFile('bar.jpg', $data, $opt);

Definition at line 210 of file ZipStream.php.

References PHPMailer\PHPMailer\$options.

                                                                                      : void
     {
         $options = $options ?: new FileOptions();
         $options->defaultTo($this->opt);
 
         $file = new File($this, $name, $options);
         $file->processData($data);
     }

◆ addFileFromPath()

ZipStream\ZipStream::addFileFromPath	(	string	$name,
		string	$path,
		?FileOptions	$options = `null`
	)

addFileFromPath

Add a file at path to the archive.

Note that large files may be compressed differently than smaller files; see the "Large File Support" section above for more information.

Parameters

String	$name	- name of file in archive (including directory path).
String	$path	- path to file on disk (note: paths should be encoded using UNIX-style forward slashes – e.g '/path/to/some/file').
FileOptions	$options	File Options: time - Last-modified timestamp (seconds since the epoch) of this file. Defaults to the current time. comment - Comment related to this file. method - Storage method for file ("store" or "deflate")

Examples:

// add a file named 'foo.txt' from the local file '/tmp/foo.txt' $zip->addFileFromPath('foo.txt', '/tmp/foo.txt');

// add a file named 'bigfile.rar' from the local file // '/usr/share/bigfile.rar' with a comment and a last-modified // time of two hours ago $path = '/usr/share/bigfile.rar'; $opt->setTime = time() - 2 * 3600; $opt->setComment = 'this is a comment about bar.jpg'; $zip->addFileFromPath('bigfile.rar', $path, $opt);

Returns: void

Exceptions

Definition at line 256 of file ZipStream.php.

References PHPMailer\PHPMailer\$options.

                                                                                              : void
     {
         $options = $options ?: new FileOptions();
         $options->defaultTo($this->opt);
 
         $file = new File($this, $name, $options);
         $file->processPath($path);
     }

◆ addFileFromPsr7Stream()

ZipStream\ZipStream::addFileFromPsr7Stream	(	string	$name,
		StreamInterface	$stream,
		?FileOptions	$options = `null`
	)

addFileFromPsr7Stream

Add an open stream to the archive.

Parameters

String	$name	- path of file in archive (including directory).
StreamInterface	$stream	- contents of file as a stream resource
FileOptions	$options	File Options: time - Last-modified timestamp (seconds since the epoch) of this file. Defaults to the current time. comment - Comment related to this file.

Examples:

// create a temporary file stream and write text to it $fp = tmpfile(); fwrite($fp, 'The quick brown fox jumped over the lazy dog.');

// add a file named 'streamfile.txt' from the content of the stream $x->addFileFromPsr7Stream('streamfile.txt', $fp);

Returns: void

Definition at line 324 of file ZipStream.php.

References PHPMailer\PHPMailer\$options.

      : void {
         $options = $options ?: new FileOptions();
         $options->defaultTo($this->opt);
 
         $file = new File($this, $name, $options);
         $file->processStream($stream);
     }

◆ addFileFromStream()

ZipStream\ZipStream::addFileFromStream	(	string	$name,
			$stream,
		?FileOptions	$options = `null`
	)

addFileFromStream

Add an open stream to the archive.

Parameters

String	$name	- path of file in archive (including directory).
resource	$stream	- contents of file as a stream resource
FileOptions	$options	File Options: time - Last-modified timestamp (seconds since the epoch) of this file. Defaults to the current time. comment - Comment related to this file.

Examples:

// create a temporary file stream and write text to it $fp = tmpfile(); fwrite($fp, 'The quick brown fox jumped over the lazy dog.');

// add a file named 'streamfile.txt' from the content of the stream $x->addFileFromStream('streamfile.txt', $fp);

Returns: void

Definition at line 290 of file ZipStream.php.

References PHPMailer\PHPMailer\$options, and GuzzleHttp\Psr7\$stream.

                                                                                           : void
     {
         $options = $options ?: new FileOptions();
         $options->defaultTo($this->opt);
 
         $file = new File($this, $name, $options);
         $file->processStream(new DeflateStream($stream));
     }

◆ addToCdr()

ZipStream\ZipStream::addToCdr ( File $file )

Save file attributes for trailing CDR record.

Parameters

File $file

Returns: void

Definition at line 593 of file ZipStream.php.

References ZipStream\File\getCdrFile(), and ZipStream\File\getTotalLength().

                                         : void
     {
         $file->ofs = $this->ofs;
         $this->ofs = $this->ofs->add($file->getTotalLength());
         $this->files[] = $file->getCdrFile();
     }

Here is the call graph for this function:

◆ clear()

ZipStream\ZipStream::clear ( )

protected

Clear all internal variables.

Note that the stream object is not usable after this.

Returns: void

Definition at line 564 of file ZipStream.php.

                               : void
     {
         $this->files = [];
         $this->ofs = new Bigint();
         $this->cdr_ofs = new Bigint();
         $this->opt = new ArchiveOptions();
     }

◆ finish()

ZipStream\ZipStream::finish ( )

finish

Write zip footer to stream.

Example:

// add a list of files to the archive $files = array('foo.txt', 'bar.jpg'); foreach ($files as $path) $zip->addFile($path, file_get_contents($path));

// write footer to stream $zip->finish();

Returns: void

Exceptions

OverflowException

Definition at line 354 of file ZipStream.php.

References ZipStream\Bigint\init().

                             : void
     {
         // add trailing cdr file records
         foreach ($this->files as $cdrFile) {
             $this->send($cdrFile);
             $this->cdr_ofs = $this->cdr_ofs->add(Bigint::init(strlen($cdrFile)));
         }
 
         // Add 64bit headers (if applicable)
         if (count($this->files) >= 0xFFFF ||
             $this->cdr_ofs->isOver32() ||
             $this->ofs->isOver32()) {
             if (!$this->opt->isEnableZip64()) {
                 throw new OverflowException();
             }
 
             $this->addCdr64Eof();
             $this->addCdr64Locator();
         }
 
         // add trailing cdr eof record
         $this->addCdrEof();
 
         // The End
         $this->clear();
     }

Here is the call graph for this function:

◆ isLargeFile()

ZipStream\ZipStream::isLargeFile ( string $path )

Is this file larger than large_file_size?

Parameters

string $path

Returns: bool

Definition at line 578 of file ZipStream.php.

                                              : bool
     {
         if (!$this->opt->isStatFiles()) {
             return false;
         }
         $stat = stat($path);
         return $stat['size'] > $this->opt->getLargeFileSize();
     }

◆ packFields()

static ZipStream\ZipStream::packFields ( array $fields )

static

Create a format string and argument list for pack(), then call pack() and return the result.

Parameters

array $fields

Returns: string

Definition at line 416 of file ZipStream.php.

References $format.

                                                     : string
     {
         $fmt = '';
         $args = [];
 
         // populate format string and argument list
         foreach ($fields as [$format, $value]) {
             if ($format === 'P') {
                 $fmt .= 'VV';
                 if ($value instanceof Bigint) {
                     $args[] = $value->getLow32();
                     $args[] = $value->getHigh32();
                 } else {
                     $args[] = $value;
                     $args[] = 0;
                 }
             } else {
                 if ($value instanceof Bigint) {
                     $value = $value->getLow32();
                 }
                 $fmt .= $format;
                 $args[] = $value;
             }
         }
 
         // prepend format string to argument list
         array_unshift($args, $fmt);
 
         // build output string from header and compressed data
         return pack(...$args);
     }

◆ send()

ZipStream\ZipStream::send ( string $str )

Send string, sending HTTP headers if necessary.

Flush output after write if configure option is set.

Parameters

String $str

Returns: void

Definition at line 455 of file ZipStream.php.

                                      : void
     {
         if ($this->need_headers) {
             $this->sendHttpHeaders();
         }
         $this->need_headers = false;
 
         fwrite($this->opt->getOutputStream(), $str);
 
         if ($this->opt->isFlushOutput()) {
             // flush output buffer if it is on and flushable
             $status = ob_get_status();
             if (isset($status['flags']) && ($status['flags'] & PHP_OUTPUT_HANDLER_FLUSHABLE)) {
                 ob_flush();
             }
 
             // Flush system buffers after flushing userspace output buffer
             flush();
         }
     }

◆ sendHttpHeaders()

ZipStream\ZipStream::sendHttpHeaders ( )

protected

Send HTTP headers for this stream.

Returns: void

Definition at line 481 of file ZipStream.php.

References $key.

                                         : void
     {
         // grab content disposition
         $disposition = $this->opt->getContentDisposition();
 
         if ($this->output_name) {
             // Various different browsers dislike various characters here. Strip them all for safety.
             $safe_output = trim(str_replace(['"', "'", '\\', ';', "\n", "\r"], '', $this->output_name));
 
             // Check if we need to UTF-8 encode the filename
             $urlencoded = rawurlencode($safe_output);
             $disposition .= "; filename*=UTF-8''{$urlencoded}";
         }
 
         $headers = array(
             'Content-Type' => $this->opt->getContentType(),
             'Content-Disposition' => $disposition,
             'Pragma' => 'public',
             'Cache-Control' => 'public, must-revalidate',
             'Content-Transfer-Encoding' => 'binary'
         );
 
         $call = $this->opt->getHttpHeaderCallback();
         foreach ($headers as $key => $val) {
             $call("$key: $val");
         }
     }

Field Documentation

◆ $cdr_ofs

ZipStream\ZipStream::$cdr_ofs

Definition at line 112 of file ZipStream.php.

◆ $files

ZipStream\ZipStream::$files = []

Definition at line 107 of file ZipStream.php.

◆ $need_headers

ZipStream\ZipStream::$need_headers

protected

Definition at line 122 of file ZipStream.php.

◆ $ofs

ZipStream\ZipStream::$ofs

Definition at line 117 of file ZipStream.php.

◆ $opt

ZipStream\ZipStream::$opt

Definition at line 102 of file ZipStream.php.

◆ $output_name

ZipStream\ZipStream::$output_name

protected

Definition at line 127 of file ZipStream.php.

◆ CDR_EOF_SIGNATURE

const ZipStream\ZipStream::CDR_EOF_SIGNATURE = 0x06054b50

Definition at line 92 of file ZipStream.php.

◆ CDR_FILE_SIGNATURE

const ZipStream\ZipStream::CDR_FILE_SIGNATURE = 0x02014b50

Definition at line 91 of file ZipStream.php.

◆ DATA_DESCRIPTOR_SIGNATURE

const ZipStream\ZipStream::DATA_DESCRIPTOR_SIGNATURE = 0x08074b50

Definition at line 93 of file ZipStream.php.

◆ FILE_HEADER_SIGNATURE

const ZipStream\ZipStream::FILE_HEADER_SIGNATURE = 0x04034b50

The following signatures end with 0x4b50, which in ASCII is PK, the initials of the inventor Phil Katz.

See https://en.wikipedia.org/wiki/Zip_(file_format)#File_headers

Definition at line 90 of file ZipStream.php.

◆ ZIP64_CDR_EOF_SIGNATURE

const ZipStream\ZipStream::ZIP64_CDR_EOF_SIGNATURE = 0x06064b50

Definition at line 94 of file ZipStream.php.

◆ ZIP64_CDR_LOCATOR_SIGNATURE

const ZipStream\ZipStream::ZIP64_CDR_LOCATOR_SIGNATURE = 0x07064b50

Definition at line 95 of file ZipStream.php.

◆ ZIP_VERSION_MADE_BY

const ZipStream\ZipStream::ZIP_VERSION_MADE_BY = 0x603

This number corresponds to the ZIP version/OS used (2 bytes) From: https://www.iana.org/assignments/media-types/application/zip The upper byte (leftmost one) indicates the host system (OS) for the file.

Software can use this information to determine the line record format for text files etc. The current mappings are:

0 - MS-DOS and OS/2 (F.A.T. file systems) 1 - Amiga 2 - VAX/VMS 3 - *nix 4 - VM/CMS 5 - Atari ST 6 - OS/2 H.P.F.S. 7 - Macintosh 8 - Z-System 9 - CP/M 10 thru 255 - unused

The lower byte (rightmost one) indicates the version number of the software used to encode the file. The value/10 indicates the major version number, and the value mod 10 is the minor version number. Here we are using 6 for the OS, indicating OS/2 H.P.F.S. to prevent file permissions issues upon extract (see #84) 0x603 is 00000110 00000011 in binary, so 6 and 3

Definition at line 83 of file ZipStream.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/maennchen/zipstream-php/src/ZipStream.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCdr64Eof()

◆ addCdr64Locator()

◆ addCdrEof()

◆ addFile()

◆ addFileFromPath()

◆ addFileFromPsr7Stream()

◆ addFileFromStream()

◆ addToCdr()

◆ clear()

◆ finish()

◆ isLargeFile()

◆ packFields()

◆ send()

◆ sendHttpHeaders()

Field Documentation

◆ $cdr_ofs

◆ $files

◆ $need_headers

◆ $ofs

◆ $opt

◆ $output_name

◆ CDR_EOF_SIGNATURE

◆ CDR_FILE_SIGNATURE

◆ DATA_DESCRIPTOR_SIGNATURE

◆ FILE_HEADER_SIGNATURE

◆ ZIP64_CDR_EOF_SIGNATURE

◆ ZIP64_CDR_LOCATOR_SIGNATURE

◆ ZIP_VERSION_MADE_BY