mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
418948d0d7
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337775 c90b9560-bf6c-de11-be94-00142212c4b1
105 lines
2.8 KiB
XML
105 lines
2.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="ziparchive.setcompressionindex" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ZipArchive::setCompressionIndex</refname>
|
|
<refpurpose>Set the compression method of an entry defined by its index</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ZipArchive::setCompressionIndex</methodname>
|
|
<methodparam><type>int</type><parameter>index</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>comp_method</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>comp_flags</parameter><initializer>0</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Set the compression method of an entry defined by its index.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>index</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Index of the entry.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>comp_method</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The compression method. Either
|
|
<constant>ZipArchive::CM_DEFAULT</constant>,
|
|
<constant>ZipArchive::CM_STORE</constant> or
|
|
<constant>ZipArchive::CM_DEFLATE</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>comp_flags</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Compression flags. Currently unused.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title>Add files with different compression methods to an archive</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$zip = new ZipArchive;
|
|
$res = $zip->open('test.zip', ZipArchive::CREATE);
|
|
if ($res === TRUE) {
|
|
$zip->addFromString('foo', 'Some text');
|
|
$zip->addFromString('bar', 'Some other text');
|
|
$zip->setCompressionIndex(0, ZipArchive::CM_STORE);
|
|
$zip->setCompressionIndex(1, ZipArchive::CM_DEFLATE);
|
|
$zip->close();
|
|
echo 'ok';
|
|
} else {
|
|
echo 'failed';
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</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
|
|
-->
|