Encrypt a value

final public MongoDB\Driver\ClientEncryption::encrypt(mixed $value, array $options = ?): MongoDB\BSON\Binary

Encrypts the value.

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 keyId and keyAltName must be provided. The algorithm option is required.

Returns the encrypted value as MongoDB\BSON\Binary object with subtype 6.

MongoDB\Driver\ClientEncryption::encrypt