MongoDB\Driver\ClientEncryption::encrypt
(mongodb >=1.7.0)
MongoDB\Driver\ClientEncryption::encrypt — Encrypt a value
Description
$value, array $options = ?): MongoDB\BSON\BinaryEncrypts the value.
Liste de paramètres
-
value -
The value to be encrypted. Any value that can be inserted into MongoDB can be encrypted using this method.
-
options -
Encryption options Option Type Description algorithm string The encryption algorithm to be used. Use the constants defined in MongoDB\Driver\ClientEncryption.
keyAltName string Identifies a key vault collection document by
keyAltName.keyId MongoDB\BSON\Binary Identifies a data key by
_id. The value is a UUID (binary subtype 4).Note: Exactly one of
keyIdandkeyAltNamemust be provided. Thealgorithmoption is required.
Valeurs de retour
Returns the encrypted value as MongoDB\BSON\Binary object with subtype 6.
Erreurs / Exceptions
- Lance une exception MongoDB\Driver\InvalidArgumentException lors d'une erreur survenue pendant l'analyse d'un argument.
- Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while encrypting the value
Voir aussi
- MongoDB\Driver\ClientEncryption::decrypt() - Decrypt a value
add a note
