svn: /phpdoc/ja/trunk/reference/zip/ziparchive/ registercancelcallback.xml registerprogresscallback.xml
[email protected] (Yoshinari Takaoka)
| Newsgroups | php.doc.ja |
|---|---|
| Message-ID | <[email protected]> |
mumumu Sat, 01 Feb 2020 00:37:04 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=349079
Log:
add ZipArchive::registerCancelCallback and ZipArchive::registerProgressCallback (zip 1.17.0)
Changed paths:
A phpdoc/ja/trunk/reference/zip/ziparchive/registercancelcallback.xml
A phpdoc/ja/trunk/reference/zip/ziparchive/registerprogresscallback.xml
Added: phpdoc/ja/trunk/reference/zip/ziparchive/registercancelcallback.xml
===================================================================
--- phpdoc/ja/trunk/reference/zip/ziparchive/registercancelcallback.xml (rev 0)
+++ phpdoc/ja/trunk/reference/zip/ziparchive/registercancelcallback.xml 2020-02-01 00:37:04 UTC (rev 349079)
@@ -0,0 +1,106 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 349077 Maintainer: mumumu Status: ready -->
+
+<refentry xml:id="ziparchive.registercancelcallback" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+ <refname>ZipArchive::registerCancelCallback</refname>
+ <refpurpose>アーカイブを閉じている間にキャンセルできるようにコールバックを登録する</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>bool</type>
+ <methodname>ZipArchive::registerCancelCallback</methodname>
+ <methodparam><type>callable</type><parameter>callback</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ アーカイブを閉じている間にキャンセルできるように <parameter>callback</parameter> 関数を登録します。
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>callback</parameter></term>
+ <listitem>
+ <para>
+ この関数が0を返すと、操作は続行されます。
+ それ以外の値を返すと、操作はキャンセルされます。
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ <note>
+ <para>
+ この関数は、libzip ≥ 1.6.0 と PHP をビルドした場合のみ利用できます。
+ </para>
+ </note>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ この例は、<filename>php.zip</filename> というZIPファイルを生成し、
+ ある実行時の条件に応じて操作をキャンセルします。
+ </para>
+ <example>
+ <title>ファイルをアーカイブする</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$zip = new ZipArchive();
+if ($zip->open('php.zip', ZipArchive::CREATE | ZipArchive::OVERWRITE)) {
+ $zip->addFile(PHP_BINARY, 'php');
+ $zip->registerCancelCallback(function () {
+ return ($someruncondition ? -1 : 0);
+ });
+ $zip->close();
+}
+]]>
+ </programlisting>
+ </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><methodname>ZipArchive::registerProgressCallback</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
+-->
Property changes on: phpdoc/ja/trunk/reference/zip/ziparchive/registercancelcallback.xml
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property
Added: phpdoc/ja/trunk/reference/zip/ziparchive/registerprogresscallback.xml
===================================================================
--- phpdoc/ja/trunk/reference/zip/ziparchive/registerprogresscallback.xml (rev 0)
+++ phpdoc/ja/trunk/reference/zip/ziparchive/registerprogresscallback.xml 2020-02-01 00:37:04 UTC (rev 349079)
@@ -0,0 +1,114 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 349078 Maintainer: mumumu Status: ready -->
+
+<refentry xml:id="ziparchive.registerprogresscallback" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+ <refname>ZipArchive::registerProgressCallback</refname>
+ <refpurpose>アーカイブを閉じている間に更新できるようにコールバックを登録する</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>bool</type>
+ <methodname>ZipArchive::registerProgressCallback</methodname>
+ <methodparam><type>float</type><parameter>rate</parameter></methodparam>
+ <methodparam><type>callable</type><parameter>callback</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ アーカイブを閉じている間に更新できるように <parameter>callback</parameter> 関数を登録します。
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>rate</parameter></term>
+ <listitem>
+ <para>
+ コールバックを呼び出す間の変更の割合(0.0 から 1.0 の間の値を設定します)
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>callback</parameter></term>
+ <listitem>
+ <para>
+ この関数は現在の <parameter>state</parameter> (状態) を
+ (0.0 から 1.0 の間の) <type>float</type> で受け取ります。
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ <note>
+ <para>
+ この関数は、libzip ≥ 1.3.0 と PHP をビルドした場合のみ利用できます。
+ </para>
+ </note>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ この例は、<filename>php.zip</filename> というZIPファイルを生成し、
+ 進捗状況を表示します。
+ </para>
+ <example>
+ <title>ファイルをアーカイブする</title>
+ <programlisting role="php">
+<![CDATA[
+$zip = new ZipArchive();
+if ($zip->open('php.zip', ZipArchive::CREATE | ZipArchive::OVERWRITE)) {
+ $zip->addFile(PHP_BINARY, 'php');
+ $zip->registerProgressCallback(0.05, function ($r) {
+ printf("%d%%\n", $r * 100);
+ });
+ $zip->close();
+}
+]]>
+ </programlisting>
+ </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><methodname>ZipArchive::registerCancelCallback</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
+-->
Property changes on: phpdoc/ja/trunk/reference/zip/ziparchive/registerprogresscallback.xml
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property