Référence de l'interface CipherInterface

Graphe d'héritage de CipherInterface:

Fonctions membres publiques
	decrypt ($data, Key $key)
	encrypt ($data, Key $key)
	generateKey (array $options=[])

Fonctions membres publiques statiques
static	isSupported ()

Description détaillée

Joomla Framework Cipher interface.

Depuis

1.0

Documentation des fonctions membres

decrypt()

decrypt	(		$data,
		Key	$key
	)

Method to decrypt a data string.

Paramètres

string	$data	The encrypted string to decrypt.
Key	$key	The key[/pair] object to use for decryption.

Renvoie

string The decrypted data string.

Depuis

1.0

Exceptions

DecryptionException	if the data cannot be decrypted
InvalidKeyTypeException	if the key is not valid for the cipher
UnsupportedCipherException	if the cipher is not supported on the current environment

Implémenté dans OpenSSL, Sodium, SodiumCipher, Crypto, et CryptoCipher.

encrypt()

encrypt	(		$data,
		Key	$key
	)

Method to encrypt a data string.

Paramètres

string	$data	The data string to encrypt.
Key	$key	The key[/pair] object to use for encryption.

Renvoie

string The encrypted data string.

Depuis

1.0

Exceptions

EncryptionException	if the data cannot be encrypted
InvalidKeyTypeException	if the key is not valid for the cipher
UnsupportedCipherException	if the cipher is not supported on the current environment

Implémenté dans Sodium, OpenSSL, SodiumCipher, Crypto, et CryptoCipher.

generateKey()

generateKey

(

array

$options = []

)

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

Paramètres

array

$options

Key generation options.

Renvoie

Key

Depuis

1.0

Exceptions

InvalidKeyException	if the key cannot be generated
UnsupportedCipherException	if the cipher is not supported on the current environment

Implémenté dans Sodium, OpenSSL, SodiumCipher, Crypto, et CryptoCipher.

isSupported()

static isSupported ( )

static

Check if the cipher is supported in this environment.

Renvoie

boolean

Depuis

2.0.0

Implémenté dans Sodium, OpenSSL, Crypto, SodiumCipher, et CryptoCipher.

---

La documentation de cette interface a été générée à partir du fichier suivant :

• CipherInterface.php