ZipStream\DeflateStream Class Reference

Inheritance diagram for ZipStream\DeflateStream:

Collaboration diagram for ZipStream\DeflateStream:

Public Member Functions
	rewind ()
	Rewind stream. More...
	removeDeflateFilter ()
	Remove the deflate filter. More...
	addDeflateFilter (Option\File $options)
	Add a deflate filter. More...
Public Member Functions inherited from ZipStream\Stream
	__construct ($stream)
	close ()
	Closes the stream and any underlying resources. More...
	detach ()
	Separates any underlying resources from the stream. More...
	__toString ()
	Reads all data from the stream into a string, from the beginning to end. More...
	seek ($offset, $whence=SEEK_SET)
	Seek to a position in the stream. More...
	isSeekable ()
	Returns whether or not the stream is seekable. More...
	getMetadata ($key=null)
	Get stream metadata as an associative array or retrieve a specific key. More...
	getSize ()
	Get the size of the stream if known. More...
	tell ()
	Returns the current position of the file read/write pointer. More...
	eof ()
	Returns true if the stream is at the end of the stream. More...
	rewind ()
	Seek to the beginning of the stream. More...
	write ($string)
	Write data to the stream. More...
	isWritable ()
	Returns whether or not the stream is writable. More...
	read ($length)
	Read data from the stream. More...
	isReadable ()
	Returns whether or not the stream is readable. More...
	getContents ()
	Returns the remaining contents in a string. More...
	__toString ()
	Reads all data from the stream into a string, from the beginning to end. More...
	close ()
	Closes the stream and any underlying resources. More...
	detach ()
	Separates any underlying resources from the stream. More...
	getSize ()
	Get the size of the stream if known. More...
	tell ()
	Returns the current position of the file read/write pointer. More...
	eof ()
	Returns true if the stream is at the end of the stream. More...
	isSeekable ()
	Returns whether or not the stream is seekable. More...
	seek ($offset, $whence=SEEK_SET)
	Seek to a position in the stream. More...
	rewind ()
	Seek to the beginning of the stream. More...
	isWritable ()
	Returns whether or not the stream is writable. More...
	write ($string)
	Write data to the stream. More...
	isReadable ()
	Returns whether or not the stream is readable. More...
	read ($length)
	Read data from the stream. More...
	getContents ()
	Returns the remaining contents in a string. More...
	getMetadata ($key=null)
	Get stream metadata as an associative array or retrieve a specific key. More...

Protected Attributes
	$filter
	$options
Protected Attributes inherited from ZipStream\Stream
	$stream

Detailed Description

Definition at line 6 of file DeflateStream.php.

Member Function Documentation

addDeflateFilter()

ZipStream\DeflateStream::addDeflateFilter

(

Option\File

$options

)

Add a deflate filter.

Parameters

Option\File

$options

Returns

void

Definition at line 52 of file DeflateStream.php.

                                                          : void
    {
        $this->options = $options;
        // parameter 4 for stream_filter_append expects array
        // so we convert the option object in an array
        $optionsArr = [
            'comment' => $options->getComment(),
            'method' => $options->getMethod(),
            'deflateLevel' => $options->getDeflateLevel(),
            'time' => $options->getTime()
        ];
        $this->filter = stream_filter_append(
            $this->stream,
            'zlib.deflate',
            STREAM_FILTER_READ,
            $optionsArr
        );
    }

References PHPMailer\PHPMailer\$options.

removeDeflateFilter()

ZipStream\DeflateStream::removeDeflateFilter

(

)

Remove the deflate filter.

Returns

void

Definition at line 37 of file DeflateStream.php.

                                         : void
    {
        if (!$this->filter) {
            return;
        }
        stream_filter_remove($this->filter);
        $this->filter = null;
    }

rewind()

ZipStream\DeflateStream::rewind

(

)

Rewind stream.

Returns

void

Reimplemented from ZipStream\Stream.

Definition at line 20 of file DeflateStream.php.

                            : void
    {
        // deflate filter needs to be removed before rewind
        if ($this->filter) {
            $this->removeDeflateFilter();
            $this->seek(0);
            $this->addDeflateFilter($this->options);
        } else {
            rewind($this->stream);
        }
    }

Field Documentation

$filter

ZipStream\DeflateStream::$filter

protected

Definition at line 8 of file DeflateStream.php.

$options

ZipStream\DeflateStream::$options

protected

Definition at line 13 of file DeflateStream.php.

---

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

• libs/composer/vendor/maennchen/zipstream-php/src/DeflateStream.php