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

Copy
1<?php
2
3// PHP 8
4// システムエンジニアを目指す初心者向けに、PharData クラスの getBasename メソッドのサンプルコードです。
5//
6// PharData はアーカイブファイル（例: .tar, .zip）を扱うためのクラスです。
7// このクラスは SplFileInfo クラスを継承しており、
8// SplFileInfo::getBasename() メソッドを PharData オブジェクトに対しても利用できます。
9//
10// getBasename メソッドは、PHP の一般的な basename() 関数と同様に、
11// オブジェクトが表現するファイルパスの「ベース名」（ファイル名部分）を
12// 取得するために使用されます。オプションで、指定した接尾辞（suffix）を取り除くこともできます。
13
14// 一時的なPharアーカイブファイルのパスを定義します。
15// このスクリプトを実行すると、このパスに一時ファイルが作成され、最後に削除されます。
16$archiveFilePath = 'temporary_archive.tar.gz';
17
18// クリーンアップ処理を確実に行うために try-finally ブロックを使用します。
19try {
20    // PharData のコンストラクタは、指定されたパスにアーカイブを作成（または既存のものを開く）します。
21    // ここでは、一時的にファイルを書き込みモードで作成します。
22    // SplFileInfo::getBasename を使うためだけであれば、アーカイブの中身は重要ではありません。
23    $pharData = new PharData($archiveFilePath);
24
25    echo "--- PharData::getBasename() の使用例 ---\n";
26
27    // 1. 接尾辞 (suffix) なしでベース名を取得する例
28    // ファイル名のフルネーム（拡張子を含む）が返されます。
29    echo "元のパス: '{$archiveFilePath}'\n";
30    $basenameNoSuffix = $pharData->getBasename();
31    echo "Suffix なし: {$basenameNoSuffix}\n"; // 出力例: temporary_archive.tar.gz
32
33    // 2. 特定の接尾辞 (suffix) を指定してベース名を取得する例
34    // 指定した suffix がファイル名の末尾と一致する場合、その suffix が取り除かれます。
35    $basenameWithSuffixTarGz = $pharData->getBasename('.tar.gz');
36    echo "Suffix '.tar.gz' あり: {$basenameWithSuffixTarGz}\n"; // 出力例: temporary_archive
37
38    $basenameWithSuffixGz = $pharData->getBasename('.gz');
39    echo "Suffix '.gz' あり: {$basenameWithSuffixGz}\n"; // 出力例: temporary_archive.tar
40
41    // 接尾辞が一致しない場合は取り除かれません。
42    $basenameWithMismatchSuffix = $pharData->getBasename('.zip');
43    echo "Suffix '.zip' (不一致) あり: {$basenameWithMismatchSuffix}\n"; // 出力例: temporary_archive.tar.gz
44
45} catch (Exception $e) {
46    // PharData の作成や操作中にエラーが発生した場合の処理
47    echo "エラーが発生しました: " . $e->getMessage() . "\n";
48    // 例: 書き込み権限がない場合などにエラーが発生することがあります。
49} finally {
50    // スクリプト終了時に作成したアーカイブファイルを確実に削除します。
51    if (file_exists($archiveFilePath)) {
52        unlink($archiveFilePath);
53        echo "\nクリーンアップ: '{$archiveFilePath}' を削除しました。\n";
54    }
55}

PHP 8のPharData::getBasenameメソッドは、アーカイブファイルを扱うPharDataオブジェクトが表現するパスから、ファイル名部分（ベース名）を取得するために使用します。PharDataはファイル情報を提供するSplFileInfoクラスを継承しており、このメソッドもその機能の一つとして利用できます。

このメソッドは、引数としてオプションで$suffix（接尾辞）を受け取ります。$suffixを省略した場合や、指定した$suffixがファイル名の末尾と一致しない場合、ファイル名全体（拡張子を含む）が文字列としてそのまま返されます。一方、$suffixに特定の文字列を指定し、それがファイル名の末尾と一致する場合、その部分を取り除いたベース名が文字列として返されます。例えば、「sample.tar.gz」というファイル名に対して.tar.gzを指定すると「sample」が、.gzを指定すると「sample.tar」が返される、といった挙動です。

