ftp-ssl-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ftp-ssl-connect" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ftp_ssl_connect</refname>
  <refpurpose>Opens a Secure SSL-FTP connection</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> opens an <emphasis>explicit</emphasis> SSL-FTP connection to the
   specified <parameter>hostname</parameter>. That implies that
   <function>ftp_ssl_connect</function> will succeed even if the server is not
   configured for SSL-FTP. Only when <function>ftp_login</function> is called, the client will send the
   appropriate <literal>AUTH FTP</literal> command, so <function>ftp_login</function> will fail.
   The connection established by <function>ftp_ssl_connect</function> will <emphasis>not</emphasis> do
   peer-certificate verification.
  </para>
  <note>
   <title>Why this function may not exist</title>
   <para>
    Before PHP 7.0.0, <function>ftp_ssl_connect</function> was only available if both
    the ftp module and the <link linkend="ref.openssl">OpenSSL</link>
    support have been built statically into php; this means that on Windows this
    function had been undefined in the official PHP builds. To have this
    function available on Windows, it had been necessary to compile own PHP binaries.
   </para>
  </note>
  <note>
   <para>
    <function>ftp_ssl_connect</function> is not intended for use with sFTP.
    To use sFTP with PHP, please see <function>ssh2_sftp</function>.
   </para>
  </note>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>hostname</parameter></term>
     <listitem>
      <para>
       The FTP server address. This parameter shouldn't have any trailing 
       slashes and shouldn't be prefixed with <literal>ftp://</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       This parameter specifies an alternate port to connect to. If it is
       omitted or set to zero, then the default FTP port, 21, will be used.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>timeout</parameter></term>
     <listitem>
      <para>
       This parameter specifies the timeout for all subsequent network operations.
       If omitted, the default value is 90 seconds. The timeout can be changed and
       queried at any time with <function>ftp_set_option</function> and
       <function>ftp_get_option</function>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an <classname>FTP\Connection</classname> instance on success,&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>
       Returns an <classname>FTP\Connection</classname> instance now;
       previously, a &resource; was returned.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

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

// set up basic ssl connection
$ftp = ftp_ssl_connect($ftp_server);

// login with username and password
$login_result = ftp_login($ftp, $ftp_user_name, $ftp_user_pass);

if (!$login_result) {
    // PHP will already have raised an E_WARNING level message in this case
    die("can't login");
}

echo ftp_pwd($ftp);

// close the ssl connection
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
-->