1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
<?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>int</type><methodname>ZipArchive::getArchiveFlag</methodname>
<methodparam><type>int</type><parameter>flag</parameter></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>ZipArchive::AFL_RDONLY</constant>
</para>
</listitem>
<listitem>
<para>
<constant>ZipArchive::AFL_IS_TORRENTZIP</constant>
</para>
</listitem>
<listitem>
<para>
<constant>ZipArchive::AFL_WANT_TORRENTZIP</constant>
</para>
</listitem>
<listitem>
<para>
<constant>ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</constant>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
If <parameter>flags</parameter> 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
-->
|
