<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.phar.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'phar.converttodata.php',
    1 => 'Phar::convertToData',
    2 => 'Конвертирует phar-архив в неисполняемый tar- или zip-файл',
  ),
  'up' => 
  array (
    0 => 'class.phar.php',
    1 => 'Phar',
  ),
  'prev' => 
  array (
    0 => 'phar.construct.php',
    1 => 'Phar::__construct',
  ),
  'next' => 
  array (
    0 => 'phar.converttoexecutable.php',
    1 => 'Phar::convertToExecutable',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/phar/Phar/convertToData.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="phar.converttodata" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Phar::convertToData</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.3.0, PHP 7, PHP 8, PECL phar &gt;= 2.0.0)</p><p class="refpurpose"><span class="refname">Phar::convertToData</span> &mdash; <span class="dc-title">Конвертирует phar-архив в неисполняемый tar- или zip-файл</span></p>

 </div>


 <div class="refsect1 description" id="refsect1-phar.converttodata-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>Phar::convertToData</strong></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.integer.php" class="type int">int</a></span></span> <code class="parameter">$format</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></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.integer.php" class="type int">int</a></span></span> <code class="parameter">$compression</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></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.string.php" class="type string">string</a></span></span> <code class="parameter">$extension</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="class.phardata.php" class="type PharData">PharData</a></span></span></div>


  <p class="para rdfs-comment">
   Этот метод используется для конвертирования phar-архив в tar- или zip-файл.
   Чтобы создать сделать tar или zip неисполняемым, из создаваемого в результате
   конвертации архива удаляются загрузка и псевдоним phar-архива.
  </p>
  <p class="para">
   Если не были указаны никакие изменения, то данный метод выбросит исключение <span class="classname"><a href="class.badmethodcallexception.php" class="classname">BadMethodCallException</a></span>,
   если форматом файла архива является phar. В случае использования с архивами в формате tar или zip,
   данный метод конвертирует архив в неисполняемый архив.
  </p>
  <p class="para">
   В случае успешного выполнения данный метод создаёт на диске новый архив и возвращает объект <span class="classname"><a href="class.phardata.php" class="classname">PharData</a></span>.
   Старый архив не удаляется с диска, это должно быть сделано вручную после завершения процесса.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-phar.converttodata-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">format</code></dt>
     <dd>
      <p class="para">
       Значением этого параметра должна быть одна из констант: <code class="literal">Phar::TAR</code>
       или <code class="literal">Phar::ZIP</code>. Если значение установлено в <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>, то существующий
       формат файла будет сохранён.
      </p>
     </dd>
    
    
     <dt><code class="parameter">compression</code></dt>
     <dd>
      <p class="para">
       Значением этого параметра должна быть одна из констант: <code class="literal">Phar::NONE</code>
       для отсутствия сжатия всего архива, <code class="literal">Phar::GZ</code> для сжатия, основанного
       на zlib, или <code class="literal">Phar::BZ2</code> для bzip-сжатия.
      </p>
     </dd>
    
    
     <dt><code class="parameter">extension</code></dt>
     <dd>
      <p class="para">
       Этот параметр используется для переопределения расширение файла по умолчанию для
       сконвертированного архива. Обратите внимание, что <code class="literal">.phar</code>
       не может быть использовано где-либо в имени файла неисполняемого tar- или
       zip-архива.
      </p>
      <p class="para">
       В случае конвертации phar-архива, основанного на tar, расширениями по умолчанию
       являются: <code class="literal">.tar</code>, <code class="literal">.tar.gz</code> и <code class="literal">.tar.bz2</code>,
       в зависимости от указанного сжатия. Для архивов, основанных на zip, расширением по умолчанию
       является <code class="literal">.zip</code>.
      </p>
     </dd>
    
   </dl>
  </p>

 </div>

 <div class="refsect1 returnvalues" id="refsect1-phar.converttodata-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Данный метод возвращает объект <span class="classname"><a href="class.phardata.php" class="classname">PharData</a></span> в случае успешного выполнения и
   <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> в случае возникновения ошибки.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-phar.converttodata-errors">
  <h3 class="title">Ошибки</h3>
  <p class="para">
   Данный метод выбрасывает исключение <span class="classname"><a href="class.badmethodcallexception.php" class="classname">BadMethodCallException</a></span>
   в следующих случаях: при невозможности сжатия; если был передан неизвестный
   алгоритм сжатия; в запрошенном архиве была включена буферизация с помощью
   <span class="function"><a href="phar.startbuffering.php" class="function">Phar::startBuffering()</a></span> и не была завершена с помощью
   <span class="function"><a href="phar.stopbuffering.php" class="function">Phar::stopBuffering()</a></span>. В случае возникновения каких-либо
   проблем в процессе создания phar будет выброшено исключение <span class="classname"><a href="class.pharexception.php" class="classname">PharException</a></span>.
  </p>
 </div>


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

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">format</code>, <code class="parameter">compression</code> и <code class="parameter">extension</code> теперь допускают значение null.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-phar.converttodata-examples">
  <h3 class="title">Примеры</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Пример #1 Пример использования <span class="function"><strong>Phar::convertToData()</strong></span></strong></p>
    <div class="example-contents"><p>
     Использование Phar::convertToData():
    </p></div>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">try {<br />    </span><span style="color: #0000BB">$tarphar </span><span style="color: #007700">= new </span><span style="color: #0000BB">Phar</span><span style="color: #007700">(</span><span style="color: #DD0000">'myphar.phar.tar'</span><span style="color: #007700">);<br />    </span><span style="color: #FF8000">// обратите внимание, что myphar.phar.tar *не* будет удалён<br />    // конверировать архив в неисполняемый tar-формат<br />    // будет создан myphar.tar<br />    </span><span style="color: #0000BB">$tar </span><span style="color: #007700">= </span><span style="color: #0000BB">$tarphar</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">convertToData</span><span style="color: #007700">();<br />    </span><span style="color: #FF8000">//  конверировать архив в неисполняемый zip-формат файла, будет создан myphar.zip<br />    </span><span style="color: #0000BB">$zip </span><span style="color: #007700">= </span><span style="color: #0000BB">$tarphar</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">convertToData</span><span style="color: #007700">(</span><span style="color: #0000BB">Phar</span><span style="color: #007700">::</span><span style="color: #0000BB">ZIP</span><span style="color: #007700">);<br />    </span><span style="color: #FF8000">// будет создан myphar.tbz<br />    </span><span style="color: #0000BB">$tgz </span><span style="color: #007700">= </span><span style="color: #0000BB">$tarphar</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">convertToData</span><span style="color: #007700">(</span><span style="color: #0000BB">Phar</span><span style="color: #007700">::</span><span style="color: #0000BB">TAR</span><span style="color: #007700">, </span><span style="color: #0000BB">Phar</span><span style="color: #007700">::</span><span style="color: #0000BB">BZ2</span><span style="color: #007700">, </span><span style="color: #DD0000">'.tbz'</span><span style="color: #007700">);<br />    </span><span style="color: #FF8000">// будет создан myphar.phar.tgz<br />    </span><span style="color: #0000BB">$phar </span><span style="color: #007700">= </span><span style="color: #0000BB">$tarphar</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">convertToData</span><span style="color: #007700">(</span><span style="color: #0000BB">Phar</span><span style="color: #007700">::</span><span style="color: #0000BB">PHAR</span><span style="color: #007700">); </span><span style="color: #FF8000">// будет выброшено исключение<br /></span><span style="color: #007700">} catch (</span><span style="color: #0000BB">Exception $e</span><span style="color: #007700">) {<br />    </span><span style="color: #FF8000">// обработка ошибок<br /></span><span style="color: #007700">}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

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


 <div class="refsect1 seealso" id="refsect1-phar.converttodata-seealso">
  <h3 class="title">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="phar.converttoexecutable.php" class="function" rel="rdfs-seeAlso">Phar::convertToExecutable()</a> - Конвертирует phar-архив в другой исполняемый формат файла</span></li>
    <li><span class="function"><a href="phardata.converttoexecutable.php" class="function" rel="rdfs-seeAlso">PharData::convertToExecutable()</a> - Конвертация tar/zip-архива с данными в запускаемый phar-архив</span></li>
    <li><span class="function"><a href="phardata.converttodata.php" class="function" rel="rdfs-seeAlso">PharData::convertToData()</a> - Конвертация phar-архива в незапускаемый tar/zip-архив</span></li>
   </ul>
  </p>
 </div>


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