【PHP8.x】PharFileInfo::getOwner()メソッドの使い方

Copy
1<?php
2
3/**
4 * PharFileInfo::getOwner メソッドの利用例を示します。
5 * PHARアーカイブを作成し、その中のファイルの所有者ID (UID) を取得します。
6 */
7function demonstratePharFileOwner(): void
8{
9    // テスト用のPHARアーカイブのパスと、アーカイブ内に含めるファイルの名前を定義します。
10    $pharPath = 'example.phar';
11    $fileNameInPhar = 'hello.txt';
12
13    try {
14        // PHARアーカイブ作成の準備 (getOwnerメソッドの動作確認に必要)
15        // 注意: PHARファイルの作成には、php.iniで 'phar.readonly = Off' の設定が必要です。
16        // 'w' モードで新しいPHARアーカイブを作成します。既存のファイルは上書きされます。
17        $phar = new Phar($pharPath, 0, 'example.phar');
18
19        // PHARアーカイブへの書き込み操作を開始します。
20        $phar->startBuffering();
21
22        // アーカイブ内に新しいファイルを追加します。
23        $phar->addFromString($fileNameInPhar, 'Hello from inside the PHAR archive!');
24
25        // PHARのスタブ（実行コード）を設定します。
26        $phar->setStub($phar->createDefaultStub($fileNameInPhar));
27
28        // PHARアーカイブへの書き込み操作を終了し、変更をファイルに保存します。
29        $phar->stopBuffering();
30        echo "PHARアーカイブ '{$pharPath}' を作成し、ファイル '{$fileNameInPhar}' を追加しました。\n";
31
32        // Pharオブジェクトから特定のファイルのエントリ (PharFileInfoインスタンス) を取得します。
33        $pharFileInfo = $phar[$fileNameInPhar];
34
35        // getOwnerメソッドを呼び出し、PHARアーカイブ内のファイルの所有者ID (UID) を取得します。
36        // これは通常、PHARファイルを生成したPHPプロセスを実行しているユーザーのIDになります。
37        $ownerId = $pharFileInfo->getOwner();
38
39        echo "PHARアーカイブ内のファイル '{$fileNameInPhar}' の所有者ID (UID): {$ownerId}\n";
40
41    } catch (Exception $e) {
42        // エラーが発生した場合の処理です。
43        // 特に 'phar.readonly = Off' の設定がない場合によく発生します。
44        echo "エラーが発生しました: " . $e->getMessage() . "\n";
45        echo "PHARファイルの作成には、php.iniで 'phar.readonly = Off' の設定が必須です。\n";
46    } finally {
47        // テスト後に作成したPHARファイルをクリーンアップ (削除) します。
48        // これにより、テスト環境が不要なファイルで汚れるのを防ぎます。
49        if (file_exists($pharPath)) {
50            $phar = null; // Pharオブジェクトを解放してからファイルを削除します。
51            unlink($pharPath);
52            echo "PHARアーカイブ '{$pharPath}' を削除しました。\n";
53        }
54    }
55}
56
57// サンプルコードの実行
58demonstratePharFileOwner();

PharFileInfo::getOwnerメソッドは、PHPのPhar（PHP Archive）ファイル内に格納されている特定のファイルの所有者ID (UID) を取得するために使用されます。このメソッドは引数を一切必要とせず、ファイルの所有者を示す整数値（int型）を返します。返されるIDは、通常、PHARアーカイブを作成したPHPプロセスが実行されているシステム上のユーザーIDに対応します。

サンプルコードでは、まずPharクラスを用いてexample.pharというPHARアーカイブを作成し、その中にhello.txtというテキストファイルを追加しています。PHARアーカイブが作成された後、$phar[$fileNameInPhar]という形式でhello.txtファイルに対応するPharFileInfoオブジェクトを取得します。このPharFileInfoオブジェクトに対してgetOwner()メソッドを呼び出すことで、アーカイブ内のhello.txtの所有者IDが取得され、その結果が画面に表示されます。

このメソッドを使うことで、PHARアーカイブに含まれる各ファイルのメタデータ（所有者情報など）をプログラムから確認できるようになります。PHARアーカイブの作成には、PHPの設定ファイルphp.iniでphar.readonly = Offを設定する必要がある点に注意してください。

