array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ja', ), 'this' => array ( 0 => 'mongodb-driver-clientencryption.encrypt.php', 1 => 'MongoDB\\Driver\\ClientEncryption::encrypt', ), 'up' => array ( 0 => 'class.mongodb-driver-clientencryption.php', 1 => 'MongoDB\\Driver\\ClientEncryption', ), 'prev' => array ( 0 => 'mongodb-driver-clientencryption.deletekey.php', 1 => 'MongoDB\\Driver\\ClientEncryption::deleteKey', ), 'next' => array ( 0 => 'mongodb-driver-clientencryption.encryptexpression.php', 1 => 'MongoDB\\Driver\\ClientEncryption::encryptExpression', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/mongodb/mongodb/driver/clientencryption/encrypt.xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); ?>
(mongodb >=1.7.0)
MongoDB\Driver\ClientEncryption::encrypt — Encrypt a value
$value
, ?array $options
= null
): MongoDB\BSON\BinaryEncrypts the value.
value
The value to be encrypted. Any value that can be inserted into MongoDB can be encrypted using this method.
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
|
|||||||||||||||
keyAltName | string |
Identifies a key vault collection document by
|
|||||||||||||||
keyId | MongoDB\BSON\Binary |
Identifies a data key by |
|||||||||||||||
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
|
|||||||||||||||
rangeOpts | array |
Index options for a queryable encryption field supporting
"rangePreview" queries. The options below must match the values set
in the
|
Returns the encrypted value as MongoDB\BSON\Binary object with subtype 6.
バージョン | 説明 |
---|---|
PECL mongodb 1.14.0 |
Added the "contentionFactor" and
"queryType" options.
|