File: zip.xml

package info (click to toggle)
phpdoc 20020310-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 35,272 kB
  • ctags: 354
  • sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (417 lines) | stat: -rwxr-xr-x 13,969 bytes parent folder | download
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- EN-Revision: 1.17 Maintainer: stefan_saasen Status: ready -->
<reference id="ref.zip">
 <title>ZIP Funktionen (Lesezugriff)</title>
 <titleabbrev>Zip</titleabbrev>
  
  <partintro>
   <para>
    Dieses Modul benutzt die Funktionen der <ulink
    url="&url.zziplib;">ZZIPlib</ulink> Bibliothek von Guido Draheim
    um ZIP komprimierte Archive und die darin enthaltenen Dateien zu
    lesen.
   </para>
   <para>
    Zu beachten ist, dass ZZIPlib nur eine Untermenge der Funktionen
    zur Verfgung stellt, die in einer vollstndigen Implementation
    des ZIP Algorithmus vorhanden sind.  Zur Erstellung eines ZIP
    Archivs muss man sich eines der blichen ZIP Programme bedienen.
   </para>
   <para>
   Die ZIP Untersttzung ist standardmig nicht aktiviert.  Um die
   ZIP Funktionen nutzen zu knnen, muss PHP mit der option <link
   linkend="install.configure.with-zip">--with-zip</link> kompiliert
   werden.  Das ZIP Modul bentigt ZZIPlib version &gt;= 0.10.6.
   </para>
   <note>
    <para>
     Zip Untersttzung fr PHP vor Version 4.1.0 ist als experimentell
     anzusehen.  Dieser Abschnitt beschreibt die ZIP Untersttzung,
     wie sie fr PHP ab Version 4.1.0 existiert.
    </para>
   </note>

   <sect1 id="zip-example">
    <title>Beispiel zur Verwendung</title>
    <para>
     Dieses Beispiel ffnet ein ein ZIP Archiv, liest jede Datei
     innerhalb des Archivs und gibt den Inhalt zurck. Das
     <filename>test2.zip</filename> Archiv, das in diesem Beispiel
     benutzt wird, wird mit der Original Distribution der ZZIPlib
     Bibliothek mitgeliefert.
    </para>
    <example>
     <title>Beispiel zur Verwendung der Zip Funktion</title>
     <programlisting role="php">
