API Documentation

Filter/Encrypt/Openssl.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: Openssl.php 20288 2010-01-14 20:15:43Z thomas $
Classes
Zend_Filter_Encrypt_Openssl

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_Openssl

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
$_keys
$_passphrase
Methods
__construct
_setKeys
getPublicKey
setPublicKey
getPrivateKey
setPrivateKey
getEnvelopeKey
setEnvelopeKey
getPassphrase
setPassphrase
encrypt
decrypt
toString

Description

Encryption adapter for openssl

Properties

$_keys

 $_keys = 'array'

Definitions for encryption array( 'public' => public keys 'private' => private keys 'envelope' => resulting envelope keys )

Details

visibility
protected
default
array
final
false
static
false

$_passphrase

string $_passphrase = ''

Internal passphrase

Details

$_passphrase
string
visibility
protected
default
final
false
static
false

Methods

__construct

__construct( string|array $options = array ) :

Class constructor Available options 'public' => public key 'private' => private key 'envelope' => envelope key 'passphrase' => passphrase

Arguments
$options
stringarray
Options for this adapter
Details
visibility
public
final
false
static
false

_setKeys

_setKeys( string|array $keys ) : Zend_Filter_Encrypt_Openssl

Sets the encryption keys

Arguments
$keys
stringarray
Key with type association
Details
visibility
protected
final
false
static
false

decrypt

decrypt( string $value ) : string

Defined by Zend_Filter_Interface

Decrypts the file $value with the defined settings

Arguments
$value
string
Content to decrypt
Output
string
The decrypted content
Details
visibility
public
final
false
static
false
throws

encrypt

encrypt( string $value ) : string

Encrypts the file $value with the defined settings Note that you also need the "encrypted" keys to be able to decrypt

Arguments
$value
string
Content to encrypt
Output
string
The encrypted content
Details
visibility
public
final
false
static
false
throws

getEnvelopeKey

getEnvelopeKey( ) : array

Returns all envelope keys

Output
array
Details
visibility
public
final
false
static
false

getPassphrase

getPassphrase( ) : string

Returns the passphrase

Output
string
Details
visibility
public
final
false
static
false

getPrivateKey

getPrivateKey( ) : array

Returns all private keys

Output
array
Details
visibility
public
final
false
static
false

getPublicKey

getPublicKey( ) : array

Returns all public keys

Output
array
Details
visibility
public
final
false
static
false

setEnvelopeKey

setEnvelopeKey(  $key ) : Zend_Filter_Encrypt_Openssl

Sets envelope keys

Arguments
$key
Details
visibility
public
final
false
static
false

setPassphrase

setPassphrase( string $passphrase ) : Zend_Filter_Encrypt_Openssl

Sets a new passphrase

Arguments
$passphrase
string
Details
visibility
public
final
false
static
false

setPrivateKey

setPrivateKey( string $key, string $passphrase = null ) : Zend_Filter_Encrypt_Openssl

Sets private keys

Arguments
$key
string
Private key
$passphrase
string
Details
visibility
public
final
false
static
false

setPublicKey

setPublicKey( string|array $key ) : Zend_Filter_Encrypt_Openssl

Sets public keys

Arguments
$key
stringarray
Public keys
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.