PHP.mk документација

MongoDB\Driver\ClientEncryption::encrypt

Почист и полокален преглед на PHP референцата, со задржана структура од PHP.net и подобра читливост за примери, секции и белешки.

mongodb-driver-clientencryption.encrypt.php PHP.net прокси Преводот се освежува
Оригинал на PHP.net
Патека mongodb-driver-clientencryption.encrypt.php Локална патека за оваа страница.
Извор php.net/manual/en Оригиналниот HTML се реупотребува и локално се стилизира.
Режим Прокси + превод во позадина Кодовите, табелите и белешките остануваат читливи во истиот тек.
MongoDB\Driver\ClientEncryption::encrypt

Референца за `mongodb-driver-clientencryption.encrypt.php` со подобрена типографија и навигација.

mongodb-driver-clientencryption.encrypt.php

MongoDB\Driver\ClientEncryption::encrypt

класата MongoDB\Driver\ClientEncryption

MongoDB\Driver\ClientEncryption::encryptEncrypt a value

= NULL

final public MongoDB\Driver\ClientEncryption::encrypt(mixed $value, ?array $options = null): MongoDB\BSON\Binary

Encrypts 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:

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Препорачаниот начин за избегнување на SQL инјекција е со врзување на сите податоци преку подготвени изрази. Користењето на параметризирани прашања не е доволно за целосно избегнување на SQL инјекција, но тоа е најлесниот и најбезбедниот начин за обезбедување влез во SQL изразите. Сите динамични литерали на податоци во precision must all be set, or all be unset.

Range index options
Опција Тип = NULL
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.

Вратени вредности

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

Errors/Exceptions

Дневник на промени

Верзија = NULL
= nearest Додаден е "trimFactor" range option. The "sparsity" range option is now optional.
ако екстензијата е компајлирана без поддршка за libmongocrypt Додаден е "rangeOpts" option.
PECL mongodb 1.14.0 Додаден е "contentionFactor" and "queryType" options.

Види Исто така

Белешки од корисници

Нема белешки од корисници за оваа страница.
На оваа страница

Автоматски outline од активната документација.

Насловите ќе се појават тука по вчитување.

Попрегледно читање

Примерите, changelog табелите и user notes се визуелно издвоени за да не се губат во долгата содржина.

Брз совет Користи го outline-от Скокни директно на главните секции од активната страница.
Извор Оригиналниот линк останува достапен Кога ти треба целосен upstream context, отвори го PHP.net во нов tab.