<?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.extract.php',
    1 => 'RarEntry::extract',
    2 => 'Извлекает элемент из архива',
  ),
  'up' => 
  array (
    0 => 'class.rarentry.php',
    1 => 'RarEntry',
  ),
  'prev' => 
  array (
    0 => 'class.rarentry.php',
    1 => 'RarEntry',
  ),
  'next' => 
  array (
    0 => 'rarentry.getattr.php',
    1 => 'RarEntry::getAttr',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/rar/rarentry/extract.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="rarentry.extract" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">RarEntry::extract</h1>
  <p class="verinfo">(PECL rar &gt;= 0.1)</p><p class="refpurpose"><span class="refname">RarEntry::extract</span> &mdash; <span class="dc-title">Извлекает элемент из архива</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-rarentry.extract-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>RarEntry::extract</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">$dir</code></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">$filepath</code><span class="initializer"> = &quot;&quot;</span></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">$password</code><span class="initializer"> = NULL</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$extended_data</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span><br>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   <span class="methodname"><strong>RarEntry::extract()</strong></span> извлекает содержимое элемента.
   При этом создаётся новый файл в указанной директории
   <code class="parameter">dir</code> с именем совпадающим с именем элемента,
   если только не задан второй аргумент. Смотрите подробнее ниже.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-rarentry.extract-parameters">
  <h3 class="title">Список параметров</h3>
  <dl>
   
    <dt><code class="parameter">dir</code></dt>
    <dd>
     <span class="simpara">
      Путь к директории, куда необходимо извлечь файлы. Этот
      параметр учитывается только если не указан параметр
      <code class="parameter">filepath</code>. Если оба параметра не указаны,
      то файлы извлекаются в текущую директорию.
     </span>
    </dd>
   

   
    <dt><code class="parameter">filepath</code></dt>
    <dd>
     <span class="simpara">
      Путь (полный или относительный) содержит директорию
      и имя извлекаемого файла. Этот параметр переопределяет
      и параметр <code class="parameter">dir</code> и оригинальное имя файла.
     </span>
    </dd>
   

   
    <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>, то проверка CRC будет неудачной
      и будет возвращён <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>
   

   
    <dt><code class="parameter">extended_data</code></dt>
    <dd>
     <span class="simpara">
      Если <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>, то в извлекаемый файл будет добавлена
      дополнительная информация, такая как NTFS ACL и владелец в
      системе Unix, если они присутствовали в архиве.
     </span>
    </dd>
   
  </dl>
  <div class="warning"><strong class="warning">Внимание</strong>
   <p class="simpara">
    До версии 2.0.0, не обрабатывала относительные пути корректно. Используйте для этой ситуации <span class="function"><a href="function.realpath.php" class="function">realpath()</a></span>.
   </p>
  </div>
 </div>


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


 <div class="refsect1 changelog" id="refsect1-rarentry.extract-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>
       Был добавлен параметр <code class="parameter">extended_data</code>.
      </td>
     </tr>

     <tr>
      <td>PECL rar 3.0.0</td>
      <td>
       Исправлена поддержка RAR архивов с повторяющимися именами
       элементов.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-rarentry.extract-examples">
  <h3 class="title">Примеры</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Пример #1 Пример использования <span class="methodname"><strong>RarEntry::extract()</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">) or 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">) or die(</span><span style="color: #DD0000">"Не удалось найти такую запись"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$entry</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">extract</span><span style="color: #007700">(</span><span style="color: #DD0000">'/dir/to'</span><span style="color: #007700">); </span><span style="color: #FF8000">// создание /dir/to/Dir/file.txt<br /></span><span style="color: #0000BB">$entry</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">extract</span><span style="color: #007700">(</span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #DD0000">'/dir/to/new_name.txt'</span><span style="color: #007700">); </span><span style="color: #FF8000">// создание /dir/to/new_name.txt<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
   <div class="example" id="example-2">
    <p><strong>Пример #2 Как извлечь все файлы из архива: </strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">/* Пример от Erik Jenssen aka erix */<br /><br /></span><span style="color: #0000BB">$filename </span><span style="color: #007700">= </span><span style="color: #DD0000">"foobar.rar"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$filepath </span><span style="color: #007700">= </span><span style="color: #DD0000">"/home/foo/bar/"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$rar_file </span><span style="color: #007700">= </span><span style="color: #0000BB">rar_open</span><span style="color: #007700">(</span><span style="color: #0000BB">$filepath</span><span style="color: #007700">.</span><span style="color: #0000BB">$filename</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$list </span><span style="color: #007700">= </span><span style="color: #0000BB">rar_list</span><span style="color: #007700">(</span><span style="color: #0000BB">$rar_file</span><span style="color: #007700">);<br />foreach(</span><span style="color: #0000BB">$list </span><span style="color: #007700">as </span><span style="color: #0000BB">$file</span><span style="color: #007700">) {<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: #0000BB">$file</span><span style="color: #007700">);<br />    </span><span style="color: #0000BB">$entry</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">extract</span><span style="color: #007700">(</span><span style="color: #DD0000">"."</span><span style="color: #007700">); </span><span style="color: #FF8000">// извлечь в текущий каталог<br /></span><span style="color: #007700">}<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">);<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-rarentry.extract-seealso">
  <h3 class="title">Смотрите также</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="rarentry.getstream.php" class="methodname" rel="rdfs-seeAlso">RarEntry::getStream()</a> - Получить обработчик для записи</span></li>
   <li><a href="wrappers.rar.php" class="link"><code class="literal">rar://</code> wrapper</a></li>
  </ul>
 </div>


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