Copy
1<?php
2
3/**
4 * Demonstrates the use of PharFileInfo::getOwner() and get_object_vars()
5 * with a temporary Phar archive.
6 *
7 * This function creates a temporary Phar archive, adds a dummy file to it,
8 * retrieves the PharFileInfo object for that file, then uses getOwner()
9 * to get its owner UID and get_object_vars() to inspect its internal properties.
10 *
11 * It's designed to be standalone and includes cleanup for temporary files.
12 */
13function demonstratePharFileInspection(): void
14{
15    // Define paths for the temporary Phar archive and a dummy file.
16    $pharPath = __DIR__ . '/temp_archive.phar';
17    $dummyFilePath = __DIR__ . '/dummy_file.txt';
18    $fileNameInPhar = 'my_test_file.txt';
19
20    // --- Cleanup function to ensure temporary files are removed ---
21    // This function is registered to execute when the script finishes or exits,
22    // guaranteeing that temporary files are cleaned up.
23    register_shutdown_function(function() use ($pharPath, $dummyFilePath) {
24        if (file_exists($dummyFilePath)) {
25            @unlink($dummyFilePath); // Delete the dummy source file
26        }
27        // Use Phar::unlinkArchive to safely remove the Phar file.
28        // This method handles closing the archive before attempting to delete it.
29        if (file_exists($pharPath)) {
30            try {
31                Phar::unlinkArchive($pharPath);
32                echo "Cleaned up temporary Phar archive: {$pharPath}\n";
33            } catch (Throwable $e) {
34                // Suppress errors if unlinking fails (e.g., file locked or permission issues)
35                error_log("Failed to clean up Phar archive {$pharPath}: " . $e->getMessage());
36            }
37        }
38    });
39
40    try {
41        // --- Step 1: Create a dummy file to be archived ---
42        file_put_contents($dummyFilePath, 'This is a test file for the Phar archive.');
43        echo "Created dummy file: " . realpath($dummyFilePath) . "\n";
44
45        // --- Step 2: Create a new Phar archive and add the dummy file ---
46        // For creating Phar archives, the 'phar.readonly' setting in php.ini
47        // must be set to 'Off'. This is a security measure.
48        $phar = new Phar($pharPath);
49        // Start buffering for better performance when adding multiple files.
50        $phar->startBuffering();
51        // Add the dummy file to the archive, giving it a name within the archive.
52        $phar->addFile($dummyFilePath, $fileNameInPhar);
53        // Stop buffering to finalize the archive creation.
54        $phar->stopBuffering();
55        echo "Phar archive created successfully at: " . realpath($pharPath) . "\n\n";
56
57        // Explicitly unset the Phar object to release the file handle.
58        // This is crucial to ensure the archive can be opened by another Phar object
59        // or successfully unlinked by the shutdown function.
60        unset($phar);
61
62        // --- Step 3: Access the Phar archive and retrieve the PharFileInfo object ---
63        // Open the newly created archive in read mode.
64        $pharReader = new Phar($pharPath);
65        // Accessing a file within the Phar archive using array-like syntax
66        // returns a PharFileInfo object, which holds information about that file.
67        $fileInfo = $pharReader[$fileNameInPhar];
68
69        if ($fileInfo instanceof PharFileInfo) {
70            echo "Successfully retrieved PharFileInfo object for '{$fileNameInPhar}'.\n";
71
72            // --- Step 4: Demonstrate PharFileInfo::getOwner() ---
73            // The getOwner() method returns the UID (User ID) of the file's owner
74            // as stored within the Phar archive's metadata.
75            // On Windows systems, this value might often be 0 or the effective
76            // user's UID, as Windows filesystems typically don't use Unix-like UIDs/GIDs.
77            $ownerUid = $fileInfo->getOwner();
78            echo "Owner UID of '{$fileNameInPhar}' within the archive: " . $ownerUid . "\n";
79            echo "(Note: The specific UID value depends on the operating system and how the archive was created.)\n\n";
80
81            // --- Step 5: Demonstrate get_object_vars() on the PharFileInfo object ---
82            // get_object_vars() is a useful function for beginners to inspect
83            // the internal state of an object. It returns an associative array
84            // of all public, protected, and private properties of the given object.
85            // This provides insight into what data the PharFileInfo object encapsulates.
86            echo "Inspecting the PharFileInfo object's properties with get_object_vars():\n";
87            $objectVars = get_object_vars($fileInfo);
88            print_r($objectVars);
89            echo "\n";
90
91        } else {
92            echo "Error: Could not retrieve PharFileInfo object for '{$fileNameInPhar}'.\n";
93        }
94
95    } catch (PharException $e) {
96        // Catch specific exceptions related to Phar operations.
97        echo "An error occurred during Phar operations: " . $e->getMessage() . "\n";
98        echo "Hint: For creating Phar archives, ensure 'phar.readonly' is set to 'Off' in your php.ini.\n";
99        echo "You can temporarily override this for CLI scripts like: `php -d phar.readonly=0 your_script.php`\n";
100    } catch (Throwable $e) {
101        // Catch any other general exceptions for robust error handling.
102        echo "An unexpected error occurred: " . $e->getMessage() . "\n";
103    }
104}
105
106// Execute the demonstration function.
107demonstratePharFileInspection();

このコードは、PHPのPharFileInfo::getOwner()メソッドとget_object_vars()関数の使い方を、システムエンジニアを目指す初心者向けに示しています。

まず、一時的なPharアーカイブ（複数のファイルをまとめた単一のファイル）を作成し、ダミーファイルを追加します。その後、アーカイブ内のファイルに対応するPharFileInfoオブジェクトを取得します。このオブジェクトは、アーカイブ内のファイルに関する詳細な情報を持っています。

PharFileInfo::getOwner()メソッドは引数なしで呼び出され、アーカイブ内に記録されたファイルの所有者UID（ユーザーID）を整数値（int）で返します。このUIDはファイルを作成したユーザーの識別子であり、実行環境によって値が異なります。

get_object_vars()関数は、オブジェクトの内部状態を調べる際に非常に便利です。この関数にPharFileInfoオブジェクトを渡すと、そのオブジェクトが持つすべてのプロパティ（内部的なデータ）を連想配列として返します。これにより、オブジェクトがどのような情報を持っているかを初心者でも具体的に把握できます。

コードは作成した一時ファイルやPharアーカイブを自動的にクリーンアップするため、安心して試すことができます。