File: getexternalattributesindex.xml

package info (click to toggle)
php-doc 20250827~git.abe740d%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 71,968 kB
  • sloc: xml: 985,760; php: 25,504; javascript: 671; sh: 177; makefile: 37
file content (119 lines) | stat: -rw-r--r-- 3,576 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ziparchive.getexternalattributesindex" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ZipArchive::getExternalAttributesIndex</refname>
  <refpurpose>Retrieve the external attributes of an entry defined by its index</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="ZipArchive">
   <modifier>public</modifier> <type>bool</type><methodname>ZipArchive::getExternalAttributesIndex</methodname>
   <methodparam><type>int</type><parameter>index</parameter></methodparam>
   <methodparam><type>int</type><parameter role="reference">opsys</parameter></methodparam>
   <methodparam><type>int</type><parameter role="reference">attr</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Retrieve the external attributes of an entry defined by its index.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>index</parameter></term>
     <listitem>
      <para>
       Index of the entry.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>opsys</parameter></term>
     <listitem>
      <para>
       On success, receive the operating system code defined by one of the ZipArchive::OPSYS_ constants.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>attr</parameter></term>
     <listitem>
      <para>
       On success, receive the external attributes. Value depends on operating system.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       If flags is set to <constant>ZipArchive::FL_UNCHANGED</constant>, the original unchanged
       attributes are returned.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
    <para>
      This example extract all the entries of a ZIP
      archive <filename>test.zip</filename> and 
      set the Unix rights from external attributes.
    </para>
    <example xml:id="ziparchive.getexternalattributesindex.examples.perms">
     <title>Extract all entries with Unix rights</title>
     <programlisting role="php">
<![CDATA[
<?php
$zip = new ZipArchive();
if ($zip->open('test.zip') === TRUE) {
    for ($idx=0 ; $s = $zip->statIndex($idx) ; $idx++) {
        if ($zip->extractTo('.', $s['name'])) {
            if ($zip->getExternalAttributesIndex($idx, $opsys, $attr) 
                && $opsys==ZipArchive::OPSYS_UNIX) {
               chmod($s['name'], ($attr >> 16) & 0777);
            }
        }
    }
    $zip->close();
    echo "Ok\n";
} else {
    echo "KO\n";
}
?>
]]>
     </programlisting>
    </example>
   </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
-->