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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ziparchive.addfile" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ZipArchive::addFile</refname>
<refpurpose>Adds a file to a ZIP archive from the given path</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="ZipArchive">
<modifier>public</modifier> <type>bool</type><methodname>ZipArchive::addFile</methodname>
<methodparam><type>string</type><parameter>filepath</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>entryname</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>start</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>ZipArchive::LENGTH_TO_END</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>ZipArchive::FL_OVERWRITE</initializer></methodparam>
</methodsynopsis>
<para>
Adds a file to a ZIP archive from a given path.
</para>
&zip.filename.separator;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filepath</parameter></term>
<listitem>
<para>
The path to the file to add.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>entryname</parameter></term>
<listitem>
<para>
If supplied and not empty, this is the local name inside the ZIP archive that will override the <parameter>filepath</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>start</parameter></term>
<listitem>
<para>
For partial copy, start position.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
For partial copy, length to be copied,
if <constant>ZipArchive::LENGTH_TO_END</constant> (0) the file size is used,
if <constant>ZipArchive::LENGTH_UNCHECKED</constant> the whole file is used
(starting from <parameter>start</parameter>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Bitmask consisting of
<constant>ZipArchive::FL_OVERWRITE</constant>,
<constant>ZipArchive::FL_ENC_GUESS</constant>,
<constant>ZipArchive::FL_ENC_UTF_8</constant>,
<constant>ZipArchive::FL_ENC_CP437</constant>,
<constant>ZipArchive::FL_OPEN_FILE_NOW</constant>.
The behaviour of these constants is described on the
<link linkend="zip.constants">ZIP constants</link> page.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0, PECL zip 1.18.0</entry>
<entry>
<parameter>flags</parameter> was added.
</entry>
</row>
<row>
<entry>8.3.0, PECL zip 1.22.1</entry>
<entry>
<constant>ZipArchive::FL_OPEN_FILE_NOW</constant> was added.
</entry>
</row>
<row>
<entry>8.3.0, PECL zip 1.22.2</entry>
<entry>
<constant>ZipArchive::LENGTH_TO_END</constant> and <constant>ZipArchive::LENGTH_UNCHECKED</constant> were added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
This example opens a ZIP file archive
<filename>test.zip</filename> and add
the file <filename>/path/to/index.txt</filename>.
as <filename>newname.txt</filename>.
</para>
<example>
<title>Open and add</title>
<programlisting role="php">
<![CDATA[
<?php
$zip = new ZipArchive;
if ($zip->open('test.zip') === TRUE) {
$zip->addFile('/path/to/index.txt', 'newname.txt');
$zip->close();
echo 'ok';
} else {
echo 'failed';
}
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
When a file is set to be added to the archive, PHP will lock the file. The
lock is only released once the <classname>ZipArchive</classname> object
has been closed, either via <methodname>ZipArchive::close</methodname> or
the <classname>ZipArchive</classname> object being destroyed. This may
prevent you from being able to delete the file being added until after the
lock has been released.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>ZipArchive::replaceFile</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
-->
|
