Filter/Encrypt/Mcrypt.php

Show:

inherited

Classes
- \Zend_Filter_Encrypt_Mcrypt

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Filter
Version: $Id: Mcrypt.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Filter_Encrypt_Mcrypt
jump to top

Package: Zend\Filter

Encryption adapter for mcrypt

Implements: \Zend_Filter_Encrypt_Interface
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

array $_compression

Internal compression

Details

Type: array

$_encryption = array('key' => 'ZendFramework', 'algorithm' => 'blowfish', 'algorithm_directory' => '', 'mode' => 'cbc', 'mode_directory' => '', 'vector' => null, 'salt' => false)

Definitions for encryption array( 'key' => encryption key string 'algorithm' => algorithm to use 'algorithm_directory' => directory where to find the algorithm 'mode' => encryption mode to use 'modedirectory' => directory where to find the mode )

Default value

array('key' => 'ZendFramework', 'algorithm' => 'blowfish', 'algorithm_directory' => '', 'mode' => 'cbc', 'mode_directory' => '', 'vector' => null, 'salt' => false)

Details

Type: n/a

$_srandCalled = false

static

Default valuefalseDetails

Type: n/a

Methods

__construct(string | array | \Zend_Config $options) : void

Class constructor

Parameters

Name	Type	Description
$options	string \| array \| \Zend_Config	Cryption Options

_closeCipher(resource $cipher) : \Zend_Filter_Encrypt_Mcrypt

Close a cipher

Parameters

Name	Type	Description
$cipher	resource	Cipher to close

Returns

Type	Description
\Zend_Filter_Encrypt_Mcrypt

_initCipher(resource $cipher) : resource

Initialises the cipher with the set key

Parameters

Name	Type	Description
$cipher	resource

Returns

Type	Description
resource

Throws

Exception	Description

_openCipher() : resource

Open a cipher

Returns

Type	Description
resource	Returns the opened cipher

Throws

Exception	Description
\Zend_Filter_Exception	When the cipher can not be opened

_srand() : void

_srand() interception

Details

See: \ZF-8742

decrypt(string $value) : string

Defined by Zend_Filter_Interface

Decrypts $value with the defined settings

Parameters

Name	Type	Description
$value	string	Content to decrypt

Returns

Type	Description
string	The decrypted content

encrypt(string $value) : string

Defined by Zend_Filter_Interface

Encrypts $value with the defined settings

Parameters

Name	Type	Description
$value	string	The content to encrypt

Returns

Type	Description
string	The encrypted content

getCompression() : array

Returns the compression

Returns

Type	Description
array

getEncryption() : array

Returns the set encryption options

Returns

Type	Description
array

getVector() : string

Returns the set vector

Returns

Type	Description
string

setCompression(string | array $compression) : \Zend_Filter_Encrypt_Mcrypt

Sets a internal compression for values to encrypt

Parameters

Name	Type	Description
$compression	string \| array

Returns

Type	Description
\Zend_Filter_Encrypt_Mcrypt

setEncryption(string | array $options) : \Zend_Filter_File_Encryption

Sets new encryption options

Parameters

Name	Type	Description
$options	string \| array	Encryption options

Returns

Type	Description
\Zend_Filter_File_Encryption

setVector(string $vector = null) : \Zend_Filter_Encrypt_Mcrypt

Sets the initialization vector

Parameters

Name	Type	Description
$vector	string	(Optional) Vector to set

Returns

Type	Description
\Zend_Filter_Encrypt_Mcrypt

toString() : string

Returns the adapter name

Returns

Type	Description
string

Filter/Encrypt/Mcrypt.php

\Zend_Filter_Encrypt_Mcryptjump to top

Properties

Methods

\Zend_Filter_Encrypt_Mcrypt
jump to top