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

Copy
1<?php
2
3/**
4 * Pharアーカイブ内のファイルのパーミッションを変更するサンプルコード
5 *
6 * この関数は、Pharアーカイブを作成し、その中にファイルを格納し、
7 * その格納されたファイルのパーミッションを0777に変更する方法を示します。
8 * システムエンジニアを目指す初心者向けに、各ステップを簡潔に解説します。
9 */
10function demonstratePharChmod(): void
11{
12    // Phar拡張が有効か確認します。無効な場合は処理を中断します。
13    if (!extension_loaded('phar')) {
14        echo "エラー: Phar拡張が有効になっていません。php.iniで有効にしてください。\n";
15        exit(1);
16    }
17
18    // Pharアーカイブファイル名と、アーカイブ内のファイル名を定義します。
19    $archiveName = 'my_example.phar';
20    $fileNameInArchive = 'example_file.txt';
21    $archivePath = __DIR__ . '/' . $archiveName; // アーカイブの絶対パス
22
23    // Pharアーカイブへの書き込みを許可するため、一時的に設定を変更します。
24    // 通常はphp.iniで 'phar.readonly = Off' を設定しますが、スクリプト内で一時的に変更することも可能です。
25    // 注意: 本番環境ではセキュリティリスクを考慮し、この設定を適切に管理してください。
26    ini_set('phar.readonly', 'Off');
27
28    // 以前のテスト実行で残ったPharファイルがあれば削除します。
29    if (file_exists($archivePath)) {
30        unlink($archivePath);
31        echo "既存のPharアーカイブ '{$archiveName}' を削除しました。\n";
32    }
33
34    try {
35        // 1. 新しいPharアーカイブを作成します。
36        // 引数には、作成するPharアーカイブのパスを指定します。
37        $phar = new Phar($archivePath);
38
39        // 2. Pharアーカイブへの変更をバッファリングし、ファイルを格納します。
40        // startBuffering() から stopBuffering() の間の変更は一度に書き込まれます。
41        $phar->startBuffering();
42        $phar->addFromString($fileNameInArchive, "このテキストはPharアーカイブ内に保存されています。\n");
43        $phar->stopBuffering(); // バッファリングを終了し、変更をPharファイルに書き込みます。
44
45        echo "Pharアーカイブ '{$archiveName}' を作成し、ファイル '{$fileNameInArchive}' を追加しました。\n";
46
47        // 3. 格納したファイルのPharFileInfoオブジェクトを取得します。
48        // これにより、Pharアーカイブ内の個々のファイル情報を操作できます。
49        /** @var PharFileInfo $fileInfo */
50        $fileInfo = $phar[$fileNameInArchive];
51
52        // 4. 変更前のファイルのパーミッションを表示します。
53        // getPerms() はファイルタイプ情報も含むため、& 0777 でパーミッション部分のみを抽出します。
54        // decoct() で8進数表記に変換し、一般的なパーミッション形式で表示します。
55        $oldPerms = $fileInfo->getPerms() & 0777;
56        echo "変更前のパーミッション: " . decoct($oldPerms) . " (例: 644 など)\n";
57
58        // 5. PharFileInfo::chmod() メソッドを使用してパーミッションを変更します。
59        // 引数には8進数でパーミッションを指定します。0777 は読み書き実行を全て許可する設定です。
60        echo "パーミッションを 0777 (読み書き実行を全て許可) に変更します。\n";
61        $fileInfo->chmod(0777);
62
63        // 6. 変更後のファイルのパーミッションを表示し、変更が適用されたことを確認します。
64        // chmod実行後、同じ$fileInfoオブジェクトから新しいパーミッションが取得できます。
65        $newPerms = $fileInfo->getPerms() & 0777;
66        echo "変更後のパーミッション: " . decoct($newPerms) . "\n";
67
68    } catch (Exception $e) {
69        // エラーが発生した場合、メッセージを表示します。
70        echo "エラーが発生しました: " . $e->getMessage() . "\n";
71    } finally {
72        // 後処理: 作成したPharアーカイブファイルを削除します。
73        // Pharオブジェクトがまだメモリ上にある場合、ファイルを削除できないことがあるため、
74        // unset($phar) で明示的にオブジェクトを破棄することが推奨されますが、
75        // この関数のスコープ外に出ることで自動的に破棄されます。
76        if (file_exists($archivePath)) {
77            if (unlink($archivePath)) {
78                echo "後処理: Pharアーカイブ '{$archiveName}' を削除しました。\n";
79            } else {
80                echo "後処理: Pharアーカイブ '{$archiveName}' の削除に失敗しました。ファイルがロックされている可能性があります。\n";
81            }
82        }
83    }
84}
85
86// サンプル関数を実行します。
87demonstratePharChmod();
88

