Overview

Packages

  • Crypt

Classes

  • Horde_Crypt
  • Horde_Crypt_Exception
  • Horde_Crypt_Pgp
  • Horde_Crypt_Smime
  • Horde_Crypt_Translation
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Crypt

The Horde_Crypt:: class provides an API for various cryptographic systems used by Horde applications.

Copyright 2002-2012 Horde LLC (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Direct known subclasses

Horde_Crypt_Pgp, Horde_Crypt_Smime
Package: Crypt
Category: Horde
License: LGPL 2.1
Author: Michael Slusarz slusarz@horde.org
Located at Horde/Crypt.php
Methods summary
public static Horde_Crypt
# factory( string $driver, array $params = array() )

Attempts to return a concrete Horde_Crypt instance based on $driver.

Attempts to return a concrete Horde_Crypt instance based on $driver.

Parameters

$driver
<p>Either a driver name, or the full class name to use (class must extend Horde_Crypt).</p>
$params
<p>A hash containing any additional configuration or parameters a subclass might need.</p>

Returns

Horde_Crypt
The newly created concrete instance.

Throws

Horde_Crypt_Exception
public
# __construct( array $params = array() )

Constructor.

Constructor.

Parameters

$params
Configuration parameters: <pre>email_charset - (string) The <span class="php-keyword1">default</span> email charset. <span class="php-keyword1">DEFAULT</span>: NONE temp - (string) [REQUIRED] Location of temporary directory.</pre>

Throws

InvalidArgumentException
public array
# encrypt( string $data, array $params = array() )

Encrypt the requested data. This method should be provided by all classes that extend Horde_Crypt.

Encrypt the requested data. This method should be provided by all classes that extend Horde_Crypt.

Parameters

$data
The data to encrypt.
$params
An array of arguments needed to encrypt the data.

Returns

array
The encrypted data.
public array
# decrypt( string $data, array $params = array() )

Decrypt the requested data. This method should be provided by all classes that extend Horde_Crypt.

Decrypt the requested data. This method should be provided by all classes that extend Horde_Crypt.

Parameters

$data
The data to decrypt.
$params
An array of arguments needed to decrypt the data.

Returns

array
The decrypted data.

Throws

Horde_Crypt_Exception
API documentation generated by ApiGen