【PHP8.x】fileowner()関数の使い方

Copy
1<?php
2
3// 一時ファイルの名前を定義します。
4$filename = 'example_file_for_owner.txt';
5
6// テストファイルを作成し、内容を書き込みます。
7// file_put_contents関数はファイルが存在しない場合は作成し、存在する場合は上書きします。
8if (file_put_contents($filename, 'これはファイルの所有者を確認するためのテストファイルです。') === false) {
9    echo "エラー: テストファイルの作成に失敗しました。\n";
10    exit(1); // 処理を終了
11}
12
13echo "テストファイル '{$filename}' を作成しました。\n";
14
15// キーワード「php fileobject」に対応するため、SplFileObject を使用してファイルオブジェクトを作成します。
16// SplFileObject はファイルへのオブジェクト指向インターフェースを提供します。
17try {
18    // 読み込みモード ('r') でファイルオブジェクトを作成します。
19    $fileObject = new SplFileObject($filename, 'r');
20    // SplFileObject からファイルパスを取得します。fileowner関数はファイルパスを引数に取ります。
21    $filePath = $fileObject->getPathname();
22} catch (RuntimeException $e) {
23    // ファイルが見つからない、アクセス権がないなどの場合に例外が発生します。
24    echo "エラー: SplFileObject の作成に失敗しました: " . $e->getMessage() . "\n";
25    unlink($filename); // 作成したファイルを削除してクリーンアップします。
26    exit(1); // 処理を終了
27}
28
29// fileowner 関数を使用して、ファイルの所有者のユーザーID (UID) を取得します。
30// 成功した場合は所有者のUID (整数)、失敗した場合は false を返します。
31$ownerId = fileowner($filePath);
32
33if ($ownerId !== false) {
34    // 所有者IDが取得できた場合
35    echo "ファイル '{$filePath}' の所有者IDは: {$ownerId} です。\n";
36} else {
37    // 所有者IDが取得できなかった場合 (例: ファイルが存在しない、アクセス権限がない)
38    echo "エラー: ファイル '{$filePath}' の所有者情報を取得できませんでした。\n";
39    echo "ファイルが存在しないか、アクセス権限が不足している可能性があります。\n";
40}
41
42// テストファイルを削除してクリーンアップします。
43if (unlink($filename)) {
44    echo "テストファイル '{$filename}' を削除しました。\n";
45} else {
46    echo "エラー: テストファイル '{$filename}' の削除に失敗しました。\n";
47}
48
49?>

このPHPコードは、指定したファイルの所有者ユーザーID（UID）を取得する方法を示しています。まず、一時的にテストファイルを作成し、そのファイル名を定義します。次に、キーワード「php fileobject」に対応するため、SplFileObjectクラスを使用してファイルへのオブジェクト指向インターフェースを生成し、そこからファイルのパスを取得します。

fileowner関数は、引数としてファイルのパス（文字列）を受け取ります。この関数は、成功するとファイルの所有者のユーザーID（整数値）を返します。もしファイルが存在しない、またはアクセス権限がないなどの理由で所有者情報を取得できなかった場合は、falseを返します。

コードでは、取得した所有者IDがfalseでないことを確認し、成功した場合はそのIDを表示します。falseが返された場合は、エラーメッセージとともにファイルが存在しないか、アクセス権限が不足している可能性をユーザーに伝えます。処理の最後には、作成したテストファイルを削除してクリーンアップを行っています。

Copy
1<?php
2
3/**
4 * 指定されたファイルの所有者UIDを取得し、コンソールに出力します。
5 * ファイルが存在しない場合や、所有者情報の取得に失敗した場合はエラーメッセージを出力します。
6 *
7 * @param string $filename 検査するファイルのパス。
8 */
9function displayFileOwner(string $filename): void
10{
11    // ファイルが存在するか確認します。
12    // fileowner関数はファイルが存在しない場合はエラーを返す可能性があるため、事前にチェックすることが推奨されます。
13    if (!file_exists($filename)) {
14        echo "エラー: ファイル '{$filename}' が見つかりません。\n";
15        return;
16    }
17
18    // fileowner関数を使用してファイルの所有者UID（ユーザーID）を取得します。
19    // 成功した場合はint型のUIDを、失敗した場合はfalseを返します。
20    $ownerId = fileowner($filename);
21
22    if ($ownerId === false) {
23        // 所有者情報の取得に失敗した場合の処理
24        echo "エラー: ファイル '{$filename}' の所有者情報を取得できませんでした。\n";
25        echo "  (パーミッションの問題か、ファイルが存在しない可能性があります)\n";
26    } else {
27        // 成功した場合の処理
28        echo "ファイル '{$filename}' の所有者UID: {$ownerId}\n";
29    }
30}
31
32// --- サンプルコードの実行 ---
33
34// 1. テスト用のファイルパスを定義します。
35$testFilename = 'example_file_owner_test.txt';
36
37// 2. fileowner関数は既存のファイルに対して動作するため、まずファイルを生成します。
38// file_put_contentsはファイルに内容を書き込む関数です。
39// 成功すれば書き込まれたバイト数を、失敗すれば false を返します。
40if (file_put_contents($testFilename, 'This is a temporary file for testing fileowner function.') === false) {
41    echo "エラー: テストファイルの作成に失敗しました。\n";
42    exit(1); // スクリプトを終了します
43}
44echo "テストファイル '{$testFilename}' を作成しました。\n\n";
45
46// 3. 作成したファイルの所有者情報を表示します。
47displayFileOwner($testFilename);
48
49echo "\n--- 存在しないファイルの場合の確認 ---\n";
50// 4. 存在しないファイルに対してdisplayFileOwner関数を呼び出した場合の動作を確認します。
51displayFileOwner('non_existent_file_for_test.txt');
52
53// 5. テスト完了後、作成したファイルをクリーンアップ（削除）します。
54// unlinkはファイルを削除する関数です。
55// 成功すれば true を、失敗すれば false を返します。
56if (unlink($testFilename)) {
57    echo "\nテストファイル '{$testFilename}' を削除しました。\n";
58} else {
59    echo "\nエラー: テストファイル '{$testFilename}' の削除に失敗しました。\n";
60}
61
62?>

PHPのfileowner関数は、指定されたファイルの所有者ID（UID）を取得します。この関数は、ファイルシステムのアクセス権限を理解するのに役立つ関数です。

引数には検査するファイルのパスを文字列（$filename）で渡します。成功すると、ファイルの所有者UIDを整数値で返します。UIDは、OSがユーザーを識別する数値です。ファイルが存在しない、または情報読み取りの権限がない場合はfalseを返します。そのため、戻り値がfalseでないかを必ず確認し、エラー処理を行ってください。

サンプルコードは、fileowner関数の安全な利用方法を示します。まずfile_existsでファイルの存在を確認し、その後fileownerを呼び出します。結果がfalseならエラーメッセージを、それ以外なら取得したUIDを出力します。テストファイルの作成と削除も含まれており、初心者の方がPHPでファイル情報を取得する基本を実践的に学べます。