Documentation for ZipArchive::setExternalAttributesName() and ZipArchive::setExternalAttributesIndex().

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332935 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Remi Collet 2014-03-07 16:28:06 +00:00
parent b8b1b1748c
commit 0b7f957602
3 changed files with 178 additions and 0 deletions

View file

@ -32,6 +32,8 @@
<function name='ZipArchive::setArchiveComment' from='PHP 5 &gt;= 5.2.0, PECL zip &gt;= 1.4.0'/>
<function name='ZipArchive::setCommentIndex' from='PHP 5 &gt;= 5.2.0, PECL zip &gt;= 1.4.0'/>
<function name='ZipArchive::setCommentName' from='PHP 5 &gt;= 5.2.0, PECL zip &gt;= 1.4.0'/>
<function name='ZipArchive::setExternalAttributesIndex' from='PHP 5 &gt;= 5.6.0, PECL zip &gt;= 1.12.4'/>
<function name='ZipArchive::setExternalAttributesName' from='PHP 5 &gt;= 5.6.0, PECL zip &gt;= 1.12.4'/>
<function name='ZipArchive::stat' from='PHP 5 &gt;= 5.2.0, PECL zip &lt; 1.5.0'/>
<function name='ZipArchive::statIndex' from='PHP 5 &gt;= 5.2.0, PECL zip &gt;= 1.1.0'/>
<function name='ZipArchive::statName' from='PHP 5 &gt;= 5.2.0, PECL zip &gt;= 1.5.0'/>

View file

@ -0,0 +1,88 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ziparchive.setexternalattributesindex" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ZipArchive::setExternalAttributesIndex</refname>
<refpurpose>Set the external attributes of an entry defined by its index</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type>
<methodname>ZipArchive::setExternalAttributesIndex</methodname>
<methodparam><type>int</type><parameter>index</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></methodparam>
</methodsynopsis>
<para>
Set the comment 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>
The operating system code defined by one of the OPSYS_ macro
</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>
</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
-->

View file

@ -0,0 +1,88 @@
<?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>
<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></methodparam>
</methodsynopsis>
<para>
Set the comment of an entry defined by its index.
</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 OPSYS_ macro.
</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>
</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
-->