archived-doc-en/reference/phar/PharData/convertToExecutable.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="phardata.converttoexecutable" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>PharData::convertToExecutable</refname>
  <refpurpose>Convert a non-executable tar/zip archive to an executable phar archive</refpurpose>
 </refnamediv>


 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="PharData">
   <modifier>public</modifier> <type class="union"><type>Phar</type><type>null</type></type><methodname>PharData::convertToExecutable</methodname>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>format</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>compression</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>extension</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  &phar.write;
  <para>
   This method is used to convert a non-executable tar or zip archive to an
   executable phar archive.  Any of the three executable file formats
   (phar, tar or zip) can be used, and whole-archive compression can also be performed.
  </para>
  <para>
   If no changes are specified, this method throws a <classname>BadMethodCallException</classname>.
  </para>
  <para>
   If successful, the method creates a new archive on disk and returns a <classname>Phar</classname>
   object.  The old archive is not removed from disk, and should be done manually after
   the process has finished.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>format</parameter></term>
     <listitem>
      <para>
       This should be one of <literal>Phar::PHAR</literal>, <literal>Phar::TAR</literal>,
       or <literal>Phar::ZIP</literal>.  If set to &null;, the existing file format
       will be preserved.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>compression</parameter></term>
     <listitem>
      <para>
       This should be one of <literal>Phar::NONE</literal> for no whole-archive
       compression, <literal>Phar::GZ</literal> for zlib-based compression, and
       <literal>Phar::BZ2</literal> for bzip-based compression.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>extension</parameter></term>
     <listitem>
      <para>
       This parameter is used to override the default file extension for a
       converted archive.  Note that all zip- and tar-based phar archives must contain
       <literal>.phar</literal> in their file extension in order to be processed as a
       phar archive.
      </para>
      <para>
       If converting to a phar-based archive, the default extensions are
       <literal>.phar</literal>, <literal>.phar.gz</literal>, or <literal>.phar.bz2</literal>
       depending on the specified compression.  For tar-based phar archives, the
       default extensions are <literal>.phar.tar</literal>, <literal>.phar.tar.gz</literal>,
       and <literal>.phar.tar.bz2</literal>.  For zip-based phar archives, the
       default extension is <literal>.phar.zip</literal>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>

 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The method returns a <classname>Phar</classname> object on success,
   or &null; on failure.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   This method throws <classname>BadMethodCallException</classname> when unable
   to compress, an unknown compression method has been specified, the requested
   archive is buffering with <function>Phar::startBuffering</function> and
   has not concluded with <function>Phar::stopBuffering</function>, an
   <classname>UnexpectedValueException</classname> if write support is disabled,
   and a <classname>PharException</classname> if any problems are encountered
   during the phar creation process.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>format</parameter>, <parameter>compression</parameter>, and <parameter>localName</parameter> are now nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>PharData::convertToExecutable</function> example</title>
    <para>
     Using PharData::convertToExecutable():
    </para>
    <programlisting role="php">
<![CDATA[
<?php
try {
    $tarphar = new PharData('myphar.tar');
    // convert it to the phar file format
    // note that myphar.tar is *not* unlinked
    $phar = $tarphar->convertToExecutable(Phar::PHAR); // creates myphar.phar
    $phar->setStub($phar->createDefaultStub('cli.php', 'web/index.php'));
    // creates myphar.phar.tgz
    $compressed = $tarphar->convertToExecutable(Phar::TAR, Phar::GZ, '.phar.tgz');
} catch (Exception $e) {
    // handle the error here
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>Phar::convertToExecutable</function></member>
    <member><function>Phar::convertToData</function></member>
    <member><function>PharData::convertToData</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->