CipherInterface

Crypt cipher interface.

since

12.1

Methods

decrypt

Method to decrypt a data string.

decrypt(string $data, \Joomla\CMS\Crypt\Key $key) : string
since

12.1

Arguments

$data

stringThe encrypted string to decrypt.

$key

\Joomla\CMS\Crypt\KeyThe key[/pair] object to use for decryption.

Response

stringThe decrypted data string.

encrypt

Method to encrypt a data string.

encrypt(string $data, \Joomla\CMS\Crypt\Key $key) : string
since

12.1

Arguments

$data

stringThe data string to encrypt.

$key

\Joomla\CMS\Crypt\KeyThe key[/pair] object to use for encryption.

Response

stringThe encrypted data string.

generateKey

Method to generate a new encryption key[/pair] object.

generateKey(array $options = array()) : \Joomla\CMS\Crypt\Key
since

12.1

Arguments

$options

arrayKey generation options.

Response

\Joomla\CMS\Crypt\Key