<![CDATA[      
<?php

$zip = zip_open("/tmp/test2.zip");

if ($zip) {

    while ($zip_entry = zip_read($zip)) {
        echo "Name:               " . zip_entry_name($zip_entry) . "\n";
        echo "Actual Filesize:    " . zip_entry_filesize($zip_entry) . "\n";
        echo "Compressed Size:    " . zip_entry_compressedsize($zip_entry) . "\n";
        echo "Compression Method: " . zip_entry_compressionmethod($zip_entry) . "\n";

        if (zip_entry_open($zip, $zip_entry, "r")) {
            echo "File Contents:\n";
            $buf = zip_entry_read($zip_entry, zip_entry_filesize($zip_entry));
            echo "$buf\n";

            zip_entry_close($zip_entry);
        }
        echo "\n";

    }

    zip_close($zip);

}

?>
]]>
     </programlisting>
    </example>
   </sect1>
  </partintro>

  <refentry id="function.zip-open">
   <refnamediv>
    <refname>zip_open</refname>
    <refpurpose>ffnet ein ZIP Archiv</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>resource</type><methodname>zip_open</methodname>
      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion ffnet ein ZIP Archiv fr den Lesezugriff.  Der
     Parameter <parameter>filename</parameter> ist der Name der zu
     ffnenden ZIP Datei.
    </para>
    <para>
     Gibt einen Dateizeiger zurck, der in den Funktionen
     <function>zip_read</function> und <function>zip_close</function>
     benutzt wird.  Existiert die Datei
     <parameter>filename</parameter> nicht wird &false; zurckgegeben.
    </para>
    <para>
     Siehe auch <function>zip_read</function> und
     <function>zip_close</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.zip-read">
   <refnamediv>
    <refname>zip_read</refname>
    <refpurpose>
     Liest den nchsten Eintrag innerhalb des ZIP Archivs
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>resource</type><methodname>zip_read</methodname>
      <methodparam><type>resource</type><parameter>zip</parameter></methodparam>
     </methodsynopsis>
    <para>
     Liest den nchsten Eintrag innerhalb des ZIP Archivs.  Der
     Parameter <parameter>zip</parameter> muss ein Dateizeiger sein,
     der vorher durch <function>zip_open</function> zurckgegeben
     wurde.
    </para>
    <para>
     Gibt einen Verzeichniseintrag zur spteren Benutzung mit den
     <function>zip_entry_...</function> Funktionen zurck.
    </para>
    <para>
     Siehe auch <function>zip_open</function>,
     <function>zip_close</function>,
     <function>zip_entry_open</function> und
     <function>zip_entry_read</function>.
    </para>
   </refsect1>
  </refentry>
 
  <refentry id="function.zip-close">
   <refnamediv>
    <refname>zip_close</refname>
    <refpurpose>Schliet ein ZIP Archiv</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>void</type><methodname>zip_close</methodname>
     <methodparam><type>resource</type><parameter>zip</parameter></methodparam>
     </methodsynopsis>
    <para>
     Schliet ein ZIP Archiv.  Der Parameter
     <parameter>zip</parameter> muss ein Dateizeiger sein, der vorher
     durch <function>zip_open</function> zurckgegeben wurde.
    </para>
    <para>
     Diese Funktion hat keinen Rckgabewert.
    </para>
    <para>
     Siehe auch <function>zip_open</function> und
     <function>zip_read</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.zip-entry-close">
   <refnamediv>
    <refname>zip_entry_close</refname>
    <refpurpose>Schliet einen Verzeichniseintrag</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>void</type><methodname>zip_entry_close</methodname>
      <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
     </methodsynopsis>
    <para>
     Schliet einen Verzeichniseintrag, der durch den Parameter
     <parameter>zip_entry</parameter> identifiziert wird. Dieser
     Parameter muss ein gltiger Verzeichniseintrag sein, der vorher
     durch <function>zip_entry_open</function> geffnet wurde.
    </para>
    <para>
     Diese Funktion hat keinen Rckgabewert.
    </para>
    <para>
     Siehe auch <function>zip_entry_open</function> und
     <function>zip_entry_read</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.zip-entry-compressedsize">
   <refnamediv>
    <refname>zip_entry_compressedsize</refname>
    <refpurpose>
     Gibt die komprimierte Gre eines Verzeichniseintrages zurck
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>zip_entry_compressedsize</methodname>
      <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
     </methodsynopsis>
    <para>
     Gibt die komprimierte Gre des Verzeichniseintrages zurck, der
     durch <parameter>zip_entry</parameter> spezifiziert wird.  Der
     Parameter <parameter>zip_entry</parameter> muss ein gltiger
     Verzeichniseintrag sein, der durch <function>zip_read</function>
     zurckgegeben wurde.
    </para>
    <para>
     Siehe auch <function>zip_open</function> und
     <function>zip_read</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.zip-entry-compressionmethod">
   <refnamediv>
    <refname>zip_entry_compressionmethod</refname>
    <refpurpose>
     Gibt die Komprimierungsmethode eines Verzeichniseintrages zurck.
    </refpurpose>
   </refnamediv>

   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>zip_entry_compressionmethod</methodname>
      <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
     </methodsynopsis>
    <para>
     Gibt die Komprimierungsmethode eines Verzeichniseintrages zurck,
     der durch <parameter>zip_entry</parameter> spezifiziert wird.
     Der Parameter <parameter>zip_entry</parameter> muss ein gltiger
     Verzeichniseintrag sein, der durch <function>zip_read</function>
     zurckgegeben wurde.
    </para>
    <para>
     Siehe auch <function>zip_open</function> und
     <function>zip_read</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.zip-entry-filesize">
   <refnamediv>
    <refname>zip_entry_filesize</refname>
    <refpurpose>
     Gibt die Gre eines Verzeichniseintrages zurck
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>zip_entry_filesize</methodname>
      <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
     </methodsynopsis>
    <para>
    Gibt die Gre eines Verzeichniseintrages zurck, der durch
    <parameter>zip_entry</parameter> spezifiziert wird.  Der Parameter
    <parameter>zip_entry</parameter> muss ein gltiger
    Verzeichniseintrag sein, der durch <function>zip_read</function>
    zurckgegeben wurde.
    </para>
    <para>
     Siehe auch <function>zip_open</function> und
     <function>zip_read</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.zip-entry-name">
   <refnamediv>
    <refname>zip_entry_name</refname>                 
    <refpurpose>
     Gibt den Namen eines Verzeichniseintrages zurck</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>zip_entry_name</methodname>
      <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
     </methodsynopsis>
    <para>
     Gibt den Namen eines Verzeichniseintrages zurck, der durch den
     Parameter <parameter>zip_entry</parameter> spezifiziert wurde.
     Der Parameter <parameter>zip_entry</parameter> muss ein gltiger
     Verzeichniseintrag sein, der durch <function>zip_read</function>
     zurckgegeben wurde.
    </para>
    <para>
     Siehe auch <function>zip_open</function> und
     <function>zip_read</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.zip-entry-open">
   <refnamediv>
    <refname>zip_entry_open</refname>
    <refpurpose>
     ffnet einen Verzeichniseintrag fr den Lesezugriff
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>bool</type><methodname>zip_entry_open</methodname>      
      <methodparam><type>resource</type><parameter>zip</parameter></methodparam>
      <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>mode</parameter></methodparam>
     </methodsynopsis>
    <para>
     ffnet einen Verzeichniseintrag fr den Lesezugriff. Der
     Parameter <parameter>zip</parameter> muss ein Dateizeiger sein,
     der vorher durch <function>zip_open</function> zurckgegeben
     wurde.  Der Parameter <parameter>zip_entry</parameter> ist ein
     Verzeichniseintrag, der durch <function>zip_read</function>
     zurckgegeben wurde. Der optionale Parameter
     <parameter>mode</parameter> kann einer der in der Dokumentation
     zu <function>fopen</function> beschriebenen Werte sein.
    </para>
    <note>
     <para>
      Gegenwrtig wird der Parameter <parameter>mode</parameter>
      ignoriert und implizit auf <literal>"rb"</literal> gesetzt. Dies
      erfolgt aufgrund des ausschlielichen Lesezugriffs der aktuellen
      ZIP Unterstzung fr PHP. In der Dokumentation zu
      <function>fopen</function> finden sich weitere Erklrungen zu
      diesem Parameter.
     </para>
    </note>
    <para>
     Gibt bei Erfolg &true; zurck, andernfalls &false;.
    </para>
    <note>
     <para>
      Im Gegensatz zu <function>fopen</function> und vergleichbaren
      Funktionen zeigt der Rckgabewert von
      <function>zip_entry_open</function> nur das Gelingen an und wird
      nicht fr weitere Operationen bentigt.
     </para>
    </note>
    <para>
     Siehe auch <function>zip_entry_read</function> und
     <function>zip_entry_close</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.zip-entry-read">
   <refnamediv>
    <refname>zip_entry_read</refname>
    <refpurpose>Liest einen geffneten Verzeichniseintrag aus</refpurpose>
  </refnamediv>
  <refsect1>
   <title>Beschreibung</title>
    <methodsynopsis>
     <type>string</type><methodname>zip_entry_read</methodname>
      <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
     </methodsynopsis>
    <para>
     Liest bis zu <parameter>length</parameter> Bytes von einem
     geffneten Verzeichniseintrag aus.  Wenn der Parameter
     <parameter>length</parameter> nicht angegeben wurde, wird
     versucht die ersten 1024 Bytes auszulesen.  Der Parameter
     <parameter>zip_entry</parameter> muss ein gltiger
     Verzeichniseintrag sein, der durch <function>zip_read</function>
     zurckgegeben wurde.
    </para>
    <note>
     <para>
      Der Parameter <parameter>length</parameter> bezieht sich auf die
      unkomprimierte Gre.
     </para>
    </note>
    <para>
     Gibt die ausgelesenen Daten zurck oder &false;, wenn das Ende
     der Datei erreicht wurde.
    </para>
    <para>
     Siehe auch <function>zip_entry_open</function>,
     <function>zip_entry_close</function> und
     <function>zip_entry_filesize</function>.
    </para>
   </refsect1>
  </refentry>
  
 </reference>

<!-- 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:"../../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
-->