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

Copy
1<?php
2
3declare(strict_types=1);
4
5// Define names for temporary files and the archive
6$sourceFile1 = 'temp_file_1.txt';
7$sourceFile2 = 'temp_file_2.txt';
8$archiveName = 'my_archive.tar'; // .tar for PharData archives
9
10try {
11    // 1. Create dummy source files for demonstration
12    file_put_contents($sourceFile1, 'This is the content of the first example file.');
13    file_put_contents($sourceFile2, 'This is the content of the second example file.');
14
15    // Remove any existing archive from previous runs to prevent errors
16    if (file_exists($archiveName)) {
17        Phar::unlinkArchive($archiveName);
18    }
19
20    // 2. Create a new PharData archive (initially uncompressed)
21    // PharData allows managing tar-like archives
22    $pharData = new PharData($archiveName);
23
24    // Add the dummy files to the archive
25    // The second argument specifies the path of the file *inside* the archive
26    $pharData->addFile($sourceFile1, 'internal_directory/file_a.txt');
27    $pharData->addFile($sourceFile2, 'internal_directory/file_b.txt');
28
29    // Check if Gzip compression is available on the system
30    if (!Phar::canCompress(Phar::GZ)) {
31        // If not, throw an exception as we need compression for the example
32        throw new Exception("Gzip compression not available. Please ensure zlib extension is enabled in php.ini.");
33    }
34
35    // 3. Compress the *files inside* the PharData archive using Gzip
36    // This method compresses each individual file added to the archive, not the archive itself.
37    if (!$pharData->compressFiles(Phar::GZ)) {
38        throw new Exception("Failed to compress files inside '{$archiveName}'.");
39    }
40
41    // 4. Decompress the *files inside* the PharData archive
42    // This method reverses the compression applied by compressFiles.
43    $decompressionSuccess = $pharData->decompressFiles();
44
45    if (!$decompressionSuccess) {
46        throw new Exception("Failed to decompress files inside '{$archiveName}'.");
47    }
48
49} catch (Exception $e) {
50    // In a production environment, you would log this error appropriately.
51    // For this example, we'll just log to the PHP error log.
52    error_log("PharData decompressFiles example error: " . $e->getMessage());
53} finally {
54    // 5. Cleanup: Remove all temporary files and the created archive
55    // It's crucial to unset the PharData object to release file handles before deleting.
56    if (isset($pharData)) {
57        unset($pharData);
58    }
59    // Use Phar::unlinkArchive for robust deletion of Phar/PharData archives.
60    if (file_exists($archiveName)) {
61        Phar::unlinkArchive($archiveName);
62    }
63    if (file_exists($sourceFile1)) {
64        unlink($sourceFile1);
65    }
66    if (file_exists($sourceFile2)) {
67        unlink($sourceFile2);
68    }
69}

PHP 8のPharData::decompressFilesメソッドは、PHPで.tar形式などのファイルアーカイブを扱うPharDataクラスの機能の一つです。このメソッドは、PharDataオブジェクトが扱っているアーカイブ内に格納されている個々のファイルが圧縮されている場合、その圧縮を解除し、元の非圧縮状態に戻します。

具体的には、以前PharData::compressFilesメソッドなどによってアーカイブ内のファイルが圧縮されていた際に、それらのファイルを元の状態に戻す目的で使用されます。このメソッドは引数を取りません。処理に成功した場合はtrueを、失敗した場合はfalseをブール値として返します。

サンプルコードでは、まず一時ファイルからmy_archive.tarというPharDataアーカイブを作成し、ファイルを格納しています。次に、compressFiles(Phar::GZ)を使ってアーカイブ内の各ファイルをGzip形式で圧縮します。その後、decompressFiles()を呼び出すことで、この圧縮されたファイル群を再び非圧縮の状態に戻し、データが元の形式で利用できるようにしています。このように、ファイルアーカイブ内の圧縮と解凍を制御するために利用されます。

