<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.rarentry.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'rarentry.getstream.php',
    1 => 'RarEntry::getStream',
    2 => 'Получить обработчик для записи',
  ),
  'up' => 
  array (
    0 => 'class.rarentry.php',
    1 => 'RarEntry',
  ),
  'prev' => 
  array (
    0 => 'rarentry.getpackedsize.php',
    1 => 'RarEntry::getPackedSize',
  ),
  'next' => 
  array (
    0 => 'rarentry.getunpackedsize.php',
    1 => 'RarEntry::getUnpackedSize',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/rar/rarentry/getstream.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="rarentry.getstream" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">RarEntry::getStream</h1>
  <p class="verinfo">(PECL rar &gt;= 2.0.0)</p><p class="refpurpose"><span class="refname">RarEntry::getStream</span> &mdash; <span class="dc-title">Получить обработчик для записи</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-rarentry.getstream-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>RarEntry::getStream</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$password</code><span class="initializer"> = ?</span></span>): <span class="type"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">
   Возвращает обработчик, поддерживающий операцию чтения. Этот обработчик
   умеет распаковывать запись на лету.
  </p>
  <p class="simpara">
   Обработчик не уничтожается при вызове
   <span class="function"><a href="rararchive.close.php" class="function">rar_close()</a></span>.
  </p>
  <div class="warning"><strong class="warning">Внимание</strong>
   <p class="simpara">Результирующий поток не проверяется на целостность. Следовательно
    никак не определяется порча файла или расшифровка с неверным ключом. Проверка
    контрольной суммы разжатого и расшифрованного файла полностью на
    совести разработчика.</p>
  </div>
 </div>


 <div class="refsect1 parameters" id="refsect1-rarentry.getstream-parameters">
  <h3 class="title">Список параметров</h3>
  <dl>
   
    <dt><code class="parameter">password</code></dt>
    <dd>
     <span class="simpara">
      Пароль, использовавшийся для шифрования записи. Если запись не шифрована, то
      этот параметр игнорируется и в целом может быть опущен. Если же параметр опущен,
      а запись шифрована, то будет использован пароль заданный в функции
      <span class="function"><a href="rararchive.open.php" class="function">rar_open()</a></span>, если конечно он был задан. Если был задан неверный
      пароль, явно или неявно через <span class="function"><a href="rararchive.open.php" class="function">rar_open()</a></span>, этот метод вернёт
      поток с неверными данными. Если пароль не задан вообще, а он нужен, то метод
      вернёт <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>. Зашифрована ли запись или нет можно проверить с помощью
      <span class="methodname"><a href="rarentry.isencrypted.php" class="methodname">RarEntry::isEncrypted()</a></span>.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-rarentry.getstream-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="simpara">
   Обработчик или <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, если возникла ошибка.
  </p>
 </div>


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

    </thead>

    <tbody class="tbody">
     <tr>
      <td>PECL rar 3.0.0</td>
      <td>
       Поддержка RAR-архивов с дублирующимися именами записей теперь работает нормально.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-rarentry.getstream-examples">
  <h3 class="title">Примеры</h3>
  <div class="example" id="example-1">
   <p><strong>Пример #1 Пример использования <span class="methodname"><strong>RarEntry::getStream()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$rar_file </span><span style="color: #007700">= </span><span style="color: #0000BB">rar_open</span><span style="color: #007700">(</span><span style="color: #DD0000">'example.rar'</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$rar_file </span><span style="color: #007700">=== </span><span style="color: #0000BB">false</span><span style="color: #007700">)<br />    die(</span><span style="color: #DD0000">"Не удалось открыть Rar архив"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$entry </span><span style="color: #007700">= </span><span style="color: #0000BB">rar_entry_get</span><span style="color: #007700">(</span><span style="color: #0000BB">$rar_file</span><span style="color: #007700">, </span><span style="color: #DD0000">'Dir/file.txt'</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$entry </span><span style="color: #007700">=== </span><span style="color: #0000BB">false</span><span style="color: #007700">)<br />    die(</span><span style="color: #DD0000">"Не удалось найти такую запись"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$stream </span><span style="color: #007700">= </span><span style="color: #0000BB">$entry</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getStream</span><span style="color: #007700">();<br />if (</span><span style="color: #0000BB">$stream </span><span style="color: #007700">=== </span><span style="color: #0000BB">false</span><span style="color: #007700">)<br />    die(</span><span style="color: #DD0000">"Не удалось получить поток."</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">rar_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$rar_file</span><span style="color: #007700">); </span><span style="color: #FF8000">//поток не зависит от файла<br /><br /></span><span style="color: #007700">while (!</span><span style="color: #0000BB">feof</span><span style="color: #007700">(</span><span style="color: #0000BB">$stream</span><span style="color: #007700">)) {<br />    </span><span style="color: #0000BB">$buff </span><span style="color: #007700">= </span><span style="color: #0000BB">fread</span><span style="color: #007700">(</span><span style="color: #0000BB">$stream</span><span style="color: #007700">, </span><span style="color: #0000BB">8192</span><span style="color: #007700">);<br />    if (</span><span style="color: #0000BB">$buff </span><span style="color: #007700">!== </span><span style="color: #0000BB">false</span><span style="color: #007700">)<br />        echo </span><span style="color: #0000BB">$buff</span><span style="color: #007700">;<br />    else<br />        break; </span><span style="color: #FF8000">//ошибка fread<br /></span><span style="color: #007700">}<br /><br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$stream</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-rarentry.getstream-seealso">
  <h3 class="title">Смотрите также</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="rarentry.extract.php" class="methodname" rel="rdfs-seeAlso">RarEntry::extract()</a> - Извлекает элемент из архива</span></li>
   <li><a href="wrappers.rar.php" class="link">обёртка <code class="literal">rar://</code></a></li>
  </ul>
 </div>


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