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

Copy
1<?php
2
3/**
4 * PharFileInfo::getFilename() メソッドの使用例。
5 * Pharアーカイブ内のファイル名を取得する方法を示します。
6 *
7 * このスクリプトは以下の手順で動作します。
8 * 1. 一時的なPharアーカイブを作成し、テストファイルを追加します。
9 * 2. 作成したPharアーカイブを開き、特定のファイルに対応するPharFileInfoオブジェクトを取得します。
10 * 3. getFilename() メソッドを呼び出してファイル名を取得し、表示します。
11 * 4. 最後に、作成したPharアーカイブを削除してクリーンアップします。
12 */
13
14// 一時的なPharアーカイブのファイルパスを定義
15$pharFileName = __DIR__ . '/example_archive.phar';
16// Pharアーカイブ内に追加するテストファイルの名前
17$internalFileName = 'my_document.txt';
18// テストファイルの内容
19$fileContent = 'これはPharアーカイブ内のテストファイルです。';
20
21try {
22    // --- 1. 一時的なPharアーカイブを作成し、テストファイルを追加する ---
23
24    // 以前のPharアーカイブが存在する場合は削除し、クリーンな状態にする
25    if (file_exists($pharFileName)) {
26        Phar::unlinkArchive($pharFileName);
27        echo "既存のPharアーカイブ '{$pharFileName}' を削除しました。\n";
28    }
29
30    // 新しいPharアーカイブを作成（読み書きモード）
31    // 第二引数: ファイルを作成する際に使用するファイルアクセス権限のビットマスク (0はデフォルト)
32    // 第三引数: マニフェストに格納されるアーカイブのエイリアス (省略可能だが推奨)
33    $phar = new Phar($pharFileName, 0, basename($pharFileName));
34    
35    // Pharアーカイブのデフォルトスタブを設定（必須ではないが、実行可能Pharの基本）
36    // スタブはPharをPHPスクリプトとして実行する際のエントリポイント
37    $phar->setStub($phar->createDefaultStub($internalFileName));
38
39    // テストファイルの内容をPharアーカイブに追加
40    $phar->addFromString($internalFileName, $fileContent);
41    echo "Pharアーカイブ '{$pharFileName}' を作成し、'{$internalFileName}' を追加しました。\n";
42
43    // Pharアーカイブへの書き込みを完了するために、オブジェクトを解放する
44    unset($phar);
45
46    // --- 2. 作成したPharアーカイブを開き、PharFileInfoオブジェクトを取得する ---
47
48    // 作成したPharアーカイブを読み込みモードで開く
49    $phar = new Phar($pharFileName);
50
51    // Pharアーカイブ内の特定のファイルに対応するPharFileInfoオブジェクトを取得
52    // 配列アクセス（オフセットアクセス）を使用して、ファイルパスを指定して取得できます。
53    $fileInfo = $phar[$internalFileName];
54    echo "Pharアーカイブから '{$internalFileName}' のPharFileInfoオブジェクトを取得しました。\n";
55
56    // --- 3. getFilename() メソッドを使用して、ファイル名を取得する ---
57
58    // PharFileInfoオブジェクトから、アーカイブ内でのファイル名を取得
59    $filename = $fileInfo->getFilename();
60
61    // --- 4. 取得したファイル名を表示する ---
62
63    echo "取得したファイル名: " . $filename . "\n";
64
65} catch (Exception $e) {
66    // Phar操作中にエラーが発生した場合
67    echo "エラーが発生しました: " . $e->getMessage() . "\n";
68} finally {
69    // --- 5. クリーンアップ: 作成したPharアーカイブを削除する ---
70
71    // Pharアーカイブファイルが存在する場合のみ削除
72    if (file_exists($pharFileName)) {
73        // Phar::unlinkArchive() は、Pharアーカイブを安全に削除するための推奨される方法です。
74        Phar::unlinkArchive($pharFileName);
75        echo "一時的なPharアーカイブ '{$pharFileName}' を削除しました。\n";
76    }
77}

PharFileInfo::getFilename()メソッドは、PHPのPharアーカイブ内で管理されている特定のファイルやディレクトリの名前を文字列として取得するために使用されます。Pharは複数のファイルを一つのアーカイブとしてまとめる機能を提供し、PharFileInfoクラスはそのアーカイブ内の個々の要素（ファイルやディレクトリ）の詳細情報にアクセスするためのオブジェクトです。

このメソッドは引数を一切受け取らず、Pharアーカイブ内でのファイル名を正確に表す文字列を返します。例えば、提供されたサンプルコードでは、まず一時的なPharアーカイブを作成し、「my_document.txt」というテストファイルを追加しています。その後、作成したアーカイブを開き、追加したファイルに対応するPharFileInfoオブジェクトを取得します。このオブジェクトに対してgetFilename()メソッドを呼び出すことで、「my_document.txt」というファイル名を取得し、画面に表示しています。

システムエンジニアとしてPharアーカイブを扱う際には、内部のファイルの情報を正確に取得することが重要になります。getFilename()は、Pharアーカイブ内のファイルパスからファイル名部分だけを抽出する際に役立ち、ファイルの処理や表示を行う上で基本的な情報を提供します。最終的に、作成した一時的なアーカイブは安全に削除され、リソースが適切に管理されます。

