ftp-ssl-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 11a4d4964802dbc147f369b8a16df692c391cd2f Maintainer: yuanyuqiang Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<refentry xml:id="function.ftp-ssl-connect" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ftp_ssl_connect</refname>
  <refpurpose>打开安全 SSL-FTP 连接</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>FTP\Connection</type><type>false</type></type><methodname>ftp_ssl_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_ssl_connect</function> 打开到指定 <parameter>hostname</parameter> 的<emphasis>明确</emphasis>
   SSL-FTP 连接。即使服务器没有为 SSL-FTP 配置，<function>ftp_ssl_connect</function>
   也会成功。只有调用 <function>ftp_login</function> 时，客户端才会发送对应的 <literal>AUTH FTP</literal>
   命令，因此 <function>ftp_login</function> 会失败。<function>ftp_ssl_connect</function> 建立的连接<emphasis>不会</emphasis>进行对等证书验证。
  </para>
  <note>
   <title>为何本函数有可能不存在？</title>
   <para>
    在 PHP 7.0 之前，只有 ftp 模块和 <link linkend="ref.openssl">OpenSSL</link> 模块都静态编译到 PHP
    时，<function>ftp_ssl_connect</function> 才可用；也就是说，在 Windows 平台上，此函数在官方 PHP
    编译中未定义。如果需要在 Windows 平台使用本函数，需要自行编译 PHP 二进制文件。
   </para>
  </note>
  <note>
   <para>
    <function>ftp_ssl_connect</function> 不是用来连接 sFTP 服务的。
    要在 PHP 中使用 sFTP，请参见 <function>ssh2_sftp</function>。
   </para>
  </note>
 </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>
       要连接的端口。如果省略此参数或设置为 0，将使用 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_ssl_connect</function> 函数示例</title>
    <programlisting role="php">
<![CDATA[
<?php

// 建立基础 SSL 连接
$ftp = ftp_ssl_connect($ftp_server);

// 使用用户名和密码登录
$login_result = ftp_login($ftp, $ftp_user_name, $ftp_user_pass);

if (!$login_result) {
    // 在这种情况下，PHP 会发生 E_WARNING 级别的告警消息
    die("can't login");
}

echo ftp_pwd($ftp); // /

// 关闭 ssl 连接
ftp_close($ftp);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ftp_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
-->