php-doc-en/reference/zip/ziparchive/getexternalattributesindex.xml
Remi Collet 244efca786 Fix code sample
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@339282 c90b9560-bf6c-de11-be94-00142212c4b1
2016-06-02 12:48:44 +00:00

121 lines
No EOL
3.4 KiB
XML

<?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>
<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></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>
<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
-->