これはPHPの標準関数であるbasename()と同様の働きをするため、アーカイブファイル名から不要な拡張子などを取り除きたい場合に便利です。このメソッドは常にファイル名部分を文字列として返します。

Copy
1<?php
2
3/**
4 * PharData::getBasename メソッドのサンプルコード
5 *
6 * このメソッドはPharアーカイブ内のエントリ（ファイル）のパスから、
7 * ファイル名（ベース名）を取得するために使用されます。
8 *
9 * PHPのリファレンスではPharData::getBasenameと記載されていますが、
10 * 実際にはPharDataオブジェクトを反復処理して取得されるPharFileInfoオブジェクトに対して呼び出されます。
11 * その動作はPharFileInfo::getBasenameと同様です。
12 *
13 * システムエンジニアを目指す初心者向けに、Pharアーカイブの作成から
14 * その中のファイル名取得までの一連の流れを正確かつ簡潔に示します。
15 */
16function demonstratePharDataGetBasename(): void
17{
18    // PHP設定 'phar.readonly' が 'Off' に設定されているか確認します。
19    // Pharアーカイブを作成・変更するには、この設定が必要です。
20    if (ini_get('phar.readonly')) {
21        echo "エラー: PHP設定 'phar.readonly' が 'Off' に設定されている必要があります。\n";
22        echo "php.ini を編集するか、スクリプト実行時に '-d phar.readonly=0' を指定してください。\n";
23        exit(1);
24    }
25
26    // --- 一時ファイルとアーカイブのパスを設定 ---
27    $tempDir = __DIR__ . '/temp_phar_data_example';
28    $archivePath = $tempDir . '/my_archive.tar'; // .tar 形式で作成します
29
30    $file1Path = $tempDir . '/document.txt';
31    $file2Path = $tempDir . '/images/photo.jpg';
32    $file3Path = $tempDir . '/scripts/main.php';
33
34    // --- ダミーファイルとディレクトリの準備 ---
35    // 必要な一時ディレクトリを再帰的に作成します。
36    if (!mkdir($tempDir . '/images', 0777, true) && !is_dir($tempDir . '/images')) {
37        echo "エラー: ディレクトリ '{$tempDir}/images' の作成に失敗しました。\n";
38        exit(1);
39    }
40    if (!mkdir($tempDir . '/scripts', 0777, true) && !is_dir($tempDir . '/scripts')) {
41        echo "エラー: ディレクトリ '{$tempDir}/scripts' の作成に失敗しました。\n";
42        exit(1);
43    }
44
45    // ダミーファイルをいくつか作成します。
46    file_put_contents($file1Path, 'これはテストドキュメントです。');
47    file_put_contents($file2Path, '画像ファイルの内容をシミュレート。');
48    file_put_contents($file3Path, '<?php echo "Hello from PHP script!";');
49
50    echo "一時ファイルを作成しました:\n";
51    echo "- " . basename($file1Path) . "\n";
52    echo "- " . basename($file2Path) . "\n";
53    echo "- " . basename($file3Path) . "\n\n";
54
55    // --- PharData::getBasename の実演 ---
56    $phar = null; // finallyブロックで使用するために初期化
57
58    try {
59        // 既存のアーカイブがある場合は削除します。（スクリプトを複数回実行する場合のため）
60        if (file_exists($archivePath)) {
61            unlink($archivePath);
62        }
63
64        // 新しいPharDataアーカイブを作成します。
65        // PharDataは、Phar形式だけでなく、tar/zip形式も扱えます。ここではtar形式で作成します。
66        $phar = new PharData($archivePath);
67
68        // ファイルをアーカイブに追加します。
69        // 第2引数はアーカイブ内でのパス（エントリ名）です。
70        $phar->addFile($file1Path, 'document.txt');
71        $phar->addFile($file2Path, 'images/photo.jpg');
72        $phar->addFile($file3Path, 'scripts/main.php');
73
74        echo "アーカイブ '{$archivePath}' が作成され、ファイルが追加されました。\n\n";
75
76        echo "アーカイブ内のエントリ名とベース名:\n";
77        // PharDataオブジェクトをループすると、各エントリがPharFileInfoオブジェクトとして取得されます。
78        foreach ($phar as $entry) {
79            // $entry は PharFileInfo クラスのインスタンスです。
80            // PharData::getBasename は、この $entry に対して呼び出すことで機能します。
81            
82            // エントリのアーカイブ内での完全なパス名を取得
83            $entryPathname = $entry->getPathname();
84            // ベース名を取得（suffix引数なし）
85            $basename = $entry->getBasename();
86
87            echo "  - エントリ: '{$entryPathname}'\n";
88            echo "    -> ベース名 (引数なし): '{$basename}'\n";
89
90            // suffix 引数を使用して、特定の拡張子を取り除いたベース名を取得する例
91            if (str_ends_with($basename, '.jpg')) {
92                $basenameWithoutSuffix = $entry->getBasename('.jpg');
93                echo "    -> ベース名 ('.jpg' を除外): '{$basenameWithoutSuffix}'\n";
94            }
95            if (str_ends_with($basename, '.php')) {
96                $basenameWithoutSuffix = $entry->getBasename('.php');
97                echo "    -> ベース名 ('.php' を除外): '{$basenameWithoutSuffix}'\n";
98            }
99        }
100
101    } catch (Exception $e) {
102        echo "エラーが発生しました: " . $e->getMessage() . "\n";
103    } finally {
104        // --- 後処理：作成したPharアーカイブと一時ファイルを削除 ---
105        echo "\n後処理を開始します...\n";
106        if (file_exists($archivePath)) {
107            unlink($archivePath);
108            echo "- アーカイブ '{$archivePath}' を削除しました。\n";
109        }
110
111        // ダミーファイルを削除
112        if (file_exists($file1Path)) {
113            unlink($file1Path);
114        }
115        if (file_exists($file2Path)) {
116            unlink($file2Path);
117        }
118        if (file_exists($file3Path)) {
119            unlink($file3Path);
120        }
121
122        // 作成したディレクトリを削除（空の場合のみ削除可能）
123        if (is_dir($tempDir . '/images')) {
124            rmdir($tempDir . '/images');
125        }
126        if (is_dir($tempDir . '/scripts')) {
127            rmdir($tempDir . '/scripts');
128        }
129        if (is_dir($tempDir)) {
130            rmdir($tempDir);
131            echo "- 一時ディレクトリ '{$tempDir}' とその内容を削除しました。\n";
132        }
133    }
134}
135
136// サンプルコードを実行します。
137demonstratePharDataGetBasename();

