ftp-set-option.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 4d1c34c9b7a30cfc3a59641122c707a2812cfed7 Maintainer: blindman Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.ftp-set-option" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ftp_set_option</refname>
  <refpurpose>Устанавливает параметры соединения с FTP-сервером</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ftp_set_option</methodname>
   <methodparam><type>FTP\Connection</type><parameter>ftp</parameter></methodparam>
   <methodparam><type>int</type><parameter>option</parameter></methodparam>
   <methodparam><type class="union"><type>int</type><type>bool</type></type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   Эта функция устанавливает параметры соединения с FTP-сервером.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>ftp</parameter></term>
     <listitem>
       &ftp.parameter.ftp;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       В настоящее время поддерживаются следующие параметры:
       <table>
        <title>Поддерживаемые параметры</title>
        <tgroup cols="2">
         <tbody>
          <row>
           <entry><constant>FTP_TIMEOUT_SEC</constant></entry>
           <entry>
            Устанавливает время ожидания сетевых операций, в секундах. Аргумент
            <parameter>value</parameter> должен быть целым, больше 0. По
            умолчанию время ожидания равно 90 секундам.
           </entry>
          </row>
          <row>
           <entry><constant>FTP_AUTOSEEK</constant></entry>
           <entry>При установке этого параметра перед выполнением запросов
            GET или PUT с параметром <parameter>resumepos</parameter> или
            <parameter>startpos</parameter> указатель файла будет установлен
            на запрошенную позицию. Этот параметр установлен по умолчанию.
           </entry>
          </row>
          <row>
           <entry><constant>FTP_USEPASVADDRESS</constant></entry>
           <entry>
            Если отключено, то PHP  будет игнорировать IP-адрес, возвращённый сервером в ответ на команду PASV и вместо него будет использовать IP-адрес, переданный в ftp_connect().
            Параметр <parameter>value</parameter> должен содержать логическое значение.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       Назначение этого аргумента зависит от значения параметра
       <parameter>option</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает &true; если параметр был установлен; &false; в противном
   случае. Если значение аргумента <parameter>option</parameter> не
   поддерживается или значение аргумента <parameter>value</parameter> не
   соответствует значению аргумента <parameter>option</parameter>, будет
   выведено предупреждение.
  </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;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <function>ftp_set_option</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// установка времени ожидания в 10 секунд
ftp_set_option($ftp, FTP_TIMEOUT_SEC, 10);
?>
]]>
      </programlisting>
     </example>
    </para>
   </refsect1>
   <refsect1 role="seealso">
    &reftitle.seealso;
    <para>
     <simplelist>
      <member><function>ftp_get_option</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
-->