<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.mongodb-driver-clientencryption.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'mongodb-driver-clientencryption.encryptexpression.php',
    1 => 'MongoDB\\Driver\\ClientEncryption::encryptExpression',
    2 => 'Criptografa uma express&atilde;o de correspond&ecirc;ncia ou de agrega&ccedil;&atilde;o',
  ),
  'up' => 
  array (
    0 => 'class.mongodb-driver-clientencryption.php',
    1 => 'MongoDB\\Driver\\ClientEncryption',
  ),
  'prev' => 
  array (
    0 => 'mongodb-driver-clientencryption.encrypt.php',
    1 => 'MongoDB\\Driver\\ClientEncryption::encrypt',
  ),
  'next' => 
  array (
    0 => 'mongodb-driver-clientencryption.getkey.php',
    1 => 'MongoDB\\Driver\\ClientEncryption::getKey',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/mongodb/mongodb/driver/clientencryption/encryptexpression.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="mongodb-driver-clientencryption.encryptexpression" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">MongoDB\Driver\ClientEncryption::encryptExpression</h1>
  <p class="verinfo">(mongodb &gt;=1.16.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\ClientEncryption::encryptExpression</span> &mdash; <span class="dc-title">Criptografa uma expressão de correspondência ou de agregação</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mongodb-driver-clientencryption.encryptexpression-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><strong>MongoDB\Driver\ClientEncryption::encryptExpression</strong></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.object.php" class="type object">object</a></span></span> <code class="parameter">$expr</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.array.php" class="type array">array</a></span></span> <code class="parameter">$options</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><a href="language.types.object.php" class="type object">object</a></span></div>

  <p class="para rdfs-comment">
   Criptografa uma expressão de correspondência ou de agregação para consultar um índice de intervalo.
  </p>
  <p class="para">Para consultar com uma carga criptografada por intervalo, o <span class="classname"><a href="class.mongodb-driver-manager.php" class="classname">MongoDB\Driver\Manager</a></span> deve ser configurado com a opção de driver <code class="literal">&quot;autoEncryption&quot;</code>. A opção de criptografia automática <code class="literal">&quot;bypassQueryAnalysis&quot;</code> pode ser <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>. A opção de criptografia automática <code class="literal">&quot;bypassAutoEncryption&quot;</code> deve ser <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.</p>
  <blockquote class="note"><p><strong class="note">Nota</strong>: 
   <p class="para">A extensão ainda não oferece suporte a consultas de intervalo para tipos de campo Decimal128 BSON.</p>
  </p></blockquote>
 </div>


 <div class="refsect1 parameters" id="refsect1-mongodb-driver-clientencryption.encryptexpression-parameters">
  <h3 class="title">Parâmetros</h3>
  <dl>
   
    <dt><code class="parameter">expr</code></dt>
    <dd>
     <p class="para">
      A expressão de correspondência ou agregação a ser criptografada. As expressões devem usar pelo
      menos um dos operadores <code class="literal">$gt</code>, <code class="literal">$gte</code>,
      <code class="literal">$lt</code> ou <code class="literal">$lte</code>. Um operador
      <code class="literal">$and</code> de nível superior é necessário, mesmo que apenas um único
      operador de comparação seja usado.
     </p>
     <p class="para">
      Um exemplo de expressão de correspondência suportada (aplica-se a consultas e ao
      estágio de agregação <code class="literal">$match</code>) é o seguinte:
     </p>
     <div class="example-contents">
<div class="textcode"><pre class="textcode">[
    &#039;$and&#039; =&gt; [
        [ &#039;&lt;field&gt;&#039; =&gt; [ &#039;$gt&#039;  =&gt; &#039;&lt;value1&gt;&#039; ] ],
        [ &#039;&lt;field&gt;&#039; =&gt; [ &#039;$lte&#039; =&gt; &#039;&lt;value2&gt;&#039; ] ],
    ],
]</pre>
</div>
     </div>

     <p class="para">
      Um exemplo de expressão de agregação suportada é o seguinte:
     </p>
     <div class="example-contents">
<div class="textcode"><pre class="textcode">[
    &#039;$and&#039; =&gt; [
        [ &#039;$gte&#039; =&gt; [ &#039;&lt;fieldPath&gt;&#039;, &#039;&lt;value1&gt;&#039; ] ],
        [ &#039;$lt&#039;  =&gt; [ &#039;&lt;fieldPath&gt;&#039;, &#039;&lt;value2&gt;&#039; ] ],
    ],
]</pre>
</div>
     </div>

    </dd>
   
   
   
    <dt><code class="parameter">options</code></dt>
    <dd>
     <p class="para">
      <table class="doctable table">
       <caption><strong>Opções de criptografia</strong></caption>
       
        <thead>
         <tr>
          <th>Opção</th>
          <th>Tipo</th>
          <th>Descrição</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td>algorithm</td>
          <td><span class="type"><a href="language.types.string.php" class="type string">string</a></span></td>
          <td>
           <p class="para">
            O algoritmo de criptografia a ser usado. Esta opção é obrigatória.
            Especifique uma das seguintes
            <a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants" class="link">constantes ClientEncryption</a>:
           </p>
           <ul class="simplelist">
            <li><strong><code>MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC</code></strong></li>
            <li><strong><code>MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM</code></strong></li>
            <li><strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-indexed">MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</a></code></strong></li>
            <li><strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-unindexed">MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED</a></code></strong></li>
            <li><strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-range">MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</a></code></strong></li>
           </ul>
          </td>
         </tr>

         <tr>
          <td>contentionFactor</td>
          <td><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></td>
          <td>
           <p class="para">
            O fator de contenção para avaliar consultas com cargas indexadas e
            criptografadas.
           </p>
           <p class="para">
            Esta opção só se aplica e só pode ser especificada quando
            <code class="literal">algorithm</code> for
            <strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-indexed">MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</a></code></strong>
            ou
            <strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-range">MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</a></code></strong>.
           </p>
          </td>
         </tr>

         <tr>
          <td>keyAltName</td>
          <td><span class="type"><a href="language.types.string.php" class="type string">string</a></span></td>
          <td>
           <p class="para">
            Identifica um documento de coleção de cofres de chaves por
            <code class="literal">keyAltName</code>. Esta opção é mutuamente exclusiva
            com <code class="literal">keyId</code> e exatamente uma é necessária.
           </p>
          </td>
         </tr>

         <tr>
          <td>keyId</td>
          <td><span class="classname"><a href="class.mongodb-bson-binary.php" class="classname">MongoDB\BSON\Binary</a></span></td>
          <td>
           <p class="para">
            Identifica uma chave de dados por <code class="literal">_id</code>. O valor é um UUID
            (subtipo binário 4). Esta opção é mutuamente exclusiva com
            <code class="literal">keyAltName</code> e exatamente uma é necessária.
           </p>
          </td>
         </tr>

         <tr>
          <td>queryType</td>
          <td><span class="type"><a href="language.types.string.php" class="type string">string</a></span></td>
          <td>
           <p class="para">
            O tipo de consulta para avaliar consultas com cargas indexadas e
            criptografadas. Especifique uma das seguintes
            <a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants" class="link">constantes ClientEncryption</a>:
           </p>
           <ul class="simplelist">
            <li><strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.query-type-equality">MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY</a></code></strong></li>
            <li><strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.query-type-range">MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE</a></code></strong></li>
           </ul>
           <p class="para">
            Esta opção só se aplica e só pode ser especificada quando
            <code class="literal">algorithm</code> for
            <strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-indexed">MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</a></code></strong>
            ou <strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-range">MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</a></code></strong>.
           </p>
          </td>
         </tr>

         <tr>
          <td>rangeOpts</td>
          <td><span class="type"><a href="language.types.array.php" class="type array">array</a></span></td>
          <td>
           <p class="para">
            Opções de índice para um campo de criptografia consultável compatível
            com consultas &quot;range&quot;. As opções abaixo devem corresponder aos valores definidos
            nos <code class="literal">encryptedFields</code> da coleção de destino.
            Para tipos de campo double e decimal128 BSON, <code class="literal">min</code>,
            <code class="literal">max</code> e <code class="literal">precision</code> devem ser todos
            definidos ou nenhum definido.
           </p>
           <p class="para">
            <table class="doctable table">
             <caption><strong>Opções de índice de intervalo</strong></caption>
             
              <thead>
               <tr>
                <th>Opção</th>
                <th>Tipo</th>
                <th>Descrição</th>
               </tr>

              </thead>

              <tbody class="tbody">
               <tr>
                <td>min</td>
                <td><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></td>
                <td>
                 Obrigatória se <code class="literal">precision</code> for definida.
                 O valor BSON mínimo do intervalo.
                </td>
               </tr>

               <tr>
                <td>max</td>
                <td><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></td>
                <td>
                 Obrigatória se <code class="literal">precision</code> for definida.
                 O valor BSON máximo do intervalo.
                </td>
               </tr>

               <tr>
                <td>sparsity</td>
                <td><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></td>
                <td>Opcional. Inteiro de 64 bits positivo.</td>
               </tr>

               <tr>
                <td>precision</td>
                <td><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></td>
                <td>
                 Opcional. Inteiro positivo de 32 bits que especifica a precisão a ser usada
                 para criptografia explícita. Só pode ser definida para tipos de
                 campo double ou decimal128 BSON.
                </td>
               </tr>

               <tr>
                <td>trimFactor</td>
                <td><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></td>
                <td>Opcional. Inteiro positivo de 32 bits.</td>
               </tr>

              </tbody>
             
            </table>

           </p>
          </td>
         </tr>

        </tbody>
       
      </table>

     </p>
    </dd>
   

  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-mongodb-driver-clientencryption.encryptexpression-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Retorna a expressão criptografada como um objeto.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-mongodb-driver-clientencryption.encryptexpression-errors">
  <h3 class="title">Erros/Exceções</h3>
  <ul class="simplelist">
   <li>Lança uma exceção <span class="classname"><a href="class.mongodb-driver-exception-invalidargumentexception.php" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a></span> em caso de erro ao analisar argumentos.</li>
   <li>Lança <span class="classname"><a href="class.mongodb-driver-exception-encryptionexception.php" class="classname">MongoDB\Driver\Exception\EncryptionException</a></span> se ocorrer um erro ao criptografar a expressão</li>
  </ul>
 </div>


 <div class="refsect1 changelog" id="refsect1-mongodb-driver-clientencryption.encryptexpression-changelog">
  <h3 class="title">Registro de Alterações</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Versão</th>
       <th>Descrição</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>PECL mongodb 1.20.0</td>
       <td>
        Adiciona a opção de intervalo <code class="literal">&quot;trimFactor&quot;</code> A
        opção de intervalo <code class="literal">&quot;sparsity&quot;</code> agora é opcional.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-mongodb-driver-clientencryption.encryptexpression-seealso">
  <h3 class="title">Veja Também</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="mongodb-driver-manager.construct.php" class="function" rel="rdfs-seeAlso">MongoDB\Driver\Manager::__construct()</a> - Cria um novo gerenciador MongoDB</span></li>
   <li><span class="function"><a href="mongodb-driver-clientencryption.encrypt.php" class="function" rel="rdfs-seeAlso">MongoDB\Driver\ClientEncryption::encrypt()</a> - Criptografa um valor</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>