API Documentation

Filter/Encrypt/Mcrypt.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Filter
version
$Id: Mcrypt.php 20132 2010-01-07 21:33:50Z ralph $
Classes
Zend_Filter_Encrypt_Mcrypt

Description

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.

Zend_Filter_Encrypt_Mcrypt

Implements
Zend_Filter_Encrypt_Interface
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Filter
Properties
$_encryption
$_srandCalled
Methods
__construct
getEncryption
setEncryption
getVector
setVector
encrypt
decrypt
toString
_openCipher
_closeCipher
_initCipher
_srand

Description

Encryption adapter for mcrypt

Properties

$_encryption

 $_encryption = 'array'

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 )

Details

visibility
protected
default
array
final
false
static
false

$_srandCalled

 $_srandCalled = 'false'

Details

visibility
protected
default
false
final
false
static
true

Methods

__construct

__construct( string|array|Zend_Config $options ) :

Class constructor

Arguments
$options
stringarrayZend_Config
Cryption Options
Details
visibility
public
final
false
static
false

_closeCipher

_closeCipher( resource $cipher ) : Zend_Filter_Encrypt_Mcrypt

Close a cipher

Arguments
$cipher
resource
Cipher to close
Details
visibility
protected
final
false
static
false

_initCipher

_initCipher( resource $cipher ) : resource

Initialises the cipher with the set key

Arguments
$cipher
resource
Output
resource
Details
visibility
protected
final
false
static
false
throws

_openCipher

_openCipher( ) : resource

Open a cipher

Output
resource
Returns the opened cipher
Details
visibility
protected
final
false
static
false
throws
When the cipher can not be opened

_srand

_srand( ) :

_srand() interception

Details
visibility
protected
final
false
static
false
see
ZF-8742

decrypt

decrypt( string $value ) : string

Defined by Zend_Filter_Interface

Decrypts the file $value with the defined settings

Arguments
$value
string
Full path of file to change
Output
string
The filename which has been set, or false when there were errors
Details
visibility
public
final
false
static
false

encrypt

encrypt( string $value ) : string

Defined by Zend_Filter_Interface

Encrypts the file $value with the defined settings

Arguments
$value
string
Full path of file to change
Output
string
The filename which has been set, or false when there were errors
Details
visibility
public
final
false
static
false

getEncryption

getEncryption( ) : array

Returns the set encryption options

Output
array
Details
visibility
public
final
false
static
false

getVector

getVector( ) : string

Returns the set vector

Output
string
Details
visibility
public
final
false
static
false

setEncryption

setEncryption( string|array $options ) : Zend_Filter_File_Encryption

Sets new encryption options

Arguments
$options
stringarray
Encryption options
Output
Zend_Filter_File_Encryption
Details
visibility
public
final
false
static
false

setVector

setVector( string $vector = null ) : Zend_Filter_Encrypt_Mcrypt

Sets the initialization vector

Arguments
$vector
string
(Optional) Vector to set
Details
visibility
public
final
false
static
false

toString

toString( ) : string

Returns the adapter name

Output
string
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.