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

Copy
1<?php
2
3/**
4 * Pharアーカイブ内のエントリのベース名（ファイル名部分）を取得するサンプルです。
5 *
6 * 注: このスクリプトを実行するには、php.iniで 'phar.readonly = 0' が設定されている必要があります。
7 * または、コマンドラインで 'php -d phar.readonly=0 your_script.php' と実行してください。
8 */
9function demonstratePharEntryBasename(): void
10{
11    // 一時的なPharアーカイブのパスを定義
12    $pharPath = __DIR__ . '/my_temp_archive.phar';
13    $internalFilePath1 = 'dir/subdir/my_document.txt';
14    $internalFilePath2 = 'another_script.php';
15    $internalFilePath3 = 'archive.tar.gz';
16
17    // 既存のPharファイルを削除して、クリーンな状態で開始
18    if (file_exists($pharPath)) {
19        Phar::unlinkArchive($pharPath);
20    }
21
22    $phar = null; // Pharオブジェクトを初期化
23
24    try {
25        // 新しいPharアーカイブを作成
26        // 'my_temp_archive.phar' はアーカイブの内部名です。
27        $phar = new Phar($pharPath, 0, 'my_temp_archive.phar');
28        // Pharアーカイブにはスタブが必要です
29        $phar->setStub('<?php __HALT_COMPILER(); ?>');
30
31        // アーカイブ内にダミーのエントリを追加
32        $phar->addFromString($internalFilePath1, 'Content of document.');
33        $phar->addFromString($internalFilePath2, '<?php echo "Hello, Phar!"; ?>');
34        $phar->addFromString($internalFilePath3, 'Binary data...');
35
36        // Pharアーカイブから特定のファイルの情報を取得 (PharFileInfoオブジェクト)
37        // getBasename() メソッドはPharFileInfoオブジェクトで使用されます。
38        $fileInfo1 = $phar->offsetGet($internalFilePath1);
39        $fileInfo2 = $phar->offsetGet($internalFilePath2);
40        $fileInfo3 = $phar->offsetGet($internalFilePath3);
41
42        echo "--- PharFileInfo::getBasename() の使用例 ---" . PHP_EOL;
43
44        // 1. 引数なしでファイル名部分を取得
45        echo "元のパス: '{$internalFilePath1}'" . PHP_EOL;
46        echo "getBasename(): " . $fileInfo1->getBasename() . PHP_EOL . PHP_EOL;
47
48        // 2. 特定のサフィックスを指定してファイル名部分を取得
49        //    指定したサフィックスがパスの末尾に一致すれば取り除かれます。
50        echo "元のパス: '{$internalFilePath2}'" . PHP_EOL;
51        echo "getBasename('.php'): " . $fileInfo2->getBasename('.php') . PHP_EOL . PHP_EOL;
52
53        // 3. サフィックスが一致しない場合は何も取り除かれない
54        echo "元のパス: '{$internalFilePath2}'" . PHP_EOL;
55        echo "getBasename('.txt'): " . $fileInfo2->getBasename('.txt') . PHP_EOL . PHP_EOL;
56
57        // 4. 複数のサフィックスを持つファイル名からの取得
58        echo "元のパス: '{$internalFilePath3}'" . PHP_EOL;
59        echo "getBasename(): " . $fileInfo3->getBasename() . PHP_EOL;
60        echo "getBasename('.gz'): " . $fileInfo3->getBasename('.gz') . PHP_EOL;
61        echo "getBasename('.tar.gz'): " . $fileInfo3->getBasename('.tar.gz') . PHP_EOL . PHP_EOL;
62
63    } catch (PharException $e) {
64        echo "Phar 操作中にエラーが発生しました: " . $e->getMessage() . PHP_EOL;
65        echo "phar.readonly の設定を確認してください。" . PHP_EOL;
66    } finally {
67        // Pharオブジェクトをnullにすることで、開かれたファイルハンドルを解放します。
68        // これがunlinkArchive()を可能にするために重要です。
69        $phar = null;
70
71        // 作成したPharファイルをクリーンアップ
72        if (file_exists($pharPath)) {
73            try {
74                // Phar::unlinkArchive() は Pharファイルを安全に削除します。
75                Phar::unlinkArchive($pharPath);
76                echo "作成されたPharアーカイブ '{$pharPath}' を削除しました。" . PHP_EOL;
77            } catch (PharException $e) {
78                echo "Pharアーカイブの削除中にエラーが発生しました: " . $e->getMessage() . PHP_EOL;
79            }
80        }
81    }
82}
83
84// サンプル関数を実行
85demonstratePharEntryBasename();

PHP 8のPhar拡張機能で提供されるPharFileInfoクラスのgetBasenameメソッドは、Pharアーカイブ内のエントリ（ファイルやディレクトリ）のパスから、ベース名（ファイル名部分）を文字列として取得します。このメソッドは、ファイルシステムパスからベース名を取得するPHPのbasename()関数と同様の目的で利用されますが、Pharアーカイブの内部パスに特化しています。

引数としてオプションの$suffixを指定できます。この引数に文字列を指定すると、ベース名の末尾が指定された$suffixと一致する場合、そのサフィックスが取り除かれた文字列が返されます。もし$suffixが指定されてもベース名の末尾と一致しない場合は、何も取り除かれずにベース名がそのまま返されます。戻り値は常にベース名を表す文字列です。

