PHP 8.1.28 Released!

MongoDB\Driver\ClientEncryption::encrypt

(mongodb >=1.7.0)

MongoDB\Driver\ClientEncryption::encryptEncrypt a value

Descrição

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

Encrypts the value.

Parâmetros

value

The value to be encrypted. Any value that can be inserted into MongoDB can be encrypted using this method.

options

Opções de criptografia
Opção Tipo Descrição
algorithm string

O algoritmo de criptografia a ser usado. Esta opção é obrigatória. Especifique uma das seguintes constantes ClientEncryption:

contentionFactor int

O fator de contenção para avaliar consultas com cargas indexadas e criptografadas.

Esta opção só se aplica e só pode ser especificada quando algorithm for MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED ou MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW.

keyAltName string

Identifica um documento de coleção de cofres de chaves por keyAltName. Esta opção é mutuamente exclusiva com keyId e exatamente uma é necessária.

keyId MongoDB\BSON\Binary

Identifica uma chave de dados por _id. O valor é um UUID (subtipo binário 4). Esta opção é mutuamente exclusiva com keyAltName e exatamente uma é necessária.

queryType string

O tipo de consulta para avaliar consultas com cargas indexadas e criptografadas. Especifique uma das seguintes constantes ClientEncryption:

Esta opção só se aplica e só pode ser especificada quando algorithm for MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED ou MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW.

rangeOpts array

Opções de índice para um campo de criptografia consultável compatível com consultas "rangePreview". As opções abaixo devem corresponder aos valores definidos nos encryptedFields da coleção de destino. Para tipos de campo double e decimal128 BSON, min, max e precision devem ser todos definidos ou nenhum definido.

Opções de índice de intervalo
Opção Tipo Descrição
min mixed Obrigatória se precision for definida.
max mixed Obrigatória se precision for definida.
sparsity int Obrigatória.
precision int Opcional. Só pode ser definida para tipos de campo double ou decimal128 BSON.

Valor Retornado

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

Erros/Exceções

Registro de Alterações

Versão Descrição
PECL mongodb 1.14.0 Added the "contentionFactor" and "queryType" options.

Veja Também

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top