ftp-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4d1c34c9b7a30cfc3a59641122c707a2812cfed7 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.ftp-connect" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ftp_connect</refname>
  <refpurpose>FTP 接続をオープンする</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>FTP\Connection</type><type>false</type></type><methodname>ftp_connect</methodname>
   <methodparam><type>string</type><parameter>hostname</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>port</parameter><initializer>21</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>timeout</parameter><initializer>90</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>ftp_connect</function> は、指定した <parameter>hostname</parameter>
   への FTP 接続をオープンします。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>hostname</parameter></term>
     <listitem>
      <para>
       FTP サーバーのアドレス。このパラメータには、最後のスラッシュや最初の
       <literal>ftp://</literal> をつけてはいけません。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       このパラメータは接続先のポートを指定します。もし指定しなかったり
       ゼロを指定したりした場合は、デフォルトの FTP ポートである 21
       が用いられます。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>timeout</parameter></term>
     <listitem>
      <para>
       このパラメータは、以降のネットワーク操作時のタイムアウトを秒単位で指定します。
       指定されなかった場合のデフォルト値は 90 秒です。タイムアウトの変更や
       参照は、<function>ftp_set_option</function> や
       <function>ftp_get_option</function> を用いていつでも可能です。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合に <classname>FTP\Connection</classname>
   クラスのインスタンスを返します。
   &return.falseforfailure;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.1.0</entry>
      <entry>
       <classname>FTP\Connection</classname>
       クラスのインスタンスを返すようになりました。
       これより前のバージョンでは、
       &resource; が返されていました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

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

$ftp_server = "ftp.example.com";

// 接続を確立します。できなければ終了します。
$ftp = ftp_connect($ftp_server) or die("Couldn't connect to $ftp_server");

?>
]]>  
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ftp_close</function></member>
    <member><function>ftp_ssl_connect</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
-->