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

Copy
1<?php
2
3// このスクリプトはPharアーカイブを作成・操作するため、
4// php.ini の 'phar.readonly' 設定が 'Off' になっている必要があります。
5// 例: php -d phar.readonly=0 your_script_name.php
6
7// 一時的なPharアーカイブのパスを定義
8$pharPath = __DIR__ . '/example.phar';
9// Pharアーカイブ内に格納するファイルパスの例
10$filePathInPhar1 = 'path/to/my_document.txt';
11$filePathInPhar2 = 'archive/image.jpg';
12$filePathInPhar3 = 'src/MainClass.php';
13
14// 以前に作成されたPharアーカイブが存在する場合は削除し、クリーンな状態にする
15if (file_exists($pharPath)) {
16    unlink($pharPath);
17}
18
19try {
20    // 1. 新しいPharアーカイブを作成
21    // Pharクラスのコンストラクタでアーカイブパスとモードを指定（'w'は書き込みモード）
22    $phar = new Phar($pharPath);
23    $phar->startBuffering(); // バッファリングを開始し、多数のファイル操作を効率化
24
25    // 2. テストファイルをPharアーカイブに追加
26    // addFromString()メソッドで、仮想的なファイルパスと内容を指定してファイルを追加
27    $phar->addFromString($filePathInPhar1, 'This is the content of my_document.txt.');
28    $phar->addFromString($filePathInPhar2, 'Binary content for image.jpg');
29    $phar->addFromString($filePathInPhar3, '<?php class MainClass {}');
30
31    $phar->stopBuffering(); // バッファリングを終了し、変更をPharアーカイブに保存
32
33    echo "Pharアーカイブ '" . basename($pharPath) . "' を作成しました。\n\n";
34
35    // 3. Pharアーカイブ内のファイル情報を表すPharFileInfoオブジェクトを取得
36    // PharオブジェクトはArrayAccessインターフェースを実装しているため、
37    // 配列のようにファイルパスでアクセスしてPharFileInfoオブジェクトを取得できます。
38    $fileInfo1 = $phar[$filePathInPhar1];
39    $fileInfo2 = $phar[$filePathInPhar2];
40    $fileInfo3 = $phar[$filePathInPhar3];
41
42    // 4. getBasenameメソッドを呼び出し、結果を出力
43
44    // 引数なしの場合: ファイル名と拡張子を含むベース名を返します
45    echo "--- PharFileInfo::getBasename() (引数なし) ---\n";
46    echo "  元のパス: '" . $filePathInPhar1 . "' -> ベース名: '" . $fileInfo1->getBasename() . "'\n"; // 期待: my_document.txt
47    echo "  元のパス: '" . $filePathInPhar2 . "' -> ベース名: '" . $fileInfo2->getBasename() . "'\n"; // 期待: image.jpg
48    echo "  元のパス: '" . $filePathInPhar3 . "' -> ベース名: '" . $fileInfo3->getBasename() . "'\n"; // 期待: MainClass.php
49
50    echo "\n";
51
52    // サフィックス（拡張子など）を指定した場合: 指定したサフィックスがファイル名の末尾にあれば削除します
53    echo "--- PharFileInfo::getBasename(string \$suffix) ---\n";
54    echo "  元のパス: '" . $filePathInPhar1 . "'\n";
55    echo "    getBasename('.txt'): '" . $fileInfo1->getBasename('.txt') . "'\n"; // 期待: my_document
56    echo "    getBasename('.doc'): '" . $fileInfo1->getBasename('.doc') . "'\n"; // 期待: my_document.txt (一致しないため変更なし)
57    echo "\n";
58
59    echo "  元のパス: '" . $filePathInPhar2 . "'\n";
60    echo "    getBasename('.jpg'): '" . $fileInfo2->getBasename('.jpg') . "'\n"; // 期待: image
61    echo "    getBasename('.jpeg'): '" . $fileInfo2->getBasename('.jpeg') . "'\n"; // 期待: image.jpg (一致しないため変更なし)
62    echo "\n";
63
64    echo "  元のパス: '" . $filePathInPhar3 . "'\n";
65    echo "    getBasename('.php'): '" . $fileInfo3->getBasename('.php') . "'\n"; // 期待: MainClass
66    echo "    getBasename('.class'): '" . $fileInfo3->getBasename('.class') . "'\n"; // 期待: MainClass.php (一致しないため変更なし)
67
68} catch (PharException $e) {
69    // Pharアーカイブの作成や操作に関するエラーを捕捉
70    echo "Pharエラーが発生しました: " . $e->getMessage() . "\n";
71    echo "phar.readonlyが'On'になっていないか確認してください。\n";
72} catch (Exception $e) {
73    // その他の予期せぬエラーを捕捉
74    echo "一般的なエラーが発生しました: " . $e->getMessage() . "\n";
75} finally {
76    // 処理の成功・失敗に関わらず、作成したPharアーカイブを削除し、クリーンアップ
77    if (file_exists($pharPath)) {
78        unlink($pharPath);
79        echo "\n一時Pharアーカイブ '" . basename($pharPath) . "' を削除しました。\n";
80    }
81}

