<?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 => 'es',
  ),
  'this' => 
  array (
    0 => 'mongodb-driver-clientencryption.encryptexpression.php',
    1 => 'MongoDB\\Driver\\ClientEncryption::encryptExpression',
    2 => 'Cifra una expresi&oacute;n de coincidencia o agregaci&oacute;n',
  ),
  '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' => 'es',
    '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">Cifra una expresión de coincidencia o agregación</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mongodb-driver-clientencryption.encryptexpression-description">
  <h3 class="title">Descripción</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">
   Cifra una expresión de coincidencia o agregación para consultar un índice de rango.
  </p>
  <p class="para">Para consultar con una carga útil cifrada por rango, la opción del controlador <span class="classname"><a href="class.mongodb-driver-manager.php" class="classname">MongoDB\Driver\Manager</a></span> debe ser configurada con la opción del controlador <code class="literal">&quot;autoEncryption&quot;</code>. La opción de cifrado automático <code class="literal">&quot;bypassQueryAnalysis&quot;</code> puede ser <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>. La opción de cifrado automático <code class="literal">&quot;bypassAutoEncryption&quot;</code> debe 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">La extensión aún no admite consultas de rango para los tipos de campo BSON Decimal128.</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">
      La expresión de coincidencia o agregación a cifrar. Las expresiones deben
      utilizar al menos uno de los operadores <code class="literal">$gt</code>, <code class="literal">$gte</code>,
      <code class="literal">$lt</code> o <code class="literal">$lte</code>. Se utiliza un único operador de
      comparación.
     </p>
     <p class="para">
      Un ejemplo de expresión de coincidencia admitida (aplicable a consultas y a la etapa de agregación
      <code class="literal">$match</code>) es el siguiente:
     </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">
      Un ejemplo de expresión de agregación admitida es el siguiente:
     </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>Opciones de cifrado</strong></caption>
        
          <thead>
            <tr>
              <th>Opción</th>
              <th>Tipo</th>
              <th>Descripción</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">
                  El algoritmo de cifrado a utilizar. Esta opción es requerida. Especifique una de las siguientes constantes de
                  <a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants" class="link">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">
                  El factor de contención para evaluar las consultas con cargas útiles cifradas indexadas.
                </p>
                <p class="para">
                  Esta opción se aplica únicamente y solo puede ser especificada cuando
                  <code class="literal">algorithm</code> es
                  <strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-indexed">MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</a></code></strong> o
                  <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 un documento de colección de cofre de claves por <code class="literal">keyAltName</code>. Esta opción es mutuamente exclusiva
                  con <code class="literal">keyId</code> y una de las dos es requerida.
                </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 una clave de datos por <code class="literal">_id</code>. El valor es un UUID (subtipo binario 4). Esta opción es mutuamente
                  exclusiva con <code class="literal">keyAltName</code> y una de las dos es requerida.
                </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">
                  El tipo de consulta para evaluar las consultas con cargas útiles cifradas indexadas. Especifique una de las siguientes constantes de
                  <a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants" class="link">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 opción se aplica únicamente y solo puede ser especificada cuando
                  <code class="literal">algorithm</code> es
                  <strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-indexed">MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</a></code></strong> o
                  <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">
                  Opciones de índice para un campo de cifrado interrogeable que soporta consultas &quot;range&quot;. Las opciones a continuación deben coincidir
                  con los valores definidos en <code class="literal">encryptedFields</code> de la colección objetivo. Para los tipos de campo BSON double y decimal128,
                  <code class="literal">min</code>, <code class="literal">max</code> y <code class="literal">precision</code> deben ser todos definidos o todos no definidos.
                </p>
                <p class="para">
                  <table class="doctable table">
                    <caption><strong>Opciones de índice de rango</strong></caption>
                    
                      <thead>
                        <tr>
                          <th>Opción</th>
                          <th>Tipo</th>
                          <th>Descripción</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>Requisito si <code class="literal">precision</code> está definido. El valor BSON mínimo del rango.</td>
                        </tr>

                        <tr>
                          <td>max</td>
                          <td>
                            <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span>
                          </td>
                          <td>Requisito si <code class="literal">precision</code> está definido. El valor BSON máximo del rango.</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. Entero positivo de 64 bits.</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. Entero positivo de 32 bits que especifica la precisión a utilizar
                           para el cifrado explícito. Solo puede ser definido para los tipos
                           de campo BSON double o decimal128.
                          </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. Entero 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">Valores devueltos</h3>
  <p class="para">
   Devuelve la expresión cifrada como objeto.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-mongodb-driver-clientencryption.encryptexpression-errors">
  <h3 class="title">Errores/Excepciones</h3>
  <ul class="simplelist">
   <li>Lanza una excepción <span class="classname"><strong class="classname">MongoDB\Driver\InvalidArgumentException</strong></span> en caso de error durante el análisis de un argumento.</li>
   <li>Lanza una <span class="classname"><a href="class.mongodb-driver-exception-encryptionexception.php" class="classname">MongoDB\Driver\Exception\EncryptionException</a></span> si ocurre un error durante el cifrado de la expresión</li>
  </ul>
 </div>


 <div class="refsect1 changelog" id="refsect1-mongodb-driver-clientencryption.encryptexpression-changelog">
  <h3 class="title">Historial de cambios</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Versión</th>
       <th>Descripción</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>PECL mongodb 1.20.0</td>
       <td>
        Añadida la opción de rango <code class="literal">&quot;trimFactor&quot;</code>. La opción de rango
        <code class="literal">&quot;sparsity&quot;</code> es ahora opcional.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-mongodb-driver-clientencryption.encryptexpression-seealso">
  <h3 class="title">Ver también</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> - Crea un nuevo Manager MongoDB</span></li>
   <li><span class="function"><a href="mongodb-driver-clientencryption.encrypt.php" class="function" rel="rdfs-seeAlso">MongoDB\Driver\ClientEncryption::encrypt()</a> - Cifra un valor</span></li>
  </ul>
 </div>


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