サンプルコードでは、一時的なPharアーカイブを作成し、その内部にファイルを追加しています。そして、アーカイブ内のファイル情報（PharFileInfoオブジェクト）を取得し、そのオブジェクトに対してgetBasenameメソッドを適用する例を示しています。引数なしの場合や、.php、.gz、.tar.gzといった異なるサフィックスを指定した場合の動作例を通じて、このメソッドがパスの末尾をどのように処理するかを具体的に確認できます。

Copy
1<?php
2
3/**
4 * Phar::getBasename() メソッドのサンプルコード
5 *
6 * このメソッドは、Pharアーカイブファイル自体のベース名（ファイル名部分）を取得します。
7 * システムエンジニアを目指す初心者の方にも分かりやすいように、
8 * 以下の手順でPharアーカイブを作成し、ベース名の取得方法を示します。
9 */
10
11// 1. 一時的なPharアーカイブのファイルパスを定義します。
12//    __DIR__ は現在のスクリプトがあるディレクトリを指します。
13$pharFilePath = __DIR__ . '/sample_application.phar';
14
15// スクリプトの繰り返し実行のために、既存のPharファイルがあれば削除します。
16if (file_exists($pharFilePath)) {
17    unlink($pharFilePath);
18    echo "既存のPharファイルを削除しました: " . $pharFilePath . PHP_EOL;
19}
20
21try {
22    // 2. 新しいPharアーカイブを作成します。
23    //    Pharオブジェクトを作成するだけで、指定したパスにファイルが生成されます。
24    //    ここでは、Pharファイルが最低限の形で機能するように設定します。
25    //    実際のアプリケーションでは、ここにファイルを追加していきます。
26    $phar = new Phar($pharFilePath);
27
28    //    PharアーカイブがPHPによって実行可能な形式になるように、デフォルトのスタブを設定します。
29    //    これにより、PHPがこのPharファイルを認識できるようになります。
30    $phar->startBuffering();              // Pharファイルへの書き込みを一時的にバッファリング開始
31    $phar->setStub($phar->createDefaultStub()); // デフォルトの実行スタブを設定
32    $phar->stopBuffering();               // バッファリングを終了し、変更をPharファイルに書き込む
33
34    echo "Pharアーカイブを作成しました: " . $pharFilePath . PHP_EOL . PHP_EOL;
35
36    // 3. Phar::getBasename() メソッドを使ってアーカイブのベース名を取得します。
37
38    //    引数なしの場合: 拡張子を含むファイル名全体が返されます。
39    //    例: "sample_application.phar"
40    $basenameFull = $phar->getBasename();
41    echo "デフォルト (拡張子あり) のベース名: " . $basenameFull . PHP_EOL;
42
43    //    引数に接尾辞（Suffix）を指定した場合:
44    //    指定した接尾辞がファイル名の末尾にあれば、その部分が削除されてベース名が返されます。
45    //    例: ".phar" を指定すると "sample_application" が返されます。
46    $basenameWithoutPhar = $phar->getBasename('.phar');
47    echo "'.phar' を除いたベース名: " . $basenameWithoutPhar . PHP_EOL;
48
49    //    指定した接尾辞がファイル名の末尾にない場合:
50    //    ファイル名は変更されずに、そのままのベース名が返されます。
51    //    例: ".txt" を指定しても ".phar" は削除されず、"sample_application.phar" が返されます。
52    $basenameWithoutTxt = $phar->getBasename('.txt');
53    echo "'.txt' を除こうとしたベース名 (変化なし): " . $basenameWithoutTxt . PHP_EOL;
54
55} catch (PharException $e) {
56    // Phar関連のエラーが発生した場合の処理
57    echo "エラー: Phar操作中に問題が発生しました - " . $e->getMessage() . PHP_EOL;
58} catch (Exception $e) {
59    // その他の予期せぬエラーが発生した場合の処理
60    echo "エラー: 予期せぬ問題が発生しました - " . $e->getMessage() . PHP_EOL;
61} finally {
62    // 4. クリーンアップ: サンプルで作成したPharファイルを削除します。
63    //    これにより、スクリプト実行後に不要なファイルが残りません。
64    if (file_exists($pharFilePath)) {
65        unlink($pharFilePath);
66        echo PHP_EOL . "作成したPharファイルを削除しました: " . $pharFilePath . PHP_EOL;
67    }
68}
69
70?>

Phar::getBasename() メソッドは、PHPでPharアーカイブファイルを扱う際に、そのファイル名部分（ベース名）を取得するために使用されます。Pharアーカイブとは、複数のPHPファイルや関連リソースを一つの実行可能なファイルにまとめたものです。このメソッドは、Pharオブジェクトが内部的に保持しているアーカイブファイルのフルパスから、ディレクトリ部分を除いた純粋なファイル名そのものを文字列として返します。

引数 $suffix はオプションで、ファイル名の末尾から削除したい特定の文字列を指定できます。例えば、アーカイブファイルが「sample_application.phar」という名前で、引数に「.phar」を指定すると、拡張子を除いた「sample_application」がベース名として返されます。しかし、指定した $suffix がファイル名の末尾に存在しない場合、ファイル名は変更されず、そのままのベース名が返されます。これにより、アプリケーション名だけを抽出したり、特定の拡張子を取り除いたりする操作を簡単に行うことができます。戻り値は、取得されたベース名を表す文字列です。このメソッドは、Pharアーカイブの情報を柔軟に取得したい場合に役立ちます。