PharFileInfo::getBasename()メソッドは、PHPのPhar拡張機能で使用されるPharFileInfoクラスのメソッドです。Pharアーカイブ（複数のファイルを一つにまとめた形式）内に格納されている個々のファイル情報を表すPharFileInfoオブジェクトから、そのファイルパスのディレクトリ部分を除いた「ベース名」を取得するために利用されます。これは、ファイル名や拡張子だけを取り出したい場合に役立ちます。

このメソッドには、$suffixというオプションの引数を指定できます。$suffixに文字列を指定すると、取得されるファイル名の末尾がその文字列と一致した場合に、その部分を削除したベース名を返します。例えば、ファイルの拡張子（.txtや.phpなど）を除去して純粋なファイル名のみを得たい場合に便利です。指定した$suffixがファイル名の末尾に一致しない場合は、元のファイル名がそのまま返されます。

戻り値は常に文字列型で、抽出されたファイル名が返されます。サンプルコードでは、'path/to/my_document.txt'という仮想的なファイルパスからgetBasename()を引数なしで呼び出すと'my_document.txt'が取得されます。また、'.txt'を$suffixとして指定して呼び出すと、拡張子が取り除かれた'my_document'が取得されることが示されており、このメソッドの挙動を具体的に理解できます。

Copy
1<?php
2
3/**
4 * PharFileInfo::getBasename() の使用例を示します。
5 *
6 * この関数は、Pharアーカイブ内のエントリのベース名（ファイル名部分）を返します。
7 * オプションで、指定されたサフィックスをファイル名から削除できます。
8 *
9 * 注: このサンプルを実行するには、PHPのphar拡張が有効になっている必要があります。
10 *     また、スクリプトを実行するディレクトリに書き込み権限が必要です。
11 */
12function demonstratePharFileBasename(): void
13{
14    $pharPath = 'example.phar';
15    $internalFilePath = 'data/document.txt';
16    $internalFileWithSuffixPath = 'assets/image.png';
17
18    // 1. サンプル用のPharアーカイブを作成します
19    // 既存のPharアーカイブを削除し、新しいPharを作成します
20    if (file_exists($pharPath)) {
21        unlink($pharPath);
22    }
23
24    try {
25        // Phar::createDefaultStub() はデフォルトのスタブ (Pharローダー) を作成します。
26        // SCRIPT_NAME を使用して、自身のスクリプトをPharのスタブとして設定しないように注意してください。
27        $phar = new Phar($pharPath);
28        $phar->startBuffering();
29
30        // 2. サンプルファイルを作成し、Pharに追加します
31        // 内部ファイル 'data/document.txt'
32        $phar->addFromString($internalFilePath, 'This is a sample document.');
33        echo "Pharにファイルを追加しました: {$internalFilePath}\n";
34
35        // 内部ファイル 'assets/image.png'
36        $phar->addFromString($internalFileWithSuffixPath, 'This is a dummy image content.');
37        echo "Pharにファイルを追加しました: {$internalFileWithSuffixPath}\n";
38
39        $phar->setStub($phar->createDefaultStub());
40        $phar->stopBuffering();
41
42        echo "\nPharアーカイブ '{$pharPath}' が正常に作成されました。\n";
43
44        // 3. Pharアーカイブ内のファイル情報を取得し、getBasenameを呼び出します
45        // 'data/document.txt' の PharFileInfo オブジェクトを取得
46        $fileInfo1 = $phar[$internalFilePath];
47
48        // サフィックスなしでベース名を取得
49        $basename1 = $fileInfo1->getBasename();
50        echo "ファイル '{$internalFilePath}' のベース名 (サフィックスなし): " . $basename1 . "\n"; // 出力: document.txt
51
52        // 'assets/image.png' の PharFileInfo オブジェクトを取得
53        $fileInfo2 = $phar[$internalFileWithSuffixPath];
54
55        // サフィックスなしでベース名を取得
56        $basename2 = $fileInfo2->getBasename();
57        echo "ファイル '{$internalFileWithSuffixPath}' のベース名 (サフィックスなし): " . $basename2 . "\n"; // 出力: image.png
58
59        // サフィックス '.png' を指定してベース名を取得
60        $basename3 = $fileInfo2->getBasename('.png');
61        echo "ファイル '{$internalFileWithSuffixPath}' のベース名 (サフィックス '.png' を削除): " . $basename3 . "\n"; // 出力: image
62
63        // 存在しないサフィックスを指定した場合
64        $basename4 = $fileInfo2->getBasename('.txt');
65        echo "ファイル '{$internalFileWithSuffixPath}' のベース名 (存在しないサフィックス '.txt' を削除): " . $basename4 . "\n"; // 出力: image.png
66
67    } catch (PharException $e) {
68        echo "Phar操作中にエラーが発生しました: " . $e->getMessage() . "\n";
69    } finally {
70        // 4. クリーンアップ: 作成したPharアーカイブを削除します
71        if (file_exists($pharPath)) {
72            // Phar::unlinkArchive() を使用して完全にアーカイブを削除します。
73            // また、unlink() で直接ファイルも削除できます。
74            Phar::unlinkArchive($pharPath);
75            echo "\nクリーンアップ: '{$pharPath}' が削除されました。\n";
76        }
77    }
78}
79
80// 関数の実行
81demonstratePharFileBasename();

PharFileInfo::getBasename()は、PHPのPharアーカイブ内に含まれるファイル（エントリ）のベース名、つまりディレクトリ部分を除いたファイル名を取得するメソッドです。

このメソッドは、ファイル名から特定のサフィックス（拡張子など）を取り除くオプションも提供します。引数$suffixは文字列型で、ファイル名の末尾から削除したいサフィックスを指定します。例えば、「image.png」に対して「.png」を指定すると、「image」という結果が得られます。この引数は省略可能で、指定しない場合はサフィックスは削除されません。また、指定したサフィックスがファイル名の末尾に存在しない場合も、何も削除されずに元のベース名がそのまま返されます。戻り値は常に文字列型で、処理後のベース名が返されます。

サンプルコードでは、まずexample.pharというアーカイブを作成し、内部に仮想的なファイルを追加しています。その後、追加したファイルのPharFileInfoオブジェクトからgetBasename()を呼び出し、引数を指定しない場合や、.pngなどのサフィックスを指定した場合、あるいは存在しないサフィックスを指定した場合のベース名の取得結果を具体的に示しています。このメソッドは、Pharアーカイブ内でファイル名のみを効率的に抽出したい場合に役立ちます。