Copy
1<?php
2
3/**
4 * PharData::decompressFiles() メソッドの使用例を示します。
5 * このメソッドは、Pharアーカイブ内の個別に圧縮されたファイルを解凍します。
6 * アーカイブ全体の圧縮形式 (例: .tar.gz の .gz 部分) を解除するものではありません。
7 *
8 * 注: このスクリプトを実行するには、php.ini で 'phar.readonly = 0' に設定する必要があります。
9 */
10function demonstratePharDataDecompressFiles(): void
11{
12    // 一時ディレクトリとファイルパスの定義
13    $tempDir = __DIR__ . '/phar_decompress_temp';
14    $archivePath = $tempDir . '/my_archive.tar'; // 非圧縮のtarアーカイブ
15    $originalFilePath = $tempDir . '/original_file.txt';
16    $compressedEntryName = 'content.txt.gz'; // アーカイブ内の圧縮ファイル名
17    $decompressedEntryName = 'content.txt'; // アーカイブ内の解凍後ファイル名
18
19    // 実行後のクリーンアップ処理を定義
20    $cleanup = function () use ($tempDir, $archivePath, $originalFilePath, $compressedEntryName, $decompressedEntryName) {
21        // PharDataオブジェクトがファイルロックを保持している可能性があるので、まずunset
22        unset($GLOBALS['phar_obj']);
23
24        if (file_exists($archivePath)) {
25            unlink($archivePath);
26        }
27        if (file_exists($originalFilePath)) {
28            unlink($originalFilePath);
29        }
30        // addFileでコピーされた一時ファイルも削除 (存在する場合)
31        if (file_exists($tempDir . '/' . $compressedEntryName)) {
32            unlink($tempDir . '/' . $compressedEntryName);
33        }
34        // 解凍されたファイルが一時ディレクトリに抽出された場合 (この例ではアーカイブ内での操作なので不要だが、念のため)
35        if (file_exists($tempDir . '/' . $decompressedEntryName)) {
36            unlink($tempDir . '/' . $decompressedEntryName);
37        }
38        if (is_dir($tempDir)) {
39            @rmdir($tempDir); // ディレクトリが空でないと失敗するため、@ でエラーを抑制
40        }
41    };
42
43    // 以前の実行で残ったファイルをクリーンアップ
44    $cleanup();
45
46    try {
47        // 1. 一時ディレクトリを作成
48        if (!mkdir($tempDir) && !is_dir($tempDir)) {
49            throw new Exception("一時ディレクトリ '{$tempDir}' の作成に失敗しました。");
50        }
51        echo "1. 一時ディレクトリ '{$tempDir}' を作成しました。\n";
52
53        // 2. テスト用の非圧縮ファイルを作成
54        $fileContent = 'これはPharData::decompressFiles() のテストコンテンツです。';
55        if (file_put_contents($originalFilePath, $fileContent) === false) {
56            throw new Exception("オリジナルファイル '{$originalFilePath}' の作成に失敗しました。");
57        }
58        echo "2. オリジナルファイル '{$originalFilePath}' を作成しました。\n";
59
60        // 3. オリジナルファイルをGzip形式で圧縮し、一時ファイルとして保存
61        $compressedContent = gzencode($fileContent, 9); // 9は最高の圧縮レベル
62        $tempCompressedFilePath = $tempDir . '/' . $compressedEntryName;
63        if (file_put_contents($tempCompressedFilePath, $compressedContent) === false) {
64            throw new Exception("圧縮ファイル '{$tempCompressedFilePath}' の作成に失敗しました。");
65        }
66        echo "3. オリジナルファイルをGzip圧縮し、一時ファイル '{$tempCompressedFilePath}' を作成しました。\n";
67
68        // 4. 新しいPharDataアーカイブを作成し、圧縮ファイルを追加
69        // まず新しいPharDataオブジェクトを作成（これにより新しい.tarファイルが作られる）
70        $phar = new PharData($archivePath);
71        $GLOBALS['phar_obj'] = $phar; // クリーンアップのためにグローバル変数に保持 (推奨される方法ではないが、ここでは簡潔さのため)
72        echo "4. 新しいPharDataアーカイブ '{$archivePath}' を作成しました。\n";
73
74        // 圧縮された一時ファイルをアーカイブに追加
75        // この時点で、アーカイブ内には 'content.txt.gz' という名前で圧縮ファイルが存在します
76        $phar->addFile($tempCompressedFilePath, $compressedEntryName);
77        echo "   アーカイブに圧縮ファイル '{$compressedEntryName}' を追加しました。\n";
78
79        // Pharオブジェクトを閉じて、再度PharDataとして開く
80        // これにより、アーカイブファイルが適切に保存され、PharDataの読み書きモードで操作できるようになります。
81        unset($phar);
82        $phar = new PharData($archivePath);
83        $GLOBALS['phar_obj'] = $phar;
84        echo "   アーカイブをPharDataオブジェクトとして再度開きました。\n";
85
86        // 5. 解凍前のアーカイブ内容を確認
87        echo "\n5. 解凍前のアーカイブ内容:\n";
88        if ($phar->offsetExists($compressedEntryName)) {
89            echo "   - アーカイブ内に '{$compressedEntryName}' (圧縮済み) が存在します。\n";
90        } else {
91            echo "   - エラー: '{$compressedEntryName}' がアーカイブ内に見つかりません。\n";
92        }
93        if ($phar->offsetExists($decompressedEntryName)) {
94            echo "   - 警告: '{$decompressedEntryName}' (解凍済み) が既に存在します (予期しない)。\n";
95        } else {
96            echo "   - アーカイブ内に '{$decompressedEntryName}' (解凍済み) は存在しません。\n";
97        }
98
99        // 6. アーカイブ内のファイルを解凍
100        echo "\n6. PharData::decompressFiles() を呼び出します...\n";
101        $success = $phar->decompressFiles();
102
103        if ($success) {
104            echo "   PharData::decompressFiles() が成功しました。\n";
105
106            // 7. 解凍後のアーカイブ内容を確認
107            echo "\n7. 解凍後のアーカイブ内容:\n";
108            if ($phar->offsetExists($compressedEntryName)) {
109                echo "   - '{$compressedEntryName}' がまだ存在します (予期しない、解凍されたファイルに置き換わるはず)。\n";
110            } else {
111                echo "   - '{$compressedEntryName}' は削除され、非圧縮ファイルに置き換わったと推測されます。\n";
112            }
113
114            if ($phar->offsetExists($decompressedEntryName)) {
115                echo "   - '{$decompressedEntryName}' (解凍済み) が存在します。\n";
116                // 解凍されたファイルの内容を検証
117                $extractedContent = $phar[$decompressedEntryName]->getContent();
118                if ($extractedContent === $fileContent) {
119                    echo "     -> 内容がオリジナルと一致し、正しく解凍されました。\n";
120                } else {
121                    echo "     -> 内容がオリジナルと一致しませんでした。\n";
122                }
123            } else {
124                echo "   - エラー: '{$decompressedEntryName}' がアーカイブ内に見つかりません。解凍に失敗した可能性があります。\n";
125            }
126        } else {
127            echo "   PharData::decompressFiles() が失敗しました。\n";
128        }
129    } catch (Exception $e) {
130        echo "\nエラー: Phar操作中に例外が発生しました: " . $e->getMessage() . "\n";
131    } finally {
132        // 最終的なクリーンアップ
133        $cleanup();
134        echo "\n8. 一時ファイルをクリーンアップしました。\n";
135    }
136}
137
138// 関数を実行
139demonstratePharDataDecompressFiles();
140
141?>