Copy
1<?php
2
3// このコードは、PHPのPhar拡張機能を使用してアーカイブファイル（.phar）を作成し、
4// その中の各ファイル情報からファイル名を取得する方法を示します。
5// PharFileInfo::getFilename()は、Pharアーカイブ内のファイル名を返します。
6// これは、通常のファイルパスからファイル名を取得するbasename()とは異なり、
7// Pharアーカイブ内部のファイル構造におけるファイル名を扱います。
8
9// 一時的なファイル名とPharアーカイブ名を定義します。
10$pharFileName = 'example_archive.phar';
11$file1Name = 'dummy_file_1.txt';
12$file2RelativePath = 'sub/dummy_file_2.txt'; // Pharアーカイブ内のサブフォルダを示すパス
13
14// --- 1. Pharアーカイブに含めるダミーファイルを作成します ---
15echo "Pharアーカイブに含めるダミーファイルを作成中...\n";
16
17// 最初のダミーファイルを作成
18file_put_contents($file1Name, 'これはダミーファイル1の内容です。');
19
20// サブディレクトリを作成し、2番目のダミーファイルを作成します。
21// ディレクトリが存在しない場合は作成します。
22$subDirectory = dirname($file2RelativePath);
23if (!is_dir($subDirectory)) {
24    mkdir($subDirectory, 0777, true);
25}
26file_put_contents($file2RelativePath, 'これはダミーファイル2の内容です。');
27
28try {
29    // --- 2. 新しいPharアーカイブを作成します ---
30    // 注意: Pharアーカイブを作成するには、php.iniで 'phar.readonly = 0' に設定する必要があります。
31    // この例では書き込み可能であることを前提としています。
32    echo "新しいPharアーカイブ '{$pharFileName}' を作成中...\n";
33    $phar = new Phar($pharFileName);
34
35    // Pharアーカイブへの変更をバッファリングし、効率的に書き込みます。
36    $phar->startBuffering();
37
38    // ダミーファイルをPharアーカイブに追加します。
39    // addFile()の第2引数で、Pharアーカイブ内でのパス/ファイル名を指定できます。
40    $phar->addFile($file1Name, $file1Name); // 外部ファイル名とPhar内の名前を同じにする
41    $phar->addFile($file2RelativePath, $file2RelativePath); // 外部パスとPhar内のパスを同じにする
42
43    // バッファリングを終了し、変更をPharアーカイブに書き込みます。
44    $phar->stopBuffering();
45    echo "Pharアーカイブ '{$pharFileName}' が正常に作成されました。\n";
46
47    // --- 3. 作成されたPharアーカイブを開き、内容を読み取ります ---
48    echo "\nPharアーカイブ内のファイルをリストアップし、そのファイル名 (getFilename()) を表示します:\n";
49    $pharArchive = new Phar($pharFileName);
50
51    // Pharアーカイブ内のすべてのエントリを反復処理します
52    foreach ($pharArchive as $internalPath => $fileInfo) {
53        // $fileInfoはPharFileInfoのインスタンスです。
54        if ($fileInfo instanceof PharFileInfo) {
55            // Pharアーカイブ内の現在のエントリのファイル名を取得します。
56            // これは、アーカイブ内部パスの末尾にあるファイル名を返します。
57            $filename = $fileInfo->getFilename();
58
59            echo "- アーカイブ内部パス: '{$internalPath}' -> ファイル名 (getFilename()): '{$filename}'\n";
60        }
61    }
62
63} catch (PharException $e) {
64    echo "Pharアーカイブの作成または読み取り中にエラーが発生しました: " . $e->getMessage() . "\n";
65    echo "Pharアーカイブを作成する場合は、php.iniで 'phar.readonly = 0' に設定されていることを確認してください。\n";
66} finally {
67    // --- 4. クリーンアップ: 一時ファイルとPharアーカイブを削除します ---
68    echo "\n一時ファイルをクリーンアップ中...\n";
69    if (file_exists($file1Name)) {
70        unlink($file1Name);
71    }
72    if (file_exists($file2RelativePath)) {
73        unlink($file2RelativePath);
74    }
75    // サブディレクトリが空の場合のみ削除します。
76    if (is_dir($subDirectory) && !(new \FilesystemIterator($subDirectory))->valid()) {
77        rmdir($subDirectory);
78    }
79    // Pharアーカイブが存在する場合は削除します。
80    if (file_exists($pharFileName)) {
81        unlink($pharFileName);
82    }
83    echo "クリーンアップ完了。\n";
84}
85

PharFileInfo::getFilename()は、PHPのPhar拡張機能によって作成されたアーカイブファイル（.phar）の内部にある個々のファイル情報（PharFileInfoオブジェクト）から、そのファイル名を取得するためのメソッドです。このメソッドは引数を必要とせず、該当するアーカイブ内のファイル名を文字列型で返します。

通常のファイルシステムでパスからファイル名を取得するbasename()関数とは異なり、PharFileInfo::getFilename()はPharアーカイブ内部のファイルパスにおける末尾のファイル名を扱います。例えば、「sub/dummy_file.txt」のようなPharアーカイブ内のパスに対しては、「dummy_file.txt」というファイル名を返します。

提供されたサンプルコードでは、まず一時的なダミーファイルを準備し、それらを「example_archive.phar」というPharアーカイブに格納します。その後、作成されたPharアーカイブを読み込み専用で開き、アーカイブ内に含まれるすべてのファイルやディレクトリのエントリを一つずつ処理します。各エントリがPharFileInfoオブジェクトである場合、getFilename()メソッドを呼び出すことで、そのアーカイブ内部における純粋なファイル名を正確に取得し、画面に表示しています。これにより、Pharアーカイブの内容をプログラム的に確認し、個々のファイル名を効率的に抽出する方法を学ぶことができます。