<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/mongodb.mongodb.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'tr',
  ),
  'this' => 
  array (
    0 => 'class.mongodb-driver-clientencryption.php',
    1 => 'MongoDB\\Driver\\ClientEncryption',
    2 => 'The MongoDB\\Driver\\ClientEncryption class',
  ),
  'up' => 
  array (
    0 => 'mongodb.mongodb.php',
    1 => 'MongoDB\\Driver',
  ),
  'prev' => 
  array (
    0 => 'mongodb-driver-session.starttransaction.php',
    1 => 'MongoDB\\Driver\\Session::startTransaction',
  ),
  'next' => 
  array (
    0 => 'mongodb-driver-clientencryption.addkeyaltname.php',
    1 => 'MongoDB\\Driver\\ClientEncryption::addKeyAltName',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/mongodb/mongodb/driver/clientencryption.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.mongodb-driver-clientencryption.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.mongodb-driver-clientencryption" class="reference">

 <h1 class="title">The MongoDB\Driver\ClientEncryption class</h1>
 

 <div class="partintro"><p class="verinfo">(mongodb &gt;=1.7.0)</p>

  
  <div class="section" id="mongodb-driver-clientencryption.intro">
   <h2 class="title">Giriş</h2>
   <p class="simpara">
    The <span class="classname"><strong class="classname">MongoDB\Driver\ClientEncryption</strong></span> class handles
    creation of data keys for client-side encryption, as well as manually
    encrypting and decrypting values.
   </p>
  </div>
  

  <div class="section" id="mongodb-driver-clientencryption.synopsis">
   <h2 class="title">Sınıf Sözdizimi</h2>

   
   <div class="classsynopsis">
    <span class="ooclass"><strong class="classname"></strong></span>

    
    <div class="classsynopsisinfo">
     <span class="modifier">final</span>
     <span class="ooclass">
      <span class="modifier">class</span> <strong class="classname">MongoDB\Driver\ClientEncryption</strong>
     </span>
     {</div>
    

    
    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Sabitler */</div>
    <div class="fieldsynopsis">
     <span class="modifier">const</span>
     <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
      <var class="fieldsynopsis_varname"><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.deterministic"><var class="varname">AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC</var></a></var><span class="initializer"> = AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
      <var class="fieldsynopsis_varname"><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.random"><var class="varname">AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM</var></a></var><span class="initializer"> = AEAD_AES_256_CBC_HMAC_SHA_512-Random</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
      <var class="fieldsynopsis_varname"><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-indexed"><var class="varname">ALGORITHM_INDEXED</var></a></var><span class="initializer"> = Indexed</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
      <var class="fieldsynopsis_varname"><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-unindexed"><var class="varname">ALGORITHM_UNINDEXED</var></a></var><span class="initializer"> = Unindexed</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
      <var class="fieldsynopsis_varname"><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-range"><var class="varname">ALGORITHM_RANGE</var></a></var><span class="initializer"> = Range</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
      <var class="fieldsynopsis_varname"><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.query-type-equality"><var class="varname">QUERY_TYPE_EQUALITY</var></a></var><span class="initializer"> = equality</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
      <var class="fieldsynopsis_varname"><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.query-type-range"><var class="varname">QUERY_TYPE_RANGE</var></a></var><span class="initializer"> = range</span>;</div>


    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Yöntemler */</div>
    <div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-clientencryption.addkeyaltname.php" class="methodname">addKeyAltName</a></span>(<span class="methodparam"><span class="type"><a href="class.mongodb-bson-binary.php" class="type MongoDB\BSON\Binary">MongoDB\BSON\Binary</a></span> <code class="parameter">$keyId</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$keyAltName</code></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.object.php" class="type object">object</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-clientencryption.construct.php" class="methodname">__construct</a></span>(<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$options</code></span>)</div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-clientencryption.createdatakey.php" class="methodname">createDataKey</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$kmsProvider</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="class.mongodb-bson-binary.php" class="type MongoDB\BSON\Binary">MongoDB\BSON\Binary</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-clientencryption.decrypt.php" class="methodname">decrypt</a></span>(<span class="methodparam"><span class="type"><a href="class.mongodb-bson-binary.php" class="type MongoDB\BSON\Binary">MongoDB\BSON\Binary</a></span> <code class="parameter">$value</code></span>): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-clientencryption.deletekey.php" class="methodname">deleteKey</a></span>(<span class="methodparam"><span class="type"><a href="class.mongodb-bson-binary.php" class="type MongoDB\BSON\Binary">MongoDB\BSON\Binary</a></span> <code class="parameter">$keyId</code></span>): <span class="type"><a href="language.types.object.php" class="type object">object</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-clientencryption.encrypt.php" class="methodname">encrypt</a></span>(<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$value</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="class.mongodb-bson-binary.php" class="type MongoDB\BSON\Binary">MongoDB\BSON\Binary</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-clientencryption.encryptexpression.php" class="methodname">encryptExpression</a></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>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-clientencryption.getkey.php" class="methodname">getKey</a></span>(<span class="methodparam"><span class="type"><a href="class.mongodb-bson-binary.php" class="type MongoDB\BSON\Binary">MongoDB\BSON\Binary</a></span> <code class="parameter">$keyId</code></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.object.php" class="type object">object</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-clientencryption.getkeybyaltname.php" class="methodname">getKeyByAltName</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$keyAltName</code></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.object.php" class="type object">object</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-clientencryption.getkeys.php" class="methodname">getKeys</a></span>(): <span class="type"><a href="class.mongodb-driver-cursor.php" class="type MongoDB\Driver\Cursor">MongoDB\Driver\Cursor</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-clientencryption.removekeyaltname.php" class="methodname">removeKeyAltName</a></span>(<span class="methodparam"><span class="type"><a href="class.mongodb-bson-binary.php" class="type MongoDB\BSON\Binary">MongoDB\BSON\Binary</a></span> <code class="parameter">$keyId</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$keyAltName</code></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.object.php" class="type object">object</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-clientencryption.rewrapmanydatakey.php" class="methodname">rewrapManyDataKey</a></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">$filter</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>

   }</div>
   

  </div>

  
  <div class="section" id="mongodb-driver-clientencryption.constants">
   <h2 class="title">Öntanımlı Sabitler</h2>
   <dl>

    
     <dt id="mongodb-driver-clientencryption.constants.deterministic"><strong><code>MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC</code></strong></dt>
     <dd>
      <span class="simpara">Specifies an algorithm for <a href="https://www.mongodb.com/docs/manual/core/csfle/fundamentals/encryption-algorithms/#deterministic-encryption" class="link external">&raquo;&nbsp;deterministic encryption</a>, which is suitable for querying.</span>
     </dd>
    

    
     <dt id="mongodb-driver-clientencryption.constants.random"><strong><code>MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM</code></strong></dt>
     <dd>
      <span class="simpara">Specifies an algorithm for <a href="https://www.mongodb.com/docs/manual/core/csfle/fundamentals/encryption-algorithms/#randomized-encryption" class="link external">&raquo;&nbsp;randomized encryption</a></span>
     </dd>
    

    
     <dt id="mongodb-driver-clientencryption.constants.algorithm-indexed"><strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-indexed">MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</a></code></strong></dt>
     <dd>
      <span class="simpara">Specifies an algorithm for an indexed, encrypted payload, which can be used with queryable encryption.</span>
      <span class="simpara">To insert or query with an indexed, encrypted payload, the <span class="classname"><a href="class.mongodb-driver-manager.php" class="classname">MongoDB\Driver\Manager</a></span> must be configured with the <code class="literal">&quot;autoEncryption&quot;</code> driver option. The <code class="literal">&quot;bypassQueryAnalysis&quot;</code> auto encryption option may be <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>. The <code class="literal">&quot;bypassAutoEncryption&quot;</code> auto encryption option must be <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.</span>
     </dd>
    

    
     <dt id="mongodb-driver-clientencryption.constants.algorithm-unindexed"><strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-unindexed">MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED</a></code></strong></dt>
     <dd>
      <span class="simpara">Specifies an algorithm for an unindexed, encrypted payload.</span>
     </dd>
    

    
     <dt id="mongodb-driver-clientencryption.constants.algorithm-range"><strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-range">MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</a></code></strong></dt>
     <dd>
      <span class="simpara">
       Specifies an algorithm for a range encrypted payload, which can be used
       with queryable encryption.
      </span>
      <span class="simpara">
       To query with a range encrypted payload, the
       <span class="classname"><a href="class.mongodb-driver-manager.php" class="classname">MongoDB\Driver\Manager</a></span> must be configured with the
       <code class="literal">&quot;autoEncryption&quot;</code> driver option. The
       <code class="literal">&quot;bypassQueryAnalysis&quot;</code> auto encryption option may be
       <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>. The <code class="literal">&quot;bypassAutoEncryption&quot;</code> auto encryption
       option must be <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
      </span>
      <blockquote class="note"><p><strong class="note">Bilginize</strong>: 
       <span class="simpara">The extension does not yet support range queries for Decimal128 BSON field types.</span>
      </p></blockquote>
     </dd>
    

    
     <dt id="mongodb-driver-clientencryption.constants.query-type-equality"><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></dt>
     <dd>
      <span class="simpara">
       Specifies an equality query type, which is used in conjunction with
       <strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-indexed">MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</a></code></strong>.
      </span>
     </dd>
    

    
     <dt id="mongodb-driver-clientencryption.constants.query-type-range"><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></dt>
     <dd>
      <span class="simpara">
       Specifies a range query type, which is used in conjunction with
       <strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-range">MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</a></code></strong>.
      </span>
     </dd>
    

   </dl>
  </div>
  

  <div class="section">
   <h2 class="title">Sürüm Bilgisi</h2>
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Sürüm: </th>
       <th>Açıklama</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>PECL mongodb 2.0.0</td>
       <td>
        <span class="simpara">
         Removed <strong><code>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</code></strong>
         and <strong><code>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW</code></strong>.
        </span>
       </td>
      </tr>

      <tr>
       <td>PECL mongodb 1.20.0</td>
       <td>
        <span class="simpara">
         Added <strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-range">MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE</a></code></strong>
         and <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>.
        </span>
        <span class="simpara">
         Deprecated <strong><code>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</code></strong>
         and <strong><code>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW</code></strong>.
        </span>
       </td>
      </tr>

      <tr>
       <td>PECL mongodb 1.16.0</td>
       <td>
        Added <strong><code>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</code></strong>
        and <strong><code>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW</code></strong>.
       </td>
      </tr>

      <tr>
       <td>PECL mongodb 1.14.0</td>
       <td>
        Added <strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-indexed">MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</a></code></strong>,
        <strong><code><a href="class.mongodb-driver-clientencryption.php#mongodb-driver-clientencryption.constants.algorithm-unindexed">MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED</a></code></strong>,
        and <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>.
       </td>
      </tr>

     </tbody>
    
   </table>

  </div>

  <div class="section" id="mongodb-driver-clientencryption.seealso">
   <h2 class="title">Ayrıca Bakınız</h2>
   <ul class="simplelist">
    <li><span class="function"><a href="mongodb-driver-manager.createclientencryption.php" class="function">MongoDB\Driver\Manager::createClientEncryption()</a></span></li>
   </ul>
  </div>

 </div>

 




















































































<h2>İçindekiler</h2><ul class="chunklist chunklist_reference"><li><a href="mongodb-driver-clientencryption.addkeyaltname.php">MongoDB\Driver\ClientEncryption::addKeyAltName</a> — Adds an alternate name to a key document</li><li><a href="mongodb-driver-clientencryption.construct.php">MongoDB\Driver\ClientEncryption::__construct</a> — Create a new ClientEncryption object</li><li><a href="mongodb-driver-clientencryption.createdatakey.php">MongoDB\Driver\ClientEncryption::createDataKey</a> — Creates a key document</li><li><a href="mongodb-driver-clientencryption.decrypt.php">MongoDB\Driver\ClientEncryption::decrypt</a> — Decrypt a value</li><li><a href="mongodb-driver-clientencryption.deletekey.php">MongoDB\Driver\ClientEncryption::deleteKey</a> — Deletes a key document</li><li><a href="mongodb-driver-clientencryption.encrypt.php">MongoDB\Driver\ClientEncryption::encrypt</a> — Encrypt a value</li><li><a href="mongodb-driver-clientencryption.encryptexpression.php">MongoDB\Driver\ClientEncryption::encryptExpression</a> — Encrypts a match or aggregate expression</li><li><a href="mongodb-driver-clientencryption.getkey.php">MongoDB\Driver\ClientEncryption::getKey</a> — Gets a key document</li><li><a href="mongodb-driver-clientencryption.getkeybyaltname.php">MongoDB\Driver\ClientEncryption::getKeyByAltName</a> — Gets a key document by an alternate name</li><li><a href="mongodb-driver-clientencryption.getkeys.php">MongoDB\Driver\ClientEncryption::getKeys</a> — Gets all key documents</li><li><a href="mongodb-driver-clientencryption.removekeyaltname.php">MongoDB\Driver\ClientEncryption::removeKeyAltName</a> — Removes an alternate name from a key document</li><li><a href="mongodb-driver-clientencryption.rewrapmanydatakey.php">MongoDB\Driver\ClientEncryption::rewrapManyDataKey</a> — Rewraps data keys</li></ul>
</div>
<?php manual_footer($setup); ?>