Zend_Filter_Compress Class Reference

Inheritance diagram for Zend_Filter_Compress:

Public Member Functions
	__construct ($options=null)
	setOptions (array $options)
	getAdapter ()
	getAdapterName ()
	setAdapter ($adapter)
	getAdapterOptions ()
	setAdapterOptions (array $options)
	__call ($method, $options)
	filter ($value)

Protected Attributes
	$_adapter = 'Gz'
	$_adapterOptions = array()

Detailed Description

Definition at line 35 of file Compress.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Class constructor

Parameters

string | array

$options

(Optional) Options to set

Definition at line 52 of file Compress.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        }
        if (is_string($options)) {
            $this->setAdapter($options);
        } elseif ($options instanceof Zend_Filter_Compress_CompressInterface) {
            $this->setAdapter($options);
        } elseif (is_array($options)) {
            $this->setOptions($options);
        }
    }

Member Function Documentation

__call()

__call	(		$method,
			$options
	)

Calls adapter methods

Parameters

string	$method	Method to call
string | array	$options	Options for this method

Definition at line 174 of file Compress.php.

    {
        $adapter = $this->getAdapter();
        if (!method_exists($adapter, $method)) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception("Unknown method '{$method}'");
        }

        return call_user_func_array(array($adapter, $method), $options);
    }

filter()

filter

(

$value

)

Defined by Zend_Filter_Interface

Compresses the content $value with the defined settings

Parameters

string

$value

Content to compress

Returns

string The compressed content

Implements Zend_Filter_Interface.

Definition at line 193 of file Compress.php.

    {
        return $this->getAdapter()->compress($value);
    }

getAdapter()

getAdapter

(

)

Returns the current adapter, instantiating it if necessary

Returns

string

Definition at line 91 of file Compress.php.

    {
        if ($this->_adapter instanceof Zend_Filter_Compress_CompressInterface) {
            return $this->_adapter;
        }

        $adapter = $this->_adapter;
        $options = $this->getAdapterOptions();
        if (!class_exists($adapter)) {
            #require_once 'Zend/Loader.php';
            if (Zend_Loader::isReadable('Zend/Filter/Compress/' . ucfirst($adapter) . '.php')) {
                $adapter = 'Zend_Filter_Compress_' . ucfirst($adapter);
            }
            Zend_Loader::loadClass($adapter);
        }

        $this->_adapter = new $adapter($options);
        if (!$this->_adapter instanceof Zend_Filter_Compress_CompressInterface) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception("Compression adapter '" . $adapter . "' does not implement Zend_Filter_Compress_CompressInterface");
        }
        return $this->_adapter;
    }

getAdapterName()

getAdapterName

(

)

Retrieve adapter name

Returns

string

Definition at line 120 of file Compress.php.

    {
        return $this->getAdapter()->toString();
    }

getAdapterOptions()

getAdapterOptions

(

)

Retrieve adapter options

Returns

array

Definition at line 151 of file Compress.php.

    {
        return $this->_adapterOptions;
    }

setAdapter()

setAdapter

(

$adapter

)

Sets compression adapter

Parameters

string | Zend_Filter_Compress_CompressInterface

$adapter

Adapter to use

Returns

Zend_Filter_Compress

Definition at line 131 of file Compress.php.

    {
        if ($adapter instanceof Zend_Filter_Compress_CompressInterface) {
            $this->_adapter = $adapter;
            return $this;
        }
        if (!is_string($adapter)) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Invalid adapter provided; must be string or instance of Zend_Filter_Compress_CompressInterface');
        }
        $this->_adapter = $adapter;

        return $this;
    }

setAdapterOptions()

setAdapterOptions

(

array

$options

)

Set adapter options

Parameters

array

$options

Returns

void

Definition at line 162 of file Compress.php.

    {
        $this->_adapterOptions = $options;
        return $this;
    }

setOptions()

setOptions

(

array

$options

)

Set filter setate

Parameters

array

$options

Returns

Zend_Filter_Compress

Definition at line 72 of file Compress.php.

    {
        foreach ($options as $key => $value) {
            if ($key == 'options') {
                $key = 'adapterOptions';
            }
            $method = 'set' . ucfirst($key);
            if (method_exists($this, $method)) {
                $this->$method($value);
            }
        }
        return $this;
    }

Field Documentation

$_adapter

$_adapter = 'Gz'

protected

Compression adapter

Definition at line 40 of file Compress.php.

$_adapterOptions

$_adapterOptions = array()

protected

Compression adapter constructor options

Definition at line 45 of file Compress.php.

---

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

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