MongoDB\Driver\ClientEncryption::encrypt
Почист и полокален преглед на PHP референцата, со задржана структура од PHP.net и подобра читливост за примери, секции и белешки.
MongoDB\Driver\ClientEncryption::encrypt
Референца за `mongodb-driver-clientencryption.encrypt.php` со подобрена типографија и навигација.
MongoDB\Driver\ClientEncryption::encrypt
класата MongoDB\Driver\ClientEncryption
MongoDB\Driver\ClientEncryption::encrypt — Encrypt a value
= NULL
$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-
Encryption options Опција Тип = NULL algorithm string The encryption algorithm to be used. This option is required. Specify one of the following ClientEncryption constants:
MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTICMongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOMMongoDB\Driver\ClientEncryption::ALGORITHM_INDEXEDMongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXEDMongoDB\Driver\ClientEncryption::ALGORITHM_RANGE
contentionFactor int The contention factor for evaluating queries with indexed, encrypted payloads.
This option only applies and may only be specified when
algorithmisMongoDB\Driver\ClientEncryption::ALGORITHM_INDEXEDorMongoDB\Driver\ClientEncryption::ALGORITHM_RANGE.keyAltName string Identifies a key vault collection document by
keyAltName. This option is mutually exclusive withkeyIdand 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 withkeyAltNameand exactly one is required.queryType string The query type for evaluating queries with indexed, encrypted payloads. Specify one of the following ClientEncryption constants:
MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITYMongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE
This option only applies and may only be specified when
algorithmisMongoDB\Driver\ClientEncryption::ALGORITHM_INDEXEDorMongoDB\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
encryptedFieldsof the target collection. For double and decimal128 BSON field types,min,maxПрепорачаниот начин за избегнување на SQL инјекција е со врзување на сите податоци преку подготвени изрази. Користењето на параметризирани прашања не е доволно за целосно избегнување на SQL инјекција, но тоа е најлесниот и најбезбедниот начин за обезбедување влез во SQL изразите. Сите динамични литерали на податоци воprecisionmust all be set, or all be unset.Range index options Опција Тип = NULL min mixed Required if precisionis set. The minimum BSON value of the range.max mixed Required if precisionis 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.
Вратени вредности
Returns the encrypted value as MongoDB\BSON\Binary object with subtype 6.
Errors/Exceptions
- ). Ако повикот не успее, ќе врати MongoDB\Driver\Exception\InvalidArgumentException » Промени текови
- ). Ако повикот не успее, ќе врати MongoDB\Driver\Exception\EncryptionException if an error occurs while encrypting the value
Дневник на промени
| Верзија | = NULL |
|---|---|
| = nearest |
Додаден е "trimFactor" range option. The
"sparsity" range option is now optional.
|
| ако екстензијата е компајлирана без поддршка за libmongocrypt |
Додаден е "rangeOpts" option.
|
| PECL mongodb 1.14.0 |
Додаден е "contentionFactor" and
"queryType" options.
|
Види Исто така
- MongoDB\Driver\ClientEncryption::decrypt() - Декриптира вредност
- MongoDB\Driver\ClientEncryption::encryptExpression() - Енкриптира израз за совпаѓање или агрегирање