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

contributors($setup);

?>
<div id="phardata.converttoexecutable" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">PharData::convertToExecutable</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">PharData::convertToExecutable</span> &mdash; <span class="dc-title">Конвертация tar/zip-архива с данными в запускаемый phar-архив</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-phardata.converttoexecutable-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>PharData::convertToExecutable</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.phar.php" class="type Phar">Phar</a></span></span></div>

  <blockquote class="note"><p><strong class="note">Замечание</strong>: <p class="para">Для корректной работы с объектами <span class="classname"><a href="class.phar.php" class="classname">Phar</a></span>
этому методу необходима установка значения <var class="filename">php.ini</var> <code class="literal">phar.readonly</code> в <code class="literal">0</code>.
В противном случае, будет выброшено исключение <span class="classname"><a href="class.pharexception.php" class="classname">PharException</a></span>.</p></p></blockquote>
  <p class="para">
   Этот метод используется для конвертации незапускаемого tar/zip-архива а
   запускаемый phar-архив. Может быть использован любой из трёх запускаемых форматов
   (phar, tar или zip). Также допустимо сжатие архива целиком.
  </p>
  <p class="para">
   Если изменения не указаны, этот метод бросает исключение <span class="classname"><a href="class.badmethodcallexception.php" class="classname">BadMethodCallException</a></span>.
  </p>
  <p class="para">
   В случае успешного выполнения, этот метод создаёт новый архив на диске и возвращает объект
   <span class="classname"><a href="class.phar.php" class="classname">Phar</a></span>. Старый архив остаётся нетронутым.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-phardata.converttoexecutable-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">format</code></dt>
     <dd>
      <p class="para">
       Одна из констант: <code class="literal">Phar::PHAR</code>, <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">
       Этот параметр используется для явного задания расширения для нового архива.
       Обратите внимание, что для того, чтобы обрабатываться как phar-архив,
       файлы должны в своём расширении иметь <code class="literal">.phar</code>.
      </p>
      <p class="para">
       При конвертации в phar-архива, расширение по умолчанию
       <code class="literal">.phar</code>, <code class="literal">.phar.gz</code> или <code class="literal">.phar.bz2</code>,
       в зависимости от заданного типа сжатия. Для tar-архивов, расширение по умолчанию
       <code class="literal">.phar.tar</code>, <code class="literal">.phar.tar.gz</code>,
       и <code class="literal">.phar.tar.bz2</code>.  Для zip-архивов расширение по умолчанию
       <code class="literal">.phar.zip</code>.
      </p>
     </dd>
    
   </dl>
  </p>

 </div>

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


 <div class="refsect1 errors" id="refsect1-phardata.converttoexecutable-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> не вызывался. Выбрасывается исключение
   <span class="classname"><a href="class.unexpectedvalueexception.php" class="classname">UnexpectedValueException</a></span>, если запись запрещена.
   И выбрасывается <span class="classname"><a href="class.pharexception.php" class="classname">PharException</a></span>, если возникли проблемы записи
   на диск.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-phardata.converttoexecutable-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">localName</code> теперь допускают значение null.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-phardata.converttoexecutable-examples">
  <h3 class="title">Примеры</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Пример #1 Пример использования <span class="function"><strong>PharData::convertToExecutable()</strong></span></strong></p>
    <div class="example-contents"><p>
     Используем PharData::convertToExecutable():
    </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">PharData</span><span style="color: #007700">(</span><span style="color: #DD0000">'myphar.tar'</span><span style="color: #007700">);<br />    </span><span style="color: #FF8000">// конвертируем в формат phar<br />    // обратите внимание, что myphar.tar *не* удаляется<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">convertToExecutable</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">// creates myphar.phar<br />    </span><span style="color: #0000BB">$phar</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setStub</span><span style="color: #007700">(</span><span style="color: #0000BB">$phar</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">createDefaultStub</span><span style="color: #007700">(</span><span style="color: #DD0000">'cli.php'</span><span style="color: #007700">, </span><span style="color: #DD0000">'web/index.php'</span><span style="color: #007700">));<br />    </span><span style="color: #FF8000">// создаём myphar.phar.tgz<br />    </span><span style="color: #0000BB">$compressed </span><span style="color: #007700">= </span><span style="color: #0000BB">$tarphar</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">convertToExecutable</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">GZ</span><span style="color: #007700">, </span><span style="color: #DD0000">'.phar.tgz'</span><span style="color: #007700">);<br />} 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-phardata.converttoexecutable-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="phar.converttodata.php" class="function" rel="rdfs-seeAlso">Phar::convertToData()</a> - Конвертирует phar-архив в неисполняемый tar- или zip-файл</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); ?>