<?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 => 'ru',
  ),
  'this' => 
  array (
    0 => 'mongodb-driver-clientencryption.addkeyaltname.php',
    1 => 'MongoDB\\Driver\\ClientEncryption::addKeyAltName',
    2 => 'Добавляет альтернативное имя к документу с ключом',
  ),
  'up' => 
  array (
    0 => 'class.mongodb-driver-clientencryption.php',
    1 => 'MongoDB\\Driver\\ClientEncryption',
  ),
  'prev' => 
  array (
    0 => 'class.mongodb-driver-clientencryption.php',
    1 => 'MongoDB\\Driver\\ClientEncryption',
  ),
  'next' => 
  array (
    0 => 'mongodb-driver-clientencryption.construct.php',
    1 => 'MongoDB\\Driver\\ClientEncryption::__construct',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/mongodb/mongodb/driver/clientencryption/addkeyaltname.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="mongodb-driver-clientencryption.addkeyaltname" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">MongoDB\Driver\ClientEncryption::addKeyAltName</h1>
  <p class="verinfo">(mongodb &gt;=1.15.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\ClientEncryption::addKeyAltName</span> &mdash; <span class="dc-title">Добавляет альтернативное имя к документу с ключом</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mongodb-driver-clientencryption.addkeyaltname-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><strong>MongoDB\Driver\ClientEncryption::addKeyAltName</strong></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>

  <p class="para rdfs-comment">
   Добавляет параметр <code class="parameter">keyAltName</code> в набор альтернативных имён
   для документа с ключом с заданным UUID <code class="parameter">keyId</code>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-mongodb-driver-clientencryption.addkeyaltname-parameters">
  <h3 class="title">Список параметров</h3>
  <dl>
   
    <dt><code class="parameter">keyId</code></dt>
    <dd>
     <p class="para">
      Экземпляр <span class="classname"><a href="class.mongodb-bson-binary.php" class="classname">MongoDB\BSON\Binary</a></span> с подтипом 4 (UUID),
      идентифицирующий документ с ключом.
     </p>
    </dd>
   

   
    <dt><code class="parameter">keyAltName</code></dt>
    <dd>
     <p class="para">
      Альтернативное имя для добавления в документ с ключом.
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-mongodb-driver-clientencryption.addkeyaltname-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Возвращает предыдущую версию документа с ключом или <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>,
   если ни один документ не был найден.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-mongodb-driver-clientencryption.addkeyaltname-errors">
  <h3 class="title">Ошибки</h3>
  <ul class="simplelist">
   <li>При ошибке парсинга аргумента метод выбрасывает исключение  <span class="classname"><a href="class.mongodb-driver-exception-invalidargumentexception.php" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a></span>.</li><li>При неудачном соединении с сервером (кроме ошибок аутентификации) метод выбрасывает исключение <span class="classname"><a href="class.mongodb-driver-exception-connectionexception.php" class="classname">MongoDB\Driver\Exception\ConnectionException</a></span>.</li><li>При неудачной аутентификации метод выбрасывает исключение <span class="classname"><a href="class.mongodb-driver-exception-authenticationexception.php" class="classname">MongoDB\Driver\Exception\AuthenticationException</a></span>.</li>
   <li>Выбрасывает исключение <span class="classname"><a href="class.mongodb-driver-exception-runtimeexception.php" class="classname">MongoDB\Driver\Exception\RuntimeException</a></span> в случае возникновения прочих ошибок.</li>
  </ul>
 </div>


 <div class="refsect1 seealso" id="refsect1-mongodb-driver-clientencryption.addkeyaltname-seealso">
  <h3 class="title">Смотрите также</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="mongodb-driver-clientencryption.getkeybyaltname.php" class="function" rel="rdfs-seeAlso">MongoDB\Driver\ClientEncryption::getKeyByAltName()</a> - Получает документ с ключом по альтернативному имени</span></li>
   <li><span class="function"><a href="mongodb-driver-clientencryption.removekeyaltname.php" class="function" rel="rdfs-seeAlso">MongoDB\Driver\ClientEncryption::removeKeyAltName()</a> - Удаляет альтернативное имя из документа с ключом</span></li>
  </ul>
 </div>

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