Docs Menu

Docs HomePHP Library Manual

MongoDB\Client::createClientEncryption()

On this page

  • Definition
  • Parameters
  • Return Values
  • Errors/Exceptions
  • See Also
MongoDB\\Client::createClientEncryption()

Returns a MongoDB\\Driver\\ClientEncryption object for manual encryption and decryption of values.

function createClientEncryption(array $options): MongoDB\Driver\ClientEncryption
$options : array

An array specifying the desired options. Refer to the MongoDB\\Driver\\Manager::createClientEncryption() extension documentation for a list of supported options.

If a MongoDB\\Client is provided for the keyVaultClient option, it will be unwrapped into a MongoDB\\Driver\\Manager for the extension.

A MongoDB\\Driver\\ClientEncryption instance which can be used to encrypt and decrypt values.

MongoDB\\Exception\\InvalidArgumentException for errors related to the parsing of parameters or options.

MongoDB\\Driver\\Exception\\InvalidArgumentException for errors related to the parsing of parameters or options at the driver level.

←  MongoDB\Client::__get()MongoDB\Client::dropDatabase() →