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

Copy
1<?php
2
3// このスクリプトは、PharData クラスとそのエントリで hasChildren() メソッドの使用方法を示すサンプルコードです。
4// 一時的なアーカイブファイルとディレクトリを作成・削除するため、実行環境に書き込み権限が必要です。
5
6// 一時的なPharDataアーカイブファイル名を定義します。
7$archiveName = 'example_archive.tar';
8// アーカイブに含めるための一時ディレクトリを定義します。
9$tempDir = __DIR__ . '/temp_phar_data_content';
10
11// ---------------------------------------------------------------------------------
12// ヘルパー関数: ディレクトリとその内容を再帰的に削除します。
13// ---------------------------------------------------------------------------------
14$rrmdir = function ($dir) use (&$rrmdir) {
15    if (!is_dir($dir)) {
16        return;
17    }
18    $objects = scandir($dir);
19    foreach ($objects as $object) {
20        if ($object != "." && $object != "..") {
21            if (is_dir($dir . "/" . $object) && !is_link($dir . "/" . $object)) {
22                $rrmdir($dir . "/" . $object);
23            } else {
24                unlink($dir . "/" . $object);
25            }
26        }
27    }
28    rmdir($dir);
29};
30
31// ---------------------------------------------------------------------------------
32// 前準備: アーカイブに含めるための一時ファイルとディレクトリを作成します。
33// ---------------------------------------------------------------------------------
34echo "--- 前準備: アーカイブコンテンツの作成 ---\n";
35
36// 既存の一時ディレクトリがあれば削除し、新しく作成します。
37if (file_exists($tempDir)) {
38    $rrmdir($tempDir);
39}
40mkdir($tempDir);
41echo "一時ディレクトリ '{$tempDir}' を作成しました。\n";
42
43// アーカイブのルートに配置するファイルを作成します。
44file_put_contents($tempDir . '/root_file.txt', 'これはアーカイブのルートにあるファイルです。');
45// アーカイブ内のサブディレクトリを作成します。
46mkdir($tempDir . '/my_subdir');
47// サブディレクトリ内にファイルを作成します。
48file_put_contents($tempDir . '/my_subdir/child_file.txt', 'これはmy_subdir内のファイルです。');
49// サブディレクトリ内に空のサブディレクトリを作成します。
50mkdir($tempDir . '/my_subdir/empty_dir');
51echo "一時ファイルとディレクトリを '{$tempDir}' 内に作成しました。\n";
52
53// ---------------------------------------------------------------------------------
54// Step 1: PharDataアーカイブを作成します。
55// ---------------------------------------------------------------------------------
56echo "\n--- Step 1: PharDataアーカイブの作成 ---\n";
57
58// 既存のアーカイブファイルがあれば削除します。
59if (file_exists($archiveName)) {
60    unlink($archiveName);
61}
62
63try {
64    // 新しいPharDataアーカイブを作成します（非圧縮のtar形式）。
65    $pharData = new PharData($archiveName);
66    echo "アーカイブ '{$archiveName}' を作成しました。\n";
67
68    // 一時ディレクトリからアーカイブにファイルとディレクトリを追加します。
69    // 第2引数はアーカイブ内のパスです。
70    $pharData->addFile($tempDir . '/root_file.txt', 'root_file.txt');
71    // addEmptyDir はディレクトリを追加しますが、その中身は含まれません。
72    $pharData->addEmptyDir('my_subdir');
73    $pharData->addFile($tempDir . '/my_subdir/child_file.txt', 'my_subdir/child_file.txt');
74    $pharData->addEmptyDir('my_subdir/empty_dir');
75    echo "ファイルとディレクトリをアーカイブに追加しました。\n";
76
77    // ---------------------------------------------------------------------------------
78    // Step 2: PharData::hasChildren() メソッドを実演します。
79    // ---------------------------------------------------------------------------------
80    echo "\n--- Step 2: PharData::hasChildren() の実演 ---\n";
81
82    // 1. ルートのPharDataオブジェクトに対して hasChildren() をチェック
83    //    アーカイブのルートにファイルやディレクトリがあるので、true を返します。
84    echo "アーカイブのルートに子要素がありますか？: " . ($pharData->hasChildren() ? 'true' : 'false') . "\n";
85
86    // 2. アーカイブ内のディレクトリ (例: 'my_subdir') に対して hasChildren() をチェック
87    //    'my_subdir' には 'child_file.txt' と 'empty_dir' があるので、true を返します。
88    if (isset($pharData['my_subdir'])) {
89        // アーカイブ内のディレクトリは PharData オブジェクトとして扱われます。
90        $mySubdirEntry = $pharData['my_subdir'];
91        echo "エントリ 'my_subdir' に子要素がありますか？: " . ($mySubdirEntry->hasChildren() ? 'true' : 'false') . "\n";
92    } else {
93        echo "エラー: 'my_subdir' がアーカイブ内で見つかりませんでした。\n";
94    }
95
96    // 3. アーカイブ内の空のディレクトリ (例: 'my_subdir/empty_dir') に対して hasChildren() をチェック
97    //    'empty_dir' は空なので、false を返します。
98    if (isset($pharData['my_subdir/empty_dir'])) {
99        $emptyDirEntry = $pharData['my_subdir/empty_dir'];
100        echo "エントリ 'my_subdir/empty_dir' に子要素がありますか？: " . ($emptyDirEntry->hasChildren() ? 'true' : 'false') . "\n";
101    } else {
102        echo "エラー: 'my_subdir/empty_dir' がアーカイブ内で見つかりませんでした。\n";
103    }
104
105    // 4. アーカイブ内のファイル (例: 'root_file.txt') に対して hasChildren() をチェック
106    //    ファイルは子要素を持たないので、常に false を返します。
107    if (isset($pharData['root_file.txt'])) {
108        // アーカイブ内のファイルは PharFileInfo オブジェクトとして扱われます。
109        $rootFileEntry = $pharData['root_file.txt'];
110        echo "エントリ 'root_file.txt' に子要素がありますか？: " . ($rootFileEntry->hasChildren() ? 'true' : 'false') . "\n";
111    } else {
112        echo "エラー: 'root_file.txt' がアーカイブ内で見つかりませんでした。\n";
113    }
114
115} catch (Exception $e) {
116    echo "エラーが発生しました: " . $e->getMessage() . "\n";
117} finally {
118    // ---------------------------------------------------------------------------------
119    // 後処理: 一時ファイルとアーカイブをクリーンアップします。
120    // ---------------------------------------------------------------------------------
121    echo "\n--- 後処理: クリーンアップ ---\n";
122    if (file_exists($archiveName)) {
123        unlink($archiveName);
124        echo "アーカイブ '{$archiveName}' を削除しました。\n";
125    }
126    if (file_exists($tempDir)) {
127        $rrmdir($tempDir);
128        echo "一時ディレクトリ '{$tempDir}' とその内容を削除しました。\n";
129    }
130}
131?>

