decompress.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f03806fcd8fe03a0501bd40b6e3939ff6589a1d2 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="phardata.decompress" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>PharData::decompress</refname>
  <refpurpose>Phar アーカイブ全体の圧縮を解除する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="PharData">
   <modifier>public</modifier> <type class="union"><type>PharData</type><type>null</type></type><methodname>PharData::decompress</methodname>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>extension</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>

  <para>
   tar 形式のアーカイブの場合は、
   このメソッドはアーカイブ全体の圧縮を解除します。
  </para>
  <para>
   zip 形式のアーカイブの場合は、このメソッドは失敗して例外が発生します。
   gzip で圧縮されたファイルの圧縮を解除するためには <link linkend="ref.zlib">zlib</link>
   拡張モジュールが、そして bzip2 で圧縮されたファイルの圧縮を解除するためには
   <link linkend="ref.bzip2">bzip2</link> 拡張モジュールが有効になっていなければなりません。
  </para>
  <para>
   さらに、このメソッドは自動的にアーカイブの拡張子を変更し、
   <literal>.tar</literal> をデフォルトで追加します。
   もうひとつの方法として、ファイルの拡張子を
   <parameter>extension</parameter> パラメータで指定することもできます。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>extension</parameter></term>
     <listitem>
      <para>
       圧縮を解除する場合、デフォルトのファイル拡張子は
       <literal>.tar</literal> です。
       このパラメータを使用すると、別の拡張子を指定することができます。
       実行可能なアーカイブのみが、ファイル名に
       <literal>.phar</literal> を含むことができることに注意しましょう。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合に <classname>PharData</classname> オブジェクトを返します。
   失敗した場合は &null; を返します。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <link linkend="ref.zlib">zlib</link>
   拡張モジュールが使用できない場合、あるいは
   <link linkend="ref.bzip2">bzip2</link> 拡張モジュールが使用できない場合に
   <classname>BadMethodCallException</classname> をスローします。
  </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>extension</parameter> は、nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>PharData::decompress</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$p = new PharData('/path/to/my.tar.gz');
$p->decompress(); // これは、/path/to/my.tar を作成します
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>PharFileInfo::getCompressedSize</function></member>
    <member><function>PharFileInfo::isCompressed</function></member>
    <member><function>PharFileInfo::compress</function></member>
    <member><function>PharFileInfo::decompress</function></member>
    <member><function>PharData::compress</function></member>
    <member><function>Phar::canCompress</function></member>
    <member><function>Phar::isCompressed</function></member>
    <member><function>PharData::compress</function></member>
    <member><function>Phar::getSupportedCompression</function></member>
    <member><function>PharData::compressFiles</function></member>
    <member><function>PharData::decompressFiles</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
-->