PHPのPharData::getBasenameメソッドは、Pharアーカイブ内のファイルやディレクトリのパスから、ファイル名（ベース名）を取得するために利用されます。Pharとは、複数のPHPファイルを単一のアーカイブにまとめ、配布や実行を容易にするための機能です。PharDataクラスは、Phar形式だけでなく、標準的なtarやzip形式のアーカイブも扱うことができます。

このメソッドは、PharDataオブジェクトを繰り返し処理して取得される各エントリ、つまりPharFileInfoオブジェクトに対して呼び出されることが一般的です。サンプルコードでは、PharDataオブジェクトでアーカイブを作成し、その中にファイルをいくつか追加しています。その後、アーカイブ内のファイル一つ一つをループで取り出し、それぞれのPharFileInfoオブジェクトに対してgetBasenameを呼び出してファイル名を取得する流れを示しています。

引数$suffixには、ファイル名から取り除きたい特定の文字列（主に拡張子）を指定できます。例えば、ファイル名がdocument.txtで$suffixに.txtを指定すると、documentというベース名が返されます。引数を省略した場合や、指定した$suffixがファイル名の末尾と一致しない場合は、ファイル名の全体がそのまま返されます。戻り値は、取得されたベース名を表す文字列です。この機能は、アーカイブ内のファイルリストからファイル名だけを抽出したり、拡張子を除いた名前で処理を行う際に役立ちます。