PHP 8のPharDataクラスに属するhasChildren()メソッドは、PharDataアーカイブ内の特定のエントリが子要素を持っているかを確認するために使用されます。このメソッドは引数を取りません。戻り値はブール値で、子要素が存在する場合はtrueを、子要素が存在しない場合はfalseを返します。

サンプルコードでは、まず一時的なPharDataアーカイブを作成し、その中にファイルやサブディレクトリを追加します。その後、hasChildren()メソッドの挙動を、様々なエントリに対して実演しています。

具体的には、ファイルやサブディレクトリが含まれているアーカイブのルートや、中にファイルがあるディレクトリに対してhasChildren()を実行すると、子要素が存在するためtrueが返されます。しかし、中身が一切ない空のディレクトリや、ファイル自体に対してこのメソッドを実行すると、子要素を持たないためfalseが返されることが確認できます。

このメソッドを利用することで、プログラムからPharDataアーカイブ内の構造を調べ、例えば空のディレクトリには特定の処理を行わないなど、エントリの種類や内容に応じた柔軟な処理を実装することが可能になります。

Copy
1<?php
2
3// このスクリプトはPHPのPhar拡張モジュールを必要とします。
4// PharDataアーカイブの作成には、php.iniで 'phar.readonly = 0' の設定が必要な場合があります。
5
6/**
7 * PharData::hasChildren() メソッドの使用例
8 *
9 * この関数は、PharDataアーカイブが子エントリ（ファイルやディレクトリ）を
10 * 持っているかどうかを判断する方法を、システムエンジニアを目指す初心者にも
11 * わかりやすく示します。
12 * 一時的なアーカイブファイルを作成し、その状態を確認した後、クリーンアップを行います。
13 */
14function demonstratePharDataHasChildren(): void
15{
16    // 1. テスト用の一時ディレクトリとファイルを作成
17    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'phardata_example_' . uniqid();
18    $archiveFileName = $tempDir . DIRECTORY_SEPARATOR . 'my_archive.tar';
19
20    echo "--- PharData::hasChildren() メソッドのデモンストレーションを開始 ---\n";
21    echo "1. テスト用の一時ディレクトリとファイルを作成中...\n";
22
23    // 一時ディレクトリの作成
24    if (!mkdir($tempDir) && !is_dir($tempDir)) {
25        echo "エラー: 一時ディレクトリ '{$tempDir}' の作成に失敗しました。\n";
26        return;
27    }
28
29    // ディレクトリ内にファイルとサブディレクトリを作成
30    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file_a.txt', 'これは最初のファイルです。');
31    mkdir($tempDir . DIRECTORY_SEPARATOR . 'sub_folder');
32    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'sub_folder' . DIRECTORY_SEPARATOR . 'file_b.txt', 'これはサブディレクトリ内のファイルです。');
33    echo "   一時ディレクトリ '{$tempDir}' にテスト用コンテンツが作成されました。\n";
34
35    $pharData = null; // finallyブロックで参照できるよう初期化
36
37    try {
38        // 2. 作成したディレクトリからPharDataアーカイブを構築
39        // PharDataオブジェクトを新規作成し、指定されたファイルパスにアーカイブを保存します。
40        // buildFromDirectory() メソッドは、指定されたディレクトリの内容をアーカイブに追加します。
41        echo "2. テスト用ディレクトリからPharDataアーカイブを構築中...\n";
42        $pharData = new PharData($archiveFileName);
43        $pharData->buildFromDirectory($tempDir);
44        echo "   アーカイブ '{$archiveFileName}' が正常に作成されました。\n";
45
46        // 3. hasChildren() メソッドを呼び出して結果を確認
47        // このメソッドは、アーカイブが少なくとも1つの子エントリ（ファイルまたはディレクトリ）
48        // を持っている場合に true を返します。
49        echo "3. PharData::hasChildren() を呼び出して、アーカイブの子エントリを確認中...\n";
50        if ($pharData->hasChildren()) {
51            echo "   結果: このアーカイブには子エントリ（ファイルやサブディレクトリ）が含まれています。\n";
52        } else {
53            echo "   結果: このアーカイブには子エントリが含まれていません。\n";
54        }
55
56        // (オプション) アーカイブ内のエントリをリストアップして確認
57        echo "   --- アーカイブの内容一覧 ---\n";
58        // RecursiveIteratorIteratorを使用してアーカイブ内の全エントリを再帰的に走査
59        foreach (new RecursiveIteratorIterator($pharData) as $file) {
60            echo "   - " . $file->getPathName() . "\n";
61        }
62        echo "   ---------------------------\n";
63
64    } catch (Exception $e) {
65        // 例外発生時のエラーハンドリング
66        echo "エラーが発生しました: " . $e->getMessage() . "\n";
67    } finally {
68        // 4. クリーンアップ: 作成した一時ファイルとディレクトリを削除
69        echo "4. クリーンアップを開始中...\n";
70
71        // PharDataオブジェクトの参照を解除し、ファイルシステム上のアーカイブを解放
72        if ($pharData !== null) {
73            unset($pharData);
74        }
75
76        // アーカイブファイルを削除
77        if (file_exists($archiveFileName)) {
78            unlink($archiveFileName);
79            echo "   アーカイブファイル '{$archiveFileName}' を削除しました。\n";
80        }
81
82        // テスト用の一時ディレクトリとその中身を再帰的に削除
83        if (is_dir($tempDir)) {
84            $files = new RecursiveIteratorIterator(
85                new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS),
86                RecursiveIteratorIterator::CHILD_FIRST // 子要素から削除するよう設定
87            );
88
89            foreach ($files as $fileinfo) {
90                if ($fileinfo->isDir()) {
91                    rmdir($fileinfo->getRealPath()); // ディレクトリを削除
92                } else {
93                    unlink($fileinfo->getRealPath()); // ファイルを削除
94                }
95            }
96            rmdir($tempDir); // 親ディレクトリを削除
97            echo "   一時ディレクトリ '{$tempDir}' を削除しました。\n";
98        }
99        echo "クリーンアップが完了しました。\n";
100        echo "--- デモンストレーション終了 ---\n";
101    }
102}
103
104// サンプル関数を実行します
105demonstratePharDataHasChildren();
106
107?>

PHP 8のPhar拡張機能が提供するPharDataクラスは、.tarや.zipといったアーカイブファイルをプログラムで操作するために使用されます。このPharData::hasChildren()メソッドは、特定のPharDataアーカイブ内に、ファイルやサブディレクトリなどの子エントリが一つでも存在するかどうかを判定します。

このメソッドは引数を一切取りません。戻り値は真偽値（bool）で、アーカイブに子エントリが存在すればtrueを、全く子エントリがなければfalseを返します。これにより、アーカイブが空であるか、あるいは何らかのデータを含んでいるかを簡単に確認できます。

提供されたサンプルコードでは、まず一時的なディレクトリとファイルを使ってPharDataアーカイブを作成し、そのアーカイブに対してhasChildren()メソッドを適用しています。この例では子エントリを作成しているため、メソッドはtrueを返し、「子エントリが含まれている」と表示されます。これは、アーカイブの処理を進める前に、その内容の有無を効率的にチェックする際に役立つ基本的な機能です。スクリプトの最後には、作成した一時ファイルやディレクトリは適切に削除されます。