ftp_rawlist

(PHP 4, PHP 5, PHP 7, PHP 8)

ftp_rawlist — 指定したディレクトリの詳細なファイル一覧を返す

説明

ftp_rawlist(FTP\Connection $ftp, string $directory, bool $recursive = false): array|false

ftp_rawlist() は、FTP LIST コマンドを実行し、結果を配列として返します。

パラメータ

ftp: FTP\Connection クラスのインスタンス
directory: ディレクトリのパス。 LIST コマンドの引数を含むこともあります。
recursive: true を設定した場合、発行されるコマンドは LIST -R となります。

戻り値

各要素が 1 行分のテキストに対応する配列を返します。渡された directory が無効な場合は false を返します。

出力に関する処理は全く行われません。結果の解釈の仕方を定義するために ftp_systype() から返されるシステム型 ID を使用することができます。

変更履歴

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

例

例1 ftp_rawlist() の例

<?php

// 接続を確立する
$ftp = ftp_connect($ftp_server);

// ユーザー名とパスワードでログインする
$login_result = ftp_login($ftp, $ftp_user_name, $ftp_user_pass);

// / のファイル一覧を得る
$buff = ftp_rawlist($ftp, '/');

// 接続を閉じる
ftp_close($ftp);

// バッファの内容を出力する
var_dump($buff);
?>

上の例の出力は、たとえば以下のようになります。

array(3) {
  [0]=>
  string(65) "drwxr-x---   3 vincent  vincent      4096 Jul 12 12:16 public_ftp"
  [1]=>
  string(66) "drwxr-x---  15 vincent  vincent      4096 Nov  3 21:31 public_html"
  [2]=>
  string(73) "lrwxrwxrwx   1 vincent  vincent        11 Jul 12 12:16 www -> public_html"
}

参考

ftp_nlist() - 指定したディレクトリのファイルの一覧を返す
ftp_mlsd() - ディレクトリに存在するファイルの一覧を返す