Zend_Filter_Compress_Bz2 Class Reference

Inheritance diagram for Zend_Filter_Compress_Bz2:

Public Member Functions
	__construct ($options=null)
	getBlocksize ()
	setBlocksize ($blocksize)
	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 Bz2.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Class constructor

Parameters

array | Zend_Config

$options

(Optional) Options to set

Definition at line 56 of file Bz2.php.

    {
        if (!extension_loaded('bz2')) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('This filter needs the bz2 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 120 of file Bz2.php.

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

            bzwrite($file, $content);
            bzclose($file);
            $compressed = true;
        } else {
            $compressed = bzcompress($content, $this->getBlocksize());
        }

        if (is_int($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 151 of file Bz2.php.

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

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

            $compressed = bzread($file);
            bzclose($file);
        } else {
            $compressed = bzdecompress($content);
        }

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

        return $compressed;
    }

getArchive()

getArchive

(

)

Returns the set archive

Returns

string

Definition at line 97 of file Bz2.php.

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

getBlocksize()

getBlocksize

(

)

Returns the set blocksize

Returns

integer

Definition at line 70 of file Bz2.php.

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

setArchive()

setArchive

(

$archive

)

Sets the archive to use for de-/compression

Parameters

string

$archive

Archive to use

Returns

Zend_Filter_Compress_Bz2

Definition at line 108 of file Bz2.php.

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

setBlocksize()

setBlocksize

(

$blocksize

)

Sets a new blocksize

Parameters

integer

$level

Returns

Zend_Filter_Compress_Bz2

Definition at line 81 of file Bz2.php.

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

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

toString()

toString

(

)

Returns the adapter name

Returns

string

Implements Zend_Filter_Compress_CompressInterface.

Definition at line 184 of file Bz2.php.

    {
        return 'Bz2';
    }

Field Documentation

$_options

$_options

protected

Initial value:

= array(
        'blocksize' => 4,
        'archive'   => null,
    )

Definition at line 46 of file Bz2.php.

---

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

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