new method in zip 1.19.0

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350010 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Remi Collet 2020-06-05 15:22:10 +00:00
parent 0536573944
commit e80d8de42c
3 changed files with 188 additions and 0 deletions

View file

@ -27,6 +27,8 @@
<function name="ZipArchive::getNameIndex" from="PHP 5 &gt;= 5.2.0, PHP 7, PECL zip &gt;= 1.5.0"/>
<function name="ZipArchive::getStream" from="PHP 5 &gt;= 5.2.0, PHP 7, PECL zip &gt;= 1.1.0"/>
<function name="ZipArchive::getStatusString" from="PHP 5 &gt;= 5.2.7, PHP 7"/>
<function name="ZipArchive::isCompressionMethodSupported" from="PHP &gt;= 8.0.0, PECL zip &gt;= 1.19.0"/>
<function name="ZipArchive::isEncryptionMethodSupported" from="PHP &gt;= 8.0.0, PECL zip &gt;= 1.19.0"/>
<function name="ZipArchive::locateName" from="PHP 5 &gt;= 5.2.0, PHP 7, PECL zip &gt;= 1.5.0"/>
<function name="ZipArchive::open" from="PHP 5 &gt;= 5.2.0, PHP 7, PECL zip &gt;= 1.1.0"/>
<function name="ZipArchive::rename" from="PHP 5 &gt;= 5.2.0, PHP 7, PECL zip &lt; 1.5.0"/>

View file

@ -0,0 +1,93 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 349314 $ -->
<refentry xml:id="ziparchive.iscompressionmethoddupported" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ZipArchive::isCompressionMethodSupported</refname>
<refpurpose>Check if a compression method is supported by libzip</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ZipArchive::isCompressionMethodSupported</methodname>
<methodparam><type>int</type><parameter>method</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>encode</parameter><initializer>true</initializer></methodparam>
</methodsynopsis>
<para>
Check if a compression method is supported by libzip.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>method</parameter></term>
<listitem>
<para>
The compression method, one of the
<constant>ZipArchive::CM_*</constant> constants.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encode</parameter></term>
<listitem>
<para>
If &true; check for compression, else check for decompression.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function is only available if built against libzip ≥ 1.7.0.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>ZipArchive::setCompressionIndex</methodname></member>
<member><methodname>ZipArchive::setCompressionName</methodname></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
-->

View file

@ -0,0 +1,93 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 349314 $ -->
<refentry xml:id="ziparchive.isencryptionmethoddupported" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ZipArchive::isEncryptionMethodSupported</refname>
<refpurpose>Check if a encryption method is supported by libzip</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ZipArchive::isEncryptionMethodSupported</methodname>
<methodparam><type>int</type><parameter>method</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>encode</parameter><initializer>true</initializer></methodparam>
</methodsynopsis>
<para>
Check if a compression method is supported by libzip.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>method</parameter></term>
<listitem>
<para>
The encryption method, one of the
<constant>ZipArchive::EM_*</constant> constants.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encode</parameter></term>
<listitem>
<para>
If &true; check for encryption, else check for decryption.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function is only available if built against libzip ≥ 1.7.0.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>ZipArchive::setEncryptionIndex</methodname></member>
<member><methodname>ZipArchive::setEncryptionName</methodname></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
-->