このサンプルコードは、PHPのPharFileInfo::chmodメソッドを使って、Pharアーカイブ内のファイルのパーミッションを変更する方法を示しています。Phar拡張は、複数のファイルを一つの実行可能なアーカイブにまとめる機能を提供し、このメソッドはそのアーカイブ内に格納された個別のファイルのアクセス権限を管理する際に役立ちます。

コードではまず、新しいPharアーカイブを作成し、その中にexample_file.txtというファイルを格納します。次に、この格納されたファイルに対応するPharFileInfoオブジェクトを取得します。このオブジェクトのchmodメソッドに、引数int $permsとして変更したいパーミッションを8進数で指定します。例えば、0777と指定すると、そのファイルに対して読み書き実行の全ての権限を許可する設定に変更されます。このchmodメソッド自体は、特に戻り値を返しません。変更が適用されたかどうかは、メソッド実行後に再度ファイルのパーミッションを確認することで検証できます。Pharアーカイブへの書き込み操作を行うには、phar.readonly設定を一時的にOffにする必要がある点も、システムエンジニアが理解しておくべき重要なポイントです。このコードを通じて、Phar形式のアプリケーション内部ファイルのアクセス権限を操作・管理する方法を学ぶことができます。

Copy
1<?php
2
3/**
4 * PharFileInfo::chmod メソッドの動作を実演する関数。
5 * 特に、Pharアーカイブが読み取り専用の場合に chmod が「効かない」状況を示します。
6 */
7function demonstratePharChmod(): void
8{
9    // 一時的なPharアーカイブのファイル名とエイリアス名を定義
10    $pharFileName = __DIR__ . '/temp_test.phar';
11    $pharAlias = 'my_temp_phar_alias'; // Phar::loadPhar で使うエイリアス
12    $innerFileName = 'test_file.txt'; // Pharアーカイブ内に作成するファイル名
13
14    try {
15        // --- 事前準備: 既存のPharファイルを削除し、新しいPharアーカイブを作成 ---
16        if (file_exists($pharFileName)) {
17            unlink($pharFileName); // 既存のファイルがあれば削除
18        }
19
20        // Pharアーカイブを新規作成モードで開く
21        // Phar::CREATE: アーカイブが存在しない場合は作成
22        // Phar::OVERWRITE: 既存のアーカイブを上書き（ここでは初回作成のため不要だが安全策として）
23        $phar = new Phar($pharFileName, Phar::CREATE | Phar::OVERWRITE, basename($pharFileName));
24        $phar->startBuffering(); // 変更をバッファリングし、効率的に書き込む
25        $phar->addFromString($innerFileName, "This is a test file inside the phar archive.\n");
26        echo "Pharアーカイブ '$pharFileName' を作成し、'$innerFileName' を追加しました。\n";
27        $phar->stopBuffering(); // バッファリングを終了し、変更をPharファイルに書き込む
28        $phar = null; // Pharオブジェクトを解放し、ファイルロックを解除
29
30        // --- 成功例: 書き込み可能なPharアーカイブ内のパーミッション変更 ---
31        echo "\n--- 成功例: 書き込み可能なPharアーカイブ内のパーミッション変更 ---\n";
32        
33        // 既存のPharアーカイブを書き込み可能モードで開く
34        // new Phar($pharFileName) は、既存ファイルに対してデフォルトで書き込み可能モードで開かれることが多いです。
35        $pharWritable = new Phar($pharFileName);
36        $pharWritable->startBuffering(); // 変更をバッファリングする
37
38        // 内部ファイルの初期パーミッションを取得
39        $fileInfo = $pharWritable->getStat($innerFileName);
40        if ($fileInfo === false) {
41            throw new Exception("ファイル情報が取得できませんでした。");
42        }
43        echo "初期パーミッション: " . decoct($fileInfo['perms'] & 0777) . "\n";
44
45        // パーミッションを 0644 (rw-r--r--) に変更
46        $targetPermsWritable = 0644;
47        $pharEntry = $pharWritable->getPharFileInfo($innerFileName);
48        $pharEntry->chmod($targetPermsWritable);
49        echo "内部ファイル '$innerFileName' のパーミッションを " . decoct($targetPermsWritable) . " に変更しました。\n";
50
51        // 変更後のパーミッションを取得して確認
52        $fileInfoAfter = $pharWritable->getStat($innerFileName);
53        echo "変更後のパーミッション: " . decoct($fileInfoAfter['perms'] & 0777) . "\n";
54        
55        $pharWritable->stopBuffering(); // バッファリングを終了し、変更をPharファイルに書き込む
56        $pharWritable = null; // Pharオブジェクトを解放
57
58        // --- 失敗例: 読み取り専用Pharアーカイブで chmod が「効かない」状況 ---
59        echo "\n--- 失敗例: 読み取り専用Pharアーカイブ内のパーミッション変更 (キーワード「効かない」) ---\n";
60        
61        // Pharアーカイブを読み取り専用としてロード
62        // Phar::loadPhar() はアーカイブを読み取り専用でメモリにロードし、エイリアスを設定します。
63        Phar::loadPhar($pharFileName, $pharAlias);
64        // ロードされたエイリアスを使ってPharオブジェクトにアクセス
65        // このPharオブジェクトは読み取り専用モードで動作します。
66        $pharReadonly = new Phar($pharAlias);
67
68        try {
69            // パーミッションを 0755 (rwxr-xr-x) に変更を試みる
70            $targetPermsReadonly = 0755;
71            echo "読み取り専用Phar内の '$innerFileName' のパーミッションを " . decoct($targetPermsReadonly) . " に変更を試みます...\n";
72            
73            // 読み取り専用Pharに対する chmod() は PharException をスローします
74            $pharReadonly->getPharFileInfo($innerFileName)->chmod($targetPermsReadonly);
75            echo "エラー: 読み取り専用Pharに対するchmodが成功してしまいました。\n"; // ここには到達しないはず
76        } catch (PharException $e) {
77            echo "想定通り、PharExceptionが発生しました。読み取り専用のPharアーカイブではパーミッションを変更できません。\n";
78            echo "エラーメッセージ: " . $e->getMessage() . "\n";
79        } finally {
80            // ロードしたPharアーカイブをメモリからアンロード
81            Phar::unlinkPhar($pharAlias);
82        }
83
84    } catch (Exception $e) {
85        // 処理中に予期せぬエラーが発生した場合のハンドリング
86        echo "処理中に致命的なエラーが発生しました: " . $e->getMessage() . "\n";
87    } finally {
88        // --- 後処理: 一時的なPharアーカイブファイルを削除 ---
89        if (file_exists($pharFileName)) {
90            unlink($pharFileName);
91            echo "\nPharアーカイブ '$pharFileName' を削除しました。\n";
92        }
93    }
94}
95
96// demonstratePharChmod 関数を実行して、PharFileInfo::chmod の動作を確認します。
97demonstratePharChmod();
98

PharFileInfo::chmodは、PHPのPharアーカイブ（複数のファイルを一つにまとめた形式）内に格納された個々のファイルのパーミッション（アクセス権限）を変更するために使用されるメソッドです。引数$permsには、変更したいパーミッションを8進数（例: 0644は読み書き権限）で指定します。このメソッドは処理が成功しても特に値を返しません。

サンプルコードでは、chmodの動作を二つのケースで実演しています。まず、新規作成したPharアーカイブ内のファイルに対して、書き込み可能な状態でchmodを実行する成功例を示しています。この場合、指定されたパーミッションに正しく変更され、変更前後のパーミッション値を確認できます。

次に、「php chmod 効かない」というキーワードに関連する失敗例として、Pharアーカイブを読み取り専用モードでロードした場合の動作を示します。読み取り専用のPharアーカイブ内のファイルに対してchmodを実行しようとすると、PharExceptionが発生し、パーミッションの変更ができないことが明確に示されます。これは、読み取り専用のPharは一度作成されると内容の変更が許されないというPharのセキュリティ上の特性によるものです。したがって、PharFileInfo::chmodメソッドは、Pharアーカイブが書き込み可能なモードで開かれている場合にのみ機能します。