Php/docs/mongodb-driver-clientencryption.encrypt
From Get docs
MongoDB\Driver\ClientEncryption::encrypt
(mongodb >=1.7.0)
MongoDB\Driver\ClientEncryption::encrypt — Encrypt a value
Description
final public MongoDB\Driver\ClientEncryption::encrypt
( mixed $value
[, array $options
] ) : MongoDB\BSON\Binary
Encrypts the value.
Parameters
valueThe 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.
Errors/Exceptions
- Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
- Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while encrypting the value
