【PHP8.x】is_writeable関数の使い方

Copy
1<?php
2
3// is_writeable関数の使い方を示すサンプルコードです。
4// この関数は、指定されたファイルがPHPを実行しているユーザーによって書き込み可能かどうかをチェックします。
5// 書き込み可能であれば true、そうでなければ false を返します。
6
7// チェック対象のファイルパスを指定します。
8// キーワード「index php」を考慮し、現在のスクリプトと同じディレクトリにある「index.php」ファイルを対象とします。
9// 実際のアプリケーションでは、ログファイル、アップロードディレクトリ、設定ファイルなど、
10// PHPが書き込みを行う必要のあるファイルを指定することが一般的です。
11$targetFilePath = __DIR__ . '/index.php';
12
13// is_writeable関数を呼び出して、ファイルが書き込み可能かを確認します。
14// この関数は、指定されたファイルが存在しない場合も false を返します。
15if (is_writeable($targetFilePath)) {
16    echo "ファイル '{$targetFilePath}' はPHPによって書き込み可能です。\n";
17    echo "これは、PHPを実行しているユーザー（通常はWebサーバーのユーザー、例: 'www-data'や'apache'）が、\n";
18    echo "このファイルへの変更や保存を行うための適切な権限を持っていることを意味します。\n";
19    // ファイルパーミッションにおいて、PHPユーザーがファイルの所有者であるか、
20    // あるいはファイルが属するグループの一員であり、そのグループに書き込み権限がある場合（'by group'）、
21    // この関数は true を返します。
22} else {
23    echo "ファイル '{$targetFilePath}' はPHPによって書き込み不可能か、または存在しません。\n";
24    echo "PHPはこのファイルにデータを保存したり、変更したりすることができません。\n";
25    echo "もし書き込みが必要な場合は、ファイルのパーミッション（例: chmodコマンド）や所有者を\n";
26    echo "PHPを実行するユーザーに合わせて調整する必要があります。\n";
27}
28
29?>

PHPのis_writeable関数は、指定されたファイルやディレクトリが、PHPを実行しているユーザーによって書き込み可能かどうかをチェックするために使用されます。

この関数は、引数としてチェックしたいファイルまたはディレクトリのパスをstring型で受け取ります。そして、PHPがそのパスに対してデータを書き込んだり、変更したりする権限がある場合にtrueを、そうでない場合にはfalseをbool型で返します。指定されたファイルが存在しない場合もfalseが返される点に注意が必要です。

例えば、現在のスクリプトと同じディレクトリにあるindex.phpファイルに対し、is_writeable(__DIR__ . '/index.php')のように使用します。もしPHPを実行するWebサーバーユーザー（例えばwww-dataやapacheなど）が、このファイルに書き込む権限を持っていればtrueが返されます。これは、ファイルのパーミッション設定において、PHPユーザーがファイルの所有者であるか、あるいはファイルが属するグループの一員であり、そのグループに書き込み権限が与えられている場合（キーワードの「by group」に該当）などに該当します。

もしfalseが返された場合、PHPはそのファイルにデータを保存したり、変更したりすることができません。書き込みが必要な状況でfalseが返された場合は、ファイルのパーミッション（権限）を調整するか、ファイルの所有者をPHPを実行するユーザーに合わせるなどの対応が必要です。この関数は、ログファイルやアップロードディレクトリなど、PHPが動的にデータを生成・保存する際に、事前に書き込み可否を確認する目的で役立ちます。