setexternalattributesname.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ziparchive.setexternalattributesname" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ZipArchive::setExternalAttributesName</refname>
  <refpurpose>Set the external attributes of an entry defined by its name</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="ZipArchive">
   <modifier>public</modifier> <type>bool</type><methodname>ZipArchive::setExternalAttributesName</methodname>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
   <methodparam><type>int</type><parameter>opsys</parameter></methodparam>
   <methodparam><type>int</type><parameter>attr</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Set the external attributes of an entry defined by its name.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       Name of the entry.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>opsys</parameter></term>
     <listitem>
      <para>
       The operating system code defined by one of the ZipArchive::OPSYS_ constants.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>attr</parameter></term>
     <listitem>
      <para>
       The external attributes. Value depends on operating system.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Optional flags. Currently unused.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
    <para>
     This example opens a ZIP file archive
     <filename>test.zip</filename> and add
     the file <filename>test.txt</filename>
     with its Unix rights as external attributes.
    </para>
    <example>
     <title>Archive a file, with its Unix rights</title>
     <programlisting role="php">
<![CDATA[
<?php
$zip = new ZipArchive();
$stat = stat($filename='test.txt');
if (is_array($stat) && $zip->open('test.zip', ZipArchive::CREATE) === TRUE) {
    $zip->addFile($filename);
    $zip->setExternalAttributesName($filename, ZipArchive::OPSYS_UNIX, $stat['mode'] << 16);
    $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
-->