Référence de la classe Crypt

Graphe d'héritage de Crypt:

Fonctions membres publiques
	__construct (?CipherInterface $cipher=null, ?Key $key=null)
	decrypt ($data)
	encrypt ($data)
	generateKey (array $options=[])
	setKey (Key $key)

Fonctions membres publiques statiques
static	genRandomBytes ($length=16)

Attributs privés
	$cipher
	$key

Description détaillée

Crypt is a Joomla Framework class for handling basic encryption/decryption of data.

Depuis

1.0

Documentation des constructeurs et destructeur

__construct()

__construct	(	?CipherInterface	$cipher = null,
		?Key	$key = null
	)

Object Constructor takes an optional key to be used for encryption/decryption. If no key is given then the secret word from the configuration object is used.

Paramètres

CipherInterface	$cipher	The encryption cipher object.
Key	$key	The encryption key[/pair)].

Depuis

1.0

Références Crypt\$cipher, Crypt\$key, et Crypt\generateKey().

Documentation des fonctions membres

decrypt()

decrypt

(

$data

)

Method to decrypt a data string.

Paramètres

string

$data

The encrypted string to decrypt.

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

Références $data.

encrypt()

encrypt

(

$data

)

Method to encrypt a data string.

Paramètres

string

$data

The data string to encrypt.

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

Références $data.

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

Références $options.

Référencé par Crypt\__construct().

genRandomBytes()

static genRandomBytes (   $length = 16 )

static

Generate random bytes.

Paramètres

integer

$length

Length of the random data to generate

Renvoie

string Random binary data

Depuis

1.0

Référencé par UserHelper\genRandomPassword(), PlgUserToken\getDefaultProfileFieldValues(), et Path\isOwner().

setKey()

setKey

(

Key

$key

)

Method to set the encryption key[/pair] object.

Paramètres

Key

$key

The key object to set.

Renvoie

Crypt Instance of $this to allow chaining.

Depuis

1.0

Références Crypt\$key, et $this.

Documentation des champs

$cipher

$cipher

private

Référencé par Crypt\__construct().

$key

$key

private

Référencé par Crypt\__construct(), et Crypt\setKey().

---

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

• vendor/joomla/crypt/src/Crypt.php