Zend_Filter_Encrypt Class Reference

Inheritance diagram for Zend_Filter_Encrypt:

Public Member Functions
	__construct ($options=null)
	getAdapter ()
	setAdapter ($options=null)
	__call ($method, $options)
	filter ($value)

Protected Attributes
	$_adapter

Detailed Description

Definition at line 40 of file Encrypt.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Class constructor

Parameters

string | array

$options

(Optional) Options to set, if null mcrypt is used

Definition at line 52 of file Encrypt.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        }

        $this->setAdapter($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 115 of file Encrypt.php.

    {
        $part = substr($method, 0, 3);
        if ((($part != 'get') and ($part != 'set')) or !method_exists($this->_adapter, $method)) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception("Unknown method '{$method}'");
        }

        return call_user_func_array(array($this->_adapter, $method), $options);
    }

filter()

filter

(

$value

)

Defined by Zend_Filter_Interface

Encrypts the content $value with the defined settings

Parameters

string

$value

Content to encrypt

Returns

string The encrypted content

Implements Zend_Filter_Interface.

Definition at line 134 of file Encrypt.php.

    {
        return $this->_adapter->encrypt($value);
    }

getAdapter()

getAdapter

(

)

Returns the name of the set adapter

Returns

string

Definition at line 66 of file Encrypt.php.

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

setAdapter()

setAdapter

(

$options = null

)

Sets new encryption options

Parameters

string | array

$options

(Optional) Encryption options

Returns

Zend_Filter_Encrypt

Definition at line 77 of file Encrypt.php.

    {
        if (is_string($options)) {
            $adapter = $options;
        } else if (isset($options['adapter'])) {
            $adapter = $options['adapter'];
            unset($options['adapter']);
        } else {
            $adapter = 'Mcrypt';
        }

        if (!is_array($options)) {
            $options = array();
        }

        if (Zend_Loader::isReadable('Zend/Filter/Encrypt/' . ucfirst($adapter). '.php')) {
            $adapter = 'Zend_Filter_Encrypt_' . ucfirst($adapter);
        }

        if (!class_exists($adapter)) {
            Zend_Loader::loadClass($adapter);
        }

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

        return $this;
    }

Field Documentation

$_adapter

$_adapter

protected

Encryption adapter

Definition at line 45 of file Encrypt.php.

---

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

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