ftp_alloc

(PHP 5, PHP 7, PHP 8)

ftp_alloc — アップロードされるファイルのためのスペースを確保する

説明

function ftp_alloc(FTP\Connection $ftp, int $size, string &$response = null): bool

ALLO コマンドを FTP サーバーに送信し、アップロードされるファイルのためのスペースを確保します。

注意:
多くの FTP サーバーはこのコマンドをサポートしていません。これらのサーバーの中には、「そのコマンドをサポートしていない」という意味で失敗コード（false）を返すものもあれば「事前に確保する必要はない」という意味で成功コード（true）を返すものもあります。このような理由から、事前のスペース確保が明示的に要求されているサーバーに対してのみこの関数を使用するようにするとよいでしょう。

パラメータ

ftp: FTP\Connection クラスのインスタンス
size: 確保したいバイト数。
response: response 変数が指定されていた場合、サーバーからの応答テキストの内容の参照が格納されます。

戻り値

成功した場合に true を、失敗した場合に false を返します。

変更履歴

バージョン	説明
8.1.0	引数 `ftp` は、FTP\Connection のインスタンスを期待するようになりました。これより前のバージョンでは、resource を期待していました。

例

例1 ftp_alloc() の例

<?php

$file = "/home/user/myfile";

// サーバーに接続する
$ftp = ftp_connect('ftp.example.com');
$login_result = ftp_login($ftp, 'anonymous', 'user@example.com');

if (ftp_alloc($ftp, filesize($file), $result)) {
  echo "Space successfully allocated on server.  Sending $file.\n";
  ftp_put($ftp, '/incoming/myfile', $file, FTP_BINARY);
} else {
  echo "Unable to allocate space on server.  Server said: $result\n";
}

ftp_close($ftp);

?>

参考

ftp_put() - FTP サーバーにファイルをアップロードする
ftp_fput() - オープン中のファイルを FTP サーバーにアップロードする

関連キーワード:

サーバー確保アップロードスペース alloc Connection response size サポート意味コード成功インスタンス期待 user myfile example login server append 送信理由明示要求バイト