PHPのftp_alloc()関数とは？使い方とサンプルコードを解説

ftp_alloc() 関数は、FTPサーバーにファイルをアップロードする前に、そのファイル用のディスクスペースを事前に確保するための関数です。内部的にはFTPの「ALLO」コマンドを送信し、サーバー側に十分な空き容量が存在するかどうかを確認できます。対応していないサーバーもありますが、大きなファイルを扱う際にはアップロード失敗の防止に役立ちます。

構文

ftp_alloc(connection, size_of_file, res);

パラメータ

• connection − 使用するFTP接続（ftp_connect() で取得した接続リソース）

• size_of_file − 確保する容量（バイト単位で指定）

• res − サーバーからの応答メッセージを格納する変数（省略可能）

戻り値

ftp_alloc() 関数は、スペースの確保に成功した場合は TRUE、失敗した場合は FALSE を返します。失敗時の詳細は、第3引数の res に格納されるサーバー応答メッセージから確認できます。

使用例

以下は、ftp_alloc() を使ってアップロード前に必要なスペースを確保し、成功した場合にファイルを転送する例です。

<?php
    $myFile = "demo.txt";

    // FTPサーバーに接続
    $con = ftp_connect('192.168.0.4');
    $login_result = ftp_login($con, 'yuvgj2j', 'yuvgj2j');

    // ファイルサイズ分のスペースを確保
    if (ftp_alloc($con, filesize($myFile), $res)) {
        echo "{$myFile} を送信しています\n";
        ftp_put($con, 'D:/ds', $myFile, FTP_BINARY);
    } else {
        echo "スペースの確保に失敗しました！ メッセージ = {$res}\n";
    }

    // 接続を閉じる
    ftp_close($con);
?>

このように、まず filesize() でアップロード対象ファイルのサイズを取得し、ftp_alloc() でサーバー上に十分な領域を確保してから ftp_put() でファイルを転送する流れになります。これにより、容量不足によるアップロードエラーを事前に検知できます。