PharData::decompressFiles()メソッドは、PHPのPhar拡張機能で作成されたアーカイブ（例：.tarファイルなど）の中に含まれる、個別に圧縮されたファイルを解凍するために使用されます。このメソッドは引数を一切とらず、処理が成功した場合はtrueを、失敗した場合はfalseをブール値として返します。

サンプルコードでは、まず一時ディレクトリにテスト用のテキストファイルをGzip形式で圧縮して準備します。次に、PharDataクラスを使用して新しいアーカイブ（この例では.tarファイル）を作成し、先ほど圧縮したファイルをそのアーカイブ内に「content.txt.gz」として追加します。この時点では、アーカイブ内のファイルはまだ圧縮された状態です。

その後、decompressFiles()メソッドを呼び出すと、アーカイブ内のcontent.txt.gzが自動的に解凍され、解凍された「content.txt」がアーカイブ内に新しく作成されます。コードでは、解凍前後にアーカイブの内容を確認し、ファイルが正しく解凍され、その内容がオリジナルと一致することを示しています。

このメソッドは、アーカイブファイル自体が圧縮されている場合（例：.tar.gzの.gz部分）の圧縮を解除するものではなく、あくまでアーカイブ内部のファイルが個別に圧縮されている場合にその圧縮を解除する点にご注意ください。アーカイブを書き換える操作のため、このスクリプトを実行するには、php.iniでphar.readonly = 0と設定する必要があります。