PHPのftp_rawlist()関数の使い方を解説

ftp_rawlist()関数とは

PHPのftp_rawlist()関数は、FTPサーバー上の指定したディレクトリ内にあるファイル一覧を、ファイルサイズや更新日時などの詳細情報付きで取得するための関数です。FTPプロトコルの「LIST」コマンドをそのまま実行するため、サーバーから返される生のテキスト形式の一覧をそのまま受け取ることができます。

構文

ftp_rawlist(conn, dir, recursive);

パラメータ

• conn − ftp_connect()で確立したFTP接続リソースを指定します。

• dir − 一覧を取得したいディレクトリのパスを指定します。

• recursive − 省略可能なパラメータです。デフォルトではサーバーに対して「LIST」コマンドを送信します。trueを指定すると「LIST -R」コマンドが送信され、サブディレクトリの内容も再帰的に取得できます。

戻り値

ftp_rawlist()関数は、配列を返します。配列の各要素は、サーバーから返された1行分のテキストに対応しています。一覧の取得に失敗した場合はfalseを返します。

使用例

次の例では、指定したディレクトリ内のファイル一覧を詳細情報付きで取得し、表示しています。

<?php
    $ftp_server = "192.168.0.4";
    $ftp_user = "jacob";
    $ftp_pass = "tywg61gh";
    // FTPサーバーに接続
    $conn = ftp_connect($ftp_server) or die("$ftp_server に接続できませんでした");
    // ログイン
    $login = ftp_login($conn, $ftp_user, $ftp_pass);
    // ルートディレクトリのファイル一覧を取得
    $file_list = ftp_rawlist($conn, "/");
    // 接続を閉じる
    ftp_close($conn);
    var_dump($file_list);
?>

まとめ

ftp_rawlist()関数は、FTPサーバー上のファイル情報を柔軟に取得したい場合に便利な関数です。単純にファイル名だけが必要な場合はftp_nlist()関数の使用を検討し、パーミッションやファイルサイズなどの詳細情報が必要な場合に本関数を活用するとよいでしょう。