Please wait while we load your page...

PasswordSentry

Latest Version [8.00202205221] Last Updated [May-22-2022]

Tools

PHP Manual [MongoDB\Driver\ClientEncryption

Protect Your Website Today


PHP Manual || MongoDB\Driver\ClientEncryption

(mongodb >=1.7.0)

MongoDB\Driver\ClientEncryption::encryptEncrypt a value

Description

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

Encrypts the value.

Parameters

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.

Return Values

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

Errors/Exceptions

See Also



PHP Manual || MongoDB\Driver\ClientEncryption