ftp-nb-put.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4d1c34c9b7a30cfc3a59641122c707a2812cfed7 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.ftp-nb-put" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ftp_nb_put</refname>
  <refpurpose>FTP サーバーにファイルを保存する（非ブロッキング）</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>ftp_nb_put</methodname>
   <methodparam><type>FTP\Connection</type><parameter>ftp</parameter></methodparam>
   <methodparam><type>string</type><parameter>remote_filename</parameter></methodparam>
   <methodparam><type>string</type><parameter>local_filename</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>FTP_BINARY</constant></initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>ftp_nb_put</function> はローカルファイルを FTP サーバーに保存します。
  </para>
  <para>
   <function>ftp_put</function> との違いは、この関数が
   非同期処理でファイルをアップロードするということです。そのため、
   ファイルをアップロードしている最中に別の処理を行うことができます。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>ftp</parameter></term>
     <listitem>
      &ftp.parameter.ftp;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>remote_filename</parameter></term>
     <listitem>
      <para>
       リモートファイルのパス。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>local_filename</parameter></term>
     <listitem>
      <para>
       ローカルファイルのパス。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       転送モード。<constant>FTP_ASCII</constant> または
       <constant>FTP_BINARY</constant> のどちらかを指定する必要があります。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>リモートファイル内での、アップロード開始位置。</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <constant>FTP_FAILED</constant>、<constant>FTP_FINISHED</constant>
   あるいは <constant>FTP_MOREDATA</constant> を返します。
   ローカルファイルのオープンに失敗した場合、&false; を返します。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &ftp.changelog.ftp-param;
     <row>
      <entry>7.3.0</entry>
      <entry>
       <parameter>mode</parameter> パラメータはオプションになりました。
       これより前のバージョンでは、このパラメータは必須でした。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>ftp_nb_put</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php

// アップロードを開始する
$ret = ftp_nb_put($ftp, "test.remote", "test.local", FTP_BINARY);
while ($ret == FTP_MOREDATA) {
   
   // 何かお好みの動作を
   echo ".";

   // アップロードを継続する…
   $ret = ftp_nb_continue($ftp);
}
if ($ret != FTP_FINISHED) {
   echo "There was an error uploading the file...";
   exit(1);
}
?>
]]>
    </programlisting>
   </example>
   <example>
    <title><function>ftp_nb_put</function> でアップロードを再開する</title>
    <programlisting role="php">
<![CDATA[
<?php

// 開始
$ret = ftp_nb_put($ftp, "test.remote", "test.local", 
                      FTP_BINARY, ftp_size("test.remote"));
// あるいは: $ret = ftp_nb_put($my_connection, "test.remote", "test.local", 
//                             FTP_BINARY, FTP_AUTORESUME);

while ($ret == FTP_MOREDATA) {
   
   // 何かお好みの動作を
   echo ".";

   // アップロードを継続する…
   $ret = ftp_nb_continue($ftp);
}
if ($ret != FTP_FINISHED) {
   echo "There was an error uploading the file...";
   exit(1);
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ftp_nb_fput</function></member>
    <member><function>ftp_nb_continue</function></member>
    <member><function>ftp_put</function></member>
    <member><function>ftp_fput</function></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
-->