<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.hash.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.hash-init.php',
    1 => 'hash_init',
    2 => 'Инициализирует контекст инкрементного хеширования',
  ),
  'up' => 
  array (
    0 => 'ref.hash.php',
    1 => 'Функции Hash',
  ),
  'prev' => 
  array (
    0 => 'function.hash-hmac-file.php',
    1 => 'hash_hmac_file',
  ),
  'next' => 
  array (
    0 => 'function.hash-pbkdf2.php',
    1 => 'hash_pbkdf2',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/hash/functions/hash-init.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.hash-init" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">hash_init</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.1.2, PHP 7, PHP 8, PECL hash &gt;= 1.1)</p><p class="refpurpose"><span class="refname">hash_init</span> &mdash; <span class="dc-title">Инициализирует контекст инкрементного хеширования</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.hash-init-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>hash_init</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$algo</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="attribute"><a href="class.sensitiveparameter.php">#[\SensitiveParameter]</a> </span><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$key</code><span class="initializer"> = &quot;&quot;</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$options</code><span class="initializer"> = []</span></span><br>): <span class="type"><a href="class.hashcontext.php" class="type HashContext">HashContext</a></span></div>


 </div>

 <div class="refsect1 parameters" id="refsect1-function.hash-init-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">algo</code></dt>
     <dd>
      <p class="para">
       Название алгоритма хеширования (например, <code class="literal">&quot;sha256&quot;</code>).
       Список алгоритмов, которые поддерживает функция, приводит описание функции <span class="function"><a href="function.hash-hmac-algos.php" class="function">hash_hmac_algos()</a></span>.
       <blockquote class="note"><p><strong class="note">Замечание</strong>: 
        <p class="para">
         Некриптографические хеш-функции не допускаются, если указали флаг <strong><code><a href="hash.constants.php#constant.hash-hmac">HASH_HMAC</a></code></strong>.
        </p>
       </p></blockquote>
      </p>
     </dd>
    
    
     <dt><code class="parameter">flags</code></dt>
     <dd>
      <p class="para">
       Необязательные настройки для генерации хеша, пока поддерживается только один вариант:
       <strong><code><a href="hash.constants.php#constant.hash-hmac">HASH_HMAC</a></code></strong>. При этом параметр <code class="parameter">key</code>
       <em>должен</em> быть указан.
      </p>
     </dd>
    
    
     <dt><code class="parameter">key</code></dt>
     <dd>
      <p class="para">
       Если флаг <strong><code><a href="hash.constants.php#constant.hash-hmac">HASH_HMAC</a></code></strong> указали для параметра <code class="parameter">flags</code>,
       то в этом параметре нужно указать общий секретный ключ, который функция использует
       с методом хеширования HMAC.
      </p>
     </dd>
    
    
     <dt><code class="parameter">options</code></dt>
     <dd>
      <p class="para">
       Массив опций для алгоритмов хеширования.
       Пока вариантами функций хеширования MurmurHash поддерживается только параметр <code class="literal">&quot;seed&quot;</code>.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.hash-init-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Функция возвращает контекст хеширования для передачи в функции
   <span class="function"><a href="function.hash-update.php" class="function">hash_update()</a></span>, <span class="function"><a href="function.hash-update-stream.php" class="function">hash_update_stream()</a></span>,
   <span class="function"><a href="function.hash-update-file.php" class="function">hash_update_file()</a></span> и <span class="function"><a href="function.hash-final.php" class="function">hash_final()</a></span>.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.hash-init-errors">
  <h3 class="title">Ошибки</h3>
  <ul class="itemizedlist">
   <li class="listitem">
    <span class="simpara">
     Функция выбрасывает ошибку <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span>,
     если в параметре <code class="parameter">algo</code> указали неизвестную или некриптографическую
     хеш-функцию, или если параметр <code class="parameter">key</code> пуст.
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     При передаче в аргументе <code class="parameter">options</code>
     параметров конфигурации неверного типа теперь выдаётся ошибка уровня
     <strong><code><a href="errorfunc.constants.php#constant.e-deprecated">E_DEPRECATED</a></code></strong>, поскольку такие параметры иногда интерпретируются
     неправильно.
     В будущем это станет выбрасывать ошибку <span class="exceptionname"><a href="class.valueerror.php" class="exceptionname">ValueError</a></span>.
    </span>
   </li>
  </ul>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.hash-init-changelog">
  <h3 class="title">Список изменений</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Версия</th>
       <th>Описание</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>8.4.0</td>
       <td>Передача параметров неверного типа устарела.</td>
      </tr>

      <tr>
       <td>8.1.0</td>
       <td>
        Добавили параметр <code class="parameter">options</code>.
       </td>
      </tr>

      <tr>
       <td>8.0.0</td>
       <td>
        Теперь функция выбрасывает исключение <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span>,
        если параметр <code class="parameter">algo</code> неизвестен или не криптографическая хеш-функция,
        или если параметр <code class="parameter">key</code> пуст;
        раньше возвращалось значение <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> и выдавалась ошибка уровня <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>.
        emitted.
       </td>
      </tr>

      <tr>
       <td>7.2.0</td>
       <td>
        Запретили некриптографические хеш-функции
        (adler32, crc32, crc32b, fnv132, fnv1a32, fnv164, fnv1a64, joaat) с константой
        <strong><code><a href="hash.constants.php#constant.hash-hmac">HASH_HMAC</a></code></strong>.
       </td>
      </tr>

      <tr>
       <td>7.2.0</td>
       <td>
        Функция возвращает объект класса <span class="classname"><a href="class.hashcontext.php" class="classname">HashContext</a></span>, а не ресурс.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.hash-init-examples">
  <h3 class="title">Примеры</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Пример #1 Пример инкрементного хеширования</strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$hash </span><span style="color: #007700">= </span><span style="color: #0000BB">hash</span><span style="color: #007700">(</span><span style="color: #DD0000">'sha256'</span><span style="color: #007700">, </span><span style="color: #DD0000">'The quick brown fox jumped over the lazy dog.'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$ctx </span><span style="color: #007700">= </span><span style="color: #0000BB">hash_init</span><span style="color: #007700">(</span><span style="color: #DD0000">'sha256'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">hash_update</span><span style="color: #007700">(</span><span style="color: #0000BB">$ctx</span><span style="color: #007700">, </span><span style="color: #DD0000">'The quick brown fox '</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">hash_update</span><span style="color: #007700">(</span><span style="color: #0000BB">$ctx</span><span style="color: #007700">, </span><span style="color: #DD0000">'jumped over the lazy dog.'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$incremental_hash </span><span style="color: #007700">= </span><span style="color: #0000BB">hash_final</span><span style="color: #007700">(</span><span style="color: #0000BB">$ctx</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">$incremental_hash</span><span style="color: #007700">, </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$hash </span><span style="color: #007700">=== </span><span style="color: #0000BB">$incremental_hash</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    
<div class="example-contents"><p>
 Результат выполнения приведённого примера:
</p></div>

    <div class="example-contents screen">
<div class="annotation-interactive examplescode"><pre class="examplescode">68b1282b91de2c054c36629cb8dd447f12f096d3e3c587978dc2248444633483
bool(true)</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.hash-init-seealso">
  <h3 class="title">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.hash-algos.php" class="function" rel="rdfs-seeAlso">hash_algos()</a> - Возвращает список зарегистрированных алгоритмов хеширования</span></li>
    <li><span class="function"><a href="function.hash-update.php" class="function" rel="rdfs-seeAlso">hash_update()</a> - Добавляет данные в активный контекст хеширования</span></li>
    <li><span class="function"><a href="function.hash-update-file.php" class="function" rel="rdfs-seeAlso">hash_update_file()</a> - Добавляет данные из файла в активный контекст хеширования</span></li>
    <li><span class="function"><a href="function.hash-update-stream.php" class="function" rel="rdfs-seeAlso">hash_update_stream()</a> - Добавляет данные из открытого потока в активный контекст хеширования</span></li>
    <li><span class="function"><a href="function.hash-final.php" class="function" rel="rdfs-seeAlso">hash_final()</a> - Завершает инкрементальное хеширование и возвращает результат в виде хеш-кода</span></li>
   </ul>
  </p>
 </div>


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