Files
doc-fr/reference/ftp/functions/ftp-alloc.xml
George Peter Banyard 2b0cfd5ba8 Apply commit 4d1c34c9b7a30cfc3a59641122c707a2812cfed7
[PHP 8.1] Use an FTP\Connection instance instead of a resource
2021-09-24 21:01:19 +01:00

150 lines
4.0 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 4d1c34c9b7a30cfc3a59641122c707a2812cfed7 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.ftp-alloc" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ftp_alloc</refname>
<refpurpose>Alloue de l'espace pour un téléchargement de fichier</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ftp_alloc</methodname>
<methodparam><type>FTP\Connection</type><parameter>ftp</parameter></methodparam>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter role="reference">response</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>ftp_alloc</function> envoie la commande FTP <literal>ALLO</literal>
pour allouer un espace sur le serveur FTP de <parameter>filesize</parameter>
octets.
</para>
<note>
<para>
De nombreux serveur FTP ne supportent pas cette commande. Ces
serveurs peuvent retourner un code d'erreur (&false;) qui indique
que la commande n'est pas supportée, ou (&true;) pour dire que la
préallocation n'est pas nécessaire : le client continue alors ses
opérations de la même façon. À cause de cela, il est préférable
de n'utiliser cette fonction qu'avec les serveurs qui requièrent
spécifiquement cette fonction.
</para>
</note>
<para>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>ftp</parameter></term>
<listitem>
&ftp.parameter.ftp;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
Le nombre d'octets à allouer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>response</parameter></term>
<listitem>
<para>
Une représentation textuelle de la réponse du serveur qui sera retournée
par référence dans <parameter>response</parameter> si une variable est fournie.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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>Exemple avec <function>ftp_alloc</function></title>
<programlisting role="php">
<![CDATA[
<?php
$file = "/home/user/myfile";
// Connexion au serveur
$ftp = ftp_connect('ftp.example.com');
$login_result = ftp_login($ftp, 'anonymous', 'user@example.com');
if (ftp_alloc($ftp, filesize($file), $result)) {
echo "Espace alloué avec succès sur le serveur. Envoi de $file.\n";
ftp_put($ftp, '/incoming/myfile', $file, FTP_BINARY);
} else {
echo "Impossible d'allouer l'espace sur le serveur. Réponse du serveur : $result\n";
}
ftp_close($ftp);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ftp_put</function></member>
<member><function>ftp_fput</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
-->