Files
php-doc-ru/reference/phar/Phar/compressAllFilesGZ.xml

150 lines
5.4 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 656d1610af1a960d87c8b7056e54d0d4c75fb123 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="phar.compressallfilesgz">
<refnamediv>
<refname>Phar::compressAllFilesGZ</refname>
<refpurpose>Сжимает все файлы в текущем Phar-архиве с помощью Gzip-сжатия</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Phar::compressAllFilesGZ</methodname>
<void/>
</methodsynopsis>
&phar.removed.pharcompress;
&phar.write;
<para>
В случае использования с phar-архивами, основанными на tar, этот метод сжимает весь архив целиком
с помощью gzip-сжатия. Полученный файл может быть обработан с помощью команды
gunzip; к нему также можно получить прямой доступ, используя модуль Phar.
</para>
<para>
В случае использования с phar-архивами, основанными на zip или phar, этот метод сжимает все файлы в Phar-архиве
используя gzip-сжатие. Для возможности воспользоваться этой функцией должен быть включен
модуль <link linkend="ref.zlib">zlib</link>. Кроме того, если какие-либо
файлы в архиве уже сжаты с использованием bzip2-сжатия, то для их распаковки
перед повторным gzip-сжатием должен быть включен модуль <link linkend="ref.bzip2">bzip2</link>.
Как и в случае с другим функционалом, модифицирующим содержание
phar-архива, для успешной работы данного метода необходимо, чтобы INI-переменная
<link linkend="ini.phar.readonly">phar.readonly</link> была отключена.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Бросает исключение <classname>BadMethodCallException</classname>,
если INI-переменная <link linkend="ini.phar.readonly">phar.readonly</link>
включена, модуль <link linkend="ref.zlib">zlib</link> не доступен или
если какие-либо файлы внутри архива были сжаты с использованием bzip2-сжатия
и модуль <link linkend="ref.bzip2">bzip2</link> не включен.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>Phar::compressAllFilesGZ</function></title>
<programlisting role="php">
<![CDATA[
<?php
$p = new Phar('/путь/к/my.phar', 0, 'my.phar');
$p['myfile.txt'] = 'привет';
$p['myfile2.txt'] = 'привет';
foreach ($p as $file) {
var_dump($file->getFileName());
var_dump($file->isCompressed());
var_dump($file->isCompressedBZIP2());
var_dump($file->isCompressedGZ());
}
$p->compressAllFilesGZ();
foreach ($p as $file) {
var_dump($file->getFileName());
var_dump($file->isCompressed());
var_dump($file->isCompressedBZIP2());
var_dump($file->isCompressedGZ());
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
string(10) "myfile.txt"
bool(false)
bool(false)
bool(false)
string(11) "myfile2.txt"
bool(false)
bool(false)
bool(false)
string(10) "myfile.txt"
bool(true)
bool(false)
bool(true)
string(11) "myfile2.txt"
bool(true)
bool(false)
bool(true)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>PharFileInfo::getCompressedSize</function></member>
<member><function>PharFileInfo::isCompressedBZIP2</function></member>
<member><function>PharFileInfo::isCompressed</function></member>
<member><function>PharFileInfo::isCompressedGZ</function></member>
<member><function>PharFileInfo::setCompressedBZIP2</function></member>
<member><function>PharFileInfo::setUncompressed</function></member>
<member><function>PharFileInfo::setCompressedGZ</function></member>
<member><function>Phar::canCompress</function></member>
<member><function>Phar::isCompressed</function></member>
<member><function>Phar::compressAllFilesBZIP2</function></member>
<member><function>Phar::getSupportedCompression</function></member>
<member><function>Phar::uncompressAllFiles</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
-->