Horde_Crypt
in package
Provides an API for various cryptographic systems used by Horde applications.
Tags
Table of Contents
- $_params : array<string|int, mixed>
- Configuration parameters.
- __construct() : mixed
- Constructor.
- decrypt() : array<string|int, mixed>
- Decrypt the requested data.
- encrypt() : array<string|int, mixed>
- Encrypt the requested data.
- factory() : Horde_Crypt
- Attempts to return a concrete Horde_Crypt instance based on $driver.
Properties
$_params
Configuration parameters.
protected
array<string|int, mixed>
$_params
= array()
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $params = array() ]) : mixed
Parameters
- $params : array<string|int, mixed> = array()
-
Configuration parameters:
- email_charset: (string) The default email charset.
Return values
mixed —decrypt()
Decrypt the requested data.
public
decrypt(string $data[, array<string|int, mixed> $params = array() ]) : array<string|int, mixed>
This method should be provided by all classes that extend Horde_Crypt.
Parameters
- $data : string
-
The data to decrypt.
- $params : array<string|int, mixed> = array()
-
An array of arguments needed to decrypt the data.
Tags
Return values
array<string|int, mixed> —The decrypted data.
encrypt()
Encrypt the requested data.
public
encrypt(string $data[, array<string|int, mixed> $params = array() ]) : array<string|int, mixed>
This method should be provided by all classes that extend Horde_Crypt.
Parameters
- $data : string
-
The data to encrypt.
- $params : array<string|int, mixed> = array()
-
An array of arguments needed to encrypt the data.
Return values
array<string|int, mixed> —The encrypted data.
factory()
Attempts to return a concrete Horde_Crypt instance based on $driver.
public
static factory(string $driver[, array<string|int, mixed> $params = array() ]) : Horde_Crypt
Parameters
- $driver : string
-
Either a driver name, or the full class name to use (class must extend Horde_Crypt).
- $params : array<string|int, mixed> = array()
-
A hash containing any additional configuration or parameters a subclass might need.
Tags
Return values
Horde_Crypt —The newly created concrete instance.