mirror of
https://github.com/php/doc-en.git
synced 2026-03-24 15:52:15 +01:00
add zipArchive::setArchiveFlag() and zipArchive::getArchiveFlag() methods
This commit is contained in:
Remi Collet
@@ -107,7 +107,7 @@
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="ziparchive.constants.afl-create-ro-keep-file-for-empty-archive">
|
||||
<varlistentry xml:id="ziparchive.constants.afl-create-or-keep-file-for-empty-archive">
|
||||
<term>
|
||||
<constant>ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</constant>
|
||||
</term>
|
||||
|
||||
@@ -18,6 +18,7 @@
|
||||
<function name="ZipArchive::deleteName" from="PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.5.0"/>
|
||||
<function name="ZipArchive::extractTo" from="PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.1.0"/>
|
||||
<function name="ZipArchive::getArchiveComment" from="PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.1.0"/>
|
||||
<function name="ZipArchive::getArchiveFlag" from="PHP >= 8.3.0, PECL zip >= 1.22.0"/>
|
||||
<function name="ZipArchive::getCommentIndex" from="PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.4.0"/>
|
||||
<function name="ZipArchive::getCommentName" from="PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.4.0"/>
|
||||
<function name="ZipArchive::getExternalAttributesIndex" from="PHP 5 >= 5.6.0, PHP 7, PHP 8, PECL zip >= 1.12.4"/>
|
||||
@@ -40,6 +41,7 @@
|
||||
<function name="ZipArchive::registerProgressCallback" from="PHP >= 8.0.0, PECL zip >= 1.17.0"/>
|
||||
<function name="ZipArchive::registerCancelCallback" from="PHP >= 8.0.0, PECL zip >= 1.17.0"/>
|
||||
<function name="ZipArchive::setArchiveComment" from="PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.4.0"/>
|
||||
<function name="ZipArchive::setArchiveFlag" from="PHP >= 8.3.0, PECL zip >= 1.22.0"/>
|
||||
<function name="ZipArchive::setCommentIndex" from="PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.4.0"/>
|
||||
<function name="ZipArchive::setCommentName" from="PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.4.0"/>
|
||||
<function name="ZipArchive::setCompressionIndex" from="PHP 7, PHP 8, PECL zip >= 1.13.0"/>
|
||||
|
||||
@@ -16,8 +16,10 @@
|
||||
automatically called at the end of the script.
|
||||
</para>
|
||||
<para>
|
||||
If the archive contains no files, the file is completely removed
|
||||
(no empty archive is written).
|
||||
If the archive contains no files, the file is completely removed by default
|
||||
(no empty archive is written) according to the value of the
|
||||
<constant><link linkend="ziparchive.constants.afl-create-or-keep-file-for-empty-archive">ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</link></constant>
|
||||
global flag.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
@@ -32,6 +34,15 @@
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><methodname>ZipArchive::setArchiveFlag</methodname></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
|
||||
122
reference/zip/ziparchive/getarchiveflag.xml
Normal file
122
reference/zip/ziparchive/getarchiveflag.xml
Normal file
@@ -0,0 +1,122 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<refentry xml:id="ziparchive.getarchiveflag" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>ZipArchive::getArchiveFlag</refname>
|
||||
<refpurpose>Returns the value of a Zip archive global flag</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="ZipArchive">
|
||||
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>ZipArchive::getArchiveFlag</methodname>
|
||||
<methodparam><type>int</type><parameter>flag</parameter><initializer>0</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Returns a Zip archive global flag value.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>flag</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The global flag to retrieve, among <literal>AFL_*</literal> constants:
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
<constant><link linkend="ziparchive.constants.afl-rdonly">ZipArchive::AFL_RDONLY</link></constant>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<constant><link linkend="ziparchive.constants.afl-is-torrentzip">ZipArchive::AFL_IS_TORRENTZIP</link></constant>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<constant><link linkend="ziparchive.constants.afl-want-torrentzip">ZipArchive::AFL_WANT_TORRENTZIP</link></constant>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<constant><link linkend="ziparchive.constants.afl-create-or-keep-file-for-empty-archive">ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</link></constant>
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>flags</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
If flags is set to <constant>ZipArchive::FL_UNCHANGED</constant>, the original unchanged
|
||||
flag is returned.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns 1 if flag is set for archive, 0 if not, and -1 if an error occurred.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example>
|
||||
<title>Test if archive is a torrentzip format</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$zip = new ZipArchive;
|
||||
$res = $zip->open('test.zip');
|
||||
if ($res === TRUE) {
|
||||
var_dump($zip->getArchiveFlag(ZipArchive::AFL_IS_TORRENTZIP));
|
||||
} else {
|
||||
echo 'failed, code:' . $res;
|
||||
}
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><methodname>ZipArchive::setArchiveFlag</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
|
||||
-->
|
||||
113
reference/zip/ziparchive/setarchiveflag.xml
Normal file
113
reference/zip/ziparchive/setarchiveflag.xml
Normal file
@@ -0,0 +1,113 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<refentry xml:id="ziparchive.setarchiveflag" xmlns="http://docbook.org/ns/docbook">
|
||||
<refnamediv>
|
||||
<refname>ZipArchive::setArchiveFlag</refname>
|
||||
<refpurpose>Set a global flag of a ZIP archive</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis role="ZipArchive">
|
||||
<modifier>public</modifier> <type>bool</type><methodname>ZipArchive::setArchiveFlag</methodname>
|
||||
<methodparam><type>int</type><parameter>flag</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>value</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Set a global flag of a ZIP archive.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>flag</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The global flag to change, among <literal>AFL_*</literal> constants.
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
<constant><link linkend="ziparchive.constants.afl-want-torrentzip">ZipArchive::AFL_WANT_TORRENTZIP</link></constant>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<constant><link linkend="ziparchive.constants.afl-create-or-keep-file-for-empty-archive">ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</link></constant>
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>value</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The new value of the flag.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example>
|
||||
<title>Create a torrentzip archive</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$zip = new ZipArchive;
|
||||
$res = $zip->open('test.zip', ZipArchive::CREATE);
|
||||
if ($res === TRUE) {
|
||||
$zip->setArchiveFlag(ZipArchive::AFL_WANT_TORRENTZIP, 1);
|
||||
$zip->addFromString('test.txt', 'file content goes here');
|
||||
$zip->close();
|
||||
echo 'ok';
|
||||
} else {
|
||||
echo 'failed';
|
||||
}
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><methodname>ZipArchive::getArchiveFlag</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
|
||||
-->
|
||||
Reference in New Issue
Block a user