Zend_Filter_Compress_Gz Class Reference

Inheritance diagram for Zend_Filter_Compress_Gz:

Public Member Functions
	__construct ($options=null)
	getLevel ()
	setLevel ($level)
	getMode ()
	setMode ($mode)
	getArchive ()
	setArchive ($archive)
	compress ($content)
	decompress ($content)
	toString ()
Public Member Functions inherited from Zend_Filter_Compress_CompressAbstract
	__construct ($options=null)
	getOptions ($option=null)
	setOptions (array $options)

Protected Attributes
	$_options

Detailed Description

Definition at line 35 of file Gz.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Class constructor

Parameters

array | Zend_Config | null

$options

(Optional) Options to set

Definition at line 58 of file Gz.php.

    {
        if (!extension_loaded('zlib')) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('This filter needs the zlib extension');
        }
        parent::__construct($options);
    }

Member Function Documentation

compress()

compress

(

$content

)

Compresses the given content

Parameters

string

$content

Returns

string

Implements Zend_Filter_Compress_CompressInterface.

Definition at line 148 of file Gz.php.

    {
        $archive = $this->getArchive();
        if (!empty($archive)) {
            $file = gzopen($archive, 'w' . $this->getLevel());
            if (!$file) {
                #require_once 'Zend/Filter/Exception.php';
                throw new Zend_Filter_Exception("Error opening the archive '" . $this->_options['archive'] . "'");
            }

            gzwrite($file, $content);
            gzclose($file);
            $compressed = true;
        } else if ($this->_options['mode'] == 'deflate') {
            $compressed = gzdeflate($content, $this->getLevel());
        } else {
            $compressed = gzcompress($content, $this->getLevel());
        }

        if (!$compressed) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Error during compression');
        }

        return $compressed;
    }

decompress()

decompress

(

$content

)

Decompresses the given content

Parameters

string

$content

Returns

string

Implements Zend_Filter_Compress_CompressInterface.

Definition at line 181 of file Gz.php.

    {
        $archive = $this->getArchive();
        $mode    = $this->getMode();
        if (@file_exists($content)) {
            $archive = $content;
        }

        if (@file_exists($archive)) {
            $handler = fopen($archive, "rb");
            if (!$handler) {
                #require_once 'Zend/Filter/Exception.php';
                throw new Zend_Filter_Exception("Error opening the archive '" . $archive . "'");
            }

            fseek($handler, -4, SEEK_END);
            $packet = fread($handler, 4);
            $bytes  = unpack("V", $packet);
            $size   = end($bytes);
            fclose($handler);

            $file       = gzopen($archive, 'r');
            $compressed = gzread($file, $size);
            gzclose($file);
        } else if ($mode == 'deflate') {
            $compressed = gzinflate($content);
        } else {
            $compressed = gzuncompress($content);
        }

        if (!$compressed) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Error during compression');
        }

        return $compressed;
    }

getArchive()

getArchive

(

)

Returns the set archive

Returns

string

Definition at line 125 of file Gz.php.

    {
        return $this->_options['archive'];
    }

getLevel()

getLevel

(

)

Returns the set compression level

Returns

integer

Definition at line 72 of file Gz.php.

    {
        return $this->_options['level'];
    }

getMode()

getMode

(

)

Returns the set compression mode

Returns

string

Definition at line 99 of file Gz.php.

    {
        return $this->_options['mode'];
    }

setArchive()

setArchive

(

$archive

)

Sets the archive to use for de-/compression

Parameters

string

$archive

Archive to use

Returns

Zend_Filter_Compress_Gz

Definition at line 136 of file Gz.php.

    {
        $this->_options['archive'] = (string) $archive;
        return $this;
    }

setLevel()

setLevel

(

$level

)

Sets a new compression level

Parameters

integer

$level

Returns

Zend_Filter_Compress_Gz

Definition at line 83 of file Gz.php.

    {
        if (($level < 0) || ($level > 9)) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Level must be between 0 and 9');
        }

        $this->_options['level'] = (int) $level;
        return $this;
    }

setMode()

setMode

(

$mode

)

Sets a new compression mode

Parameters

string

$mode

Supported are 'compress', 'deflate' and 'file'

Definition at line 109 of file Gz.php.

    {
        if (($mode != 'compress') && ($mode != 'deflate')) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Given compression mode not supported');
        }

        $this->_options['mode'] = $mode;
        return $this;
    }

toString()

toString

(

)

Returns the adapter name

Returns

string

Implements Zend_Filter_Compress_CompressInterface.

Definition at line 224 of file Gz.php.

    {
        return 'Gz';
    }

Field Documentation

$_options

$_options

protected

Initial value:

= array(
        'level'   => 9,
        'mode'    => 'compress',
        'archive' => null,
    )

Definition at line 47 of file Gz.php.

---

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

• vendor/magento/zendframework1/library/Zend/Filter/Compress/Gz.php