php-doc-en/reference/zip/ziparchive/setmtimename.xml
Christoph Michael Becker 6318fc9e8b Mark ZipArchive methods as public
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350084 c90b9560-bf6c-de11-be94-00142212c4b1
2020-06-25 20:44:07 +00:00

125 lines
3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ziparchive.setmtimename" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ZipArchive::setMtimeName</refname>
<refpurpose>Set the modification time of an entry defined by its name</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type>
<methodname>ZipArchive::setMtimeName</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>int</type><parameter>timestamp</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Set the modification time 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>timestamp</parameter></term>
<listitem>
<para>
The modification time (unix timestamp) of the file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Optional flags, unused for now.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
This example creates a ZIP file archive
<filename>test.zip</filename> and add
the file <filename>test.txt</filename>
with its modification date.
</para>
<example>
<title>Archive a file</title>
<programlisting role="php">
<![CDATA[
<?php
$zip = new ZipArchive();
if ($zip->open('test.zip', ZipArchive::CREATE) === TRUE) {
$zip->addFile('text.txt');
$zip->setMtimeName('text.txt', mktime(0,0,0,12,25,2019));
$zip->close();
echo "Ok\n";
} else {
echo "KO\n";
}
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function is only available if built against libzip ≥ 1.0.0.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>ZipArchive::setMtimeIndex</methodname></member>
</simplelist>
</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
-->