大网数据广告活动
PHP 语言与运行手册

MongoDB\Driver\ClientEncryption::encrypt · Encrypt a value

· 52CE 我爱测

MongoDB\Driver\ClientEncryption::encrypt — Encrypt a value

MongoDB\Driver\ClientEncryption::encrypt

(mongodb >=1.7.0)

MongoDB\Driver\ClientEncryption::encrypt — Encrypt a value

Description

final public function MongoDB\Driver\ClientEncryption::encrypt(mixed $value, ?array $options = null): 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. This option is required. Specify one of the following ClientEncryption constants:
contentionFactor int The contention factor for evaluating queries with indexed, encrypted payloads. This option only applies and may only be specified when algorithm is MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED or MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE.
keyAltName string Identifies a key vault collection document by keyAltName. This option is mutually exclusive with keyId and exactly one is required.
keyId MongoDB\BSON\Binary Identifies a data key by _id. The value is a UUID (binary subtype 4). This option is mutually exclusive with keyAltName and exactly one is required.
queryType string The query type for evaluating queries with indexed, encrypted payloads. Specify one of the following ClientEncryption constants: This option only applies and may only be specified when algorithm is MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED or MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE.
rangeOpts array Index options for a queryable encryption field supporting "range" queries. The options below must match the values set in the encryptedFields of the target collection. For double and decimal128 BSON field types, min, max, and precision must all be set, or all be unset.

Range index options
Option Type Description
min mixed Required if precision is set. The minimum BSON value of the range.
max mixed Required if precision is set. The maximum BSON value of the range.
sparsity int Optional. Positive 64-bit integer.
precision int Optional. Positive 32-bit integer specifying precision to use for explicit encryption. May only be set for double or decimal128 BSON field types.
trimFactor int Optional. Positive 32-bit integer.

Return Values

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

Errors/Exceptions

Changelog

Version Description
PECL mongodb 1.20.0 Added the "trimFactor" range option. The "sparsity" range option is now optional.
PECL mongodb 1.16.0 Added the "rangeOpts" option.
PECL mongodb 1.14.0 Added the "contentionFactor" and "queryType" options.

See Also

来源:PHP Documentation Group · 作者与贡献记录 · CC BY 3.0。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
PHP Documentation Group
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY 3.0

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。