PHP ファイルシステム関数 リファレンス
PHP ファイルシステム関数について
ファイルシステム関数を使用すると、ファイルシステムにアクセスして操作することができます。
インストール
ファイルシステム関数はPHPにデフォルトで組み込まれています。したがってファイルシステム関数を使用するためのインストールは必要ありません。
Unix / Windowsの互換性
Unixプラットフォームでは、パスを指定する際にフォワードスラッシュ（/）をディレクトリセパレータとして使用します。
Windowsプラットフォームでは、フォワードスラッシュ（/）とバックスラッシュ（\）の両方を使用できます。
ランタイム設定
ファイルシステム関数の動作はphp.iniの設定によって影響を受けます。
| 名前 | デフォルト | 説明 | 変更可能 |
|---|---|---|---|
| allow_url_fopen | “1” | fopen()タイプの関数でURLを扱えるようにします | PHP_INI_SYSTEM |
| allow_url_include | “0” | (PHP 5.2以降で利用可能) | PHP_INI_SYSTEM |
| user_agent | NULL | 送信するユーザーエージェントを定義します (PHP 4.3以降で利用可能) | PHP_INI_ALL |
| default_socket_timeout | “60” | ソケットベースのストリームのデフォルトタイムアウトを秒単位で設定します (PHP 4.3以降で利用可能) | PHP_INI_ALL |
| from | “” | 認証されていないFTP接続や、ftpおよびhttpラッパーを使用するHTTP接続のFromヘッダーに使用されるメールアドレスを定義します (PHP_INI_ALL) | PHP_INI_ALL |
| auto_detect_line_endings | “0” | fgets()およびfile()によって読み込まれるデータがUnix、MS-Dos、またはMacの行末文字を使用しているかどうかを調べる場合に設定します (PHP 4.3以降で利用可能) | PHP_INI_ALL |
| sys_temp_dir | “” | (PHP 5.5以降で利用可能) | PHP_INI_SYSTEM |
PHP ファイルシステム関数
| 関数 | 説明 |
|---|---|
| basename() | パスからファイル名の部分を返す |
| chgrp() | ファイルのグループを変更する |
| chmod() | ファイルのモードを変更する |
| chown() | ファイルの所有者を変更する |
| clearstatcache() | ファイルステータスのキャッシュをクリアする |
| copy() | ファイルをコピーする |
| delete() | unlink()を参照 |
| dirname() | パスからディレクトリ名の部分を返す |
| disk_free_space() | ファイルシステムまたはディスクの空き容量を返す |
| disk_total_space() | ファイルシステムまたはディスクの合計サイズを返す |
| diskfreespace() | disk_free_space()のエイリアス |
| fclose() | オープンされたファイルを閉じる |
| feof() | オープンされたファイルの終端（EOF）に達しているかどうかを確認する |
| fflush() | バッファされた出力をオープンされたファイルにフラッシュする |
| fgetc() | オープンされたファイルから単一の文字を返す |
| fgetcsv() | オープンされたCSVファイルから1行を返す |
| fgets() | オープンされたファイルから1行を返す |
| fgetss() | PHP 7.3以降では非推奨。オープンされたファイルから1行を返すが、HTMLとPHPタグが取り除かれています |
| file() | ファイルを配列に読み込む |
| file_exists() | ファイルまたはディレクトリが存在するかどうかを確認する |
| file_get_contents() | ファイルを文字列に読み込む |
| file_put_contents() | データをファイルに書き込む |
| fileatime() | ファイルの最終アクセス時刻を返す |
| filectime() | ファイルの最終変更時刻を返す |
| filegroup() | ファイルのグループIDを返す |
| fileinode() | ファイルのinode番号を返す |
| filemtime() | ファイルの最終修正時刻を返す |
| fileowner() | ファイルの所有者のユーザーIDを返す |
| fileperms() | ファイルのパーミッションを返す |
| filesize() | ファイルサイズを返す |
| filetype() | ファイルのタイプを返す |
| flock() | ファイルをロックまたはアンロックする |
| fnmatch() | 指定されたパターンにファイル名または文字列を一致させる |
| fopen() | ファイルまたはURLをオープンする |
| fpassthru() | 現在の位置からファイルの終わり（EOF）まで読み取り、その結果を出力バッファに書き込む |
| fputcsv() | 行をCSV形式でフォーマットし、オープンされたファイルに書き込む |
| fputs() | fwrite()のエイリアス |
| fread() | オープンされたファイルから読み取る（バイナリセーフ） |
| fscanf() | 指定された形式に従ってオープンされたファイルから入力をパースする |
| fseek() | オープンされたファイル内で位置を移動する |
| fstat() | オープンされたファイルに関する情報を返す |
| ftell() | オープンされたファイル内の現在の位置を返す |
| ftruncate() | オープンされたファイルを指定された長さで切り詰める |
| fwrite() | オープンされたファイルに書き込む（バイナリセーフ） |
| glob() | 指定されたパターンに一致するファイル名やディレクトリ名の配列を返す |
| is_dir() | ファイルがディレクトリかどうかを確認する |
| is_executable() | ファイルが実行可能かどうかを確認する |
| is_file() | ファイルが通常のファイルかどうかを確認する |
| is_link() | ファイルがシンボリックリンクかどうかを確認する |
| is_readable() | ファイルが読み取り可能かどうかを確認する |
| is_uploaded_file() | ファイルがHTTP POST経由でアップロードされたかどうかを確認する |
| is_writable() | ファイルが書き込み可能かどうかを確認する |
| is_writeable() | is_writable()のエイリアス |
| lchgrp() | シンボリックリンクのグループ所有権を変更する |
| lchown() | シンボリックリンクの所有者を変更する |
| link() | ハードリンクを作成する |
| linkinfo() | ハードリンクに関する情報を返す |
| lstat() | ファイルまたはシンボリックリンクに関する情報を返す |
| mkdir() | ディレクトリを作成する |
| move_uploaded_file() | アップロードされたファイルを新しい場所に移動する |
| parse_ini_file() | 設定ファイルをパースする |
| parse_ini_string() | 設定文字列をパースする |
| pathinfo() | ファイルパスに関する情報を返す |
| pclose() | popen()によって開かれたパイプを閉じる |
| popen() | パイプを開く |
| readfile() | ファイルを読み込んで出力バッファに書き込む |
| readlink() | シンボリックリンクのターゲットを返す |
| realpath() | 絶対パス名を返す |
| realpath_cache_get() | realpathキャッシュエントリを返す |
| realpath_cache_size() | realpathキャッシュサイズを返す |
| rename() | ファイルまたはディレクトリの名前を変更する |
| rewind() | ファイルポインタを巻き戻す |
| rmdir() | 空のディレクトリを削除する |
| set_file_buffer() | stream_set_write_buffer()のエイリアス。指定されたファイルに対する書き込み操作のためのバッファサイズを設定する |
| stat() | ファイルに関する情報を返す |
| symlink() | シンボリックリンクを作成する |
| tempnam() | 一意の一時ファイルを作成する |
| tmpfile() | 一意の一時ファイルを作成する |
| touch() | ファイルのアクセスおよび修正時刻を設定する |
| umask() | ファイルのパーミッションを変更する |
| unlink() | ファイルを削除する |