archived-doc-ru/reference/phar/PharData/decompress.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: f03806fcd8fe03a0501bd40b6e3939ff6589a1d2 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<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>
   Выбрасывает исключение <classname>BadMethodCallException</classname>, если
   отсутствует модуль, необходимый для распаковки: <link linkend="ref.zlib">zlib</link>
   или <link linkend="ref.bzip2">bzip2</link>.
  </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> теперь допускает значение null.
      </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(); // creates /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
-->