mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 10:58:54 +00:00
aa38e693e3
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@177332 c90b9560-bf6c-de11-be94-00142212c4b1
127 lines
3.6 KiB
XML
127 lines
3.6 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.6 $ -->
|
|
<refentry id="function.ftp-ssl-connect">
|
|
<refnamediv>
|
|
<refname>ftp_ssl_connect</refname>
|
|
<refpurpose>Opens an Secure SSL-FTP connection</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>ftp_ssl_connect</methodname>
|
|
<methodparam><type>string</type><parameter>host</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>ftp_ssl_connect</function> opens a SSL-FTP connection to the
|
|
specified <parameter>host</parameter>.
|
|
</para>
|
|
<note>
|
|
<title>Why this function may not exist</title>
|
|
<para>
|
|
<function>ftp_ssl_connect</function> is only available if
|
|
<link linkend="ref.openssl">OpenSSL</link> support is enabled into
|
|
your version of PHP. If it's undefined and you've compiled
|
|
FTP support then this is why. For Windows you must compile your
|
|
own PHP binaries to support this function.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>host</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 a SSL-FTP stream on success or &false; on error.
|
|
</para>
|
|
</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
|
|
$conn_id = ftp_ssl_connect($ftp_server);
|
|
|
|
// login with username and password
|
|
$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass);
|
|
|
|
echo ftp_pwd($conn_id); // /
|
|
|
|
// close the ssl connection
|
|
ftp_close($conn_id);
|
|
?>
|
|
]]>
|
|
</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:"../../../../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
|
|
-->
|