【PHP8.x】PharData::CURRENT_AS_SELF定数の使い方

Copy
1<?php
2
3/**
4 * PharData::CURRENT_AS_SELF 定数の利用方法を示すサンプルコード。
5 *
6 * この定数は、RecursiveIteratorIterator と組み合わせて、PharData オブジェクトの
7 * イテレーション中に 'current()' メソッドが何を返すかを制御するために使用されます。
8 * CURRENT_AS_SELF を指定すると、イテレータは現在の要素（通常は PharFileInfo オブジェクト）を
9 * そのまま返します。
10 *
11 * このスクリプトは一時的なファイルとPharアーカイブを作成し、定数の効果をデモンストレーションします。
12 */
13function demonstratePharDataCurrentAsSelf(): void
14{
15    // 一時ファイルとディレクトリの準備
16    $tempDir = sys_get_temp_dir() . '/phardata_test_' . uniqid('php_current_');
17    $pharPath = $tempDir . '/test_archive.tar';
18    $filePath1 = $tempDir . '/file_one.txt';
19    $subDirPath = $tempDir . '/sub_dir';
20    $filePath2 = $subDirPath . '/file_two.txt';
21
22    // 後処理を確実に行うためのクリーンアップ関数
23    $cleanup = function() use ($pharPath, $filePath1, $filePath2, $subDirPath, $tempDir) {
24        @unlink($pharPath); // アーカイブファイルを削除
25        @unlink($filePath1); // 作成したファイルを削除
26        @unlink($filePath2); // サブディレクトリ内のファイルを削除
27        @rmdir($subDirPath); // サブディレクトリを削除
28        @rmdir($tempDir); // 一時ディレクトリを削除
29    };
30
31    try {
32        // 1. 一時ディレクトリとダミーファイルを作成
33        if (!mkdir($tempDir) && !is_dir($tempDir)) {
34            throw new RuntimeException(sprintf('一時ディレクトリ "%s" の作成に失敗しました。', $tempDir));
35        }
36        if (!mkdir($subDirPath) && !is_dir($subDirPath)) {
37            throw new RuntimeException(sprintf('サブディレクトリ "%s" の作成に失敗しました。', $subDirPath));
38        }
39        file_put_contents($filePath1, 'これはファイル1のコンテンツです。');
40        file_put_contents($filePath2, 'これはサブディレクトリ内のファイル2のコンテンツです。');
41
42        // 2. PharDataオブジェクトを作成し、ファイルをアーカイブに追加
43        // 新しいtarアーカイブを作成します (Phar::TAR はアーカイブ形式を指定)
44        // 第2引数 0 はデフォルトのフラグ、第3引数 null はエイリアスを指定しないことを意味します。
45        $pharData = new PharData($pharPath, 0, null, Phar::TAR);
46        $pharData->addFile($filePath1, 'archive_root/file_one.txt'); // アーカイブ内のパスを指定
47        $pharData->addFile($filePath2, 'archive_root/sub_dir/file_two.txt');
48
49        echo "PharData::CURRENT_AS_SELF の値: " . PharData::CURRENT_AS_SELF . " (int型)\n\n";
50
51        // 3. PharData::CURRENT_AS_SELF 定数の利用例
52        echo "--- イテレーション例 (PharData::CURRENT_AS_SELF を使用) ---\n";
53        echo "このモードでは、イテレータの `current()` メソッドは PharFileInfo オブジェクトを返します。\n";
54        echo "イテレータのキーはアーカイブ内のパス、値は PharFileInfo オブジェクトです。\n";
55
56        // RecursiveIteratorIterator を使用してPharDataの内容を再帰的に走査
57        // RecursiveIteratorIterator::LEAVES_ONLY はファイルのみを列挙
58        // PharData::CURRENT_AS_SELF はイテレータの `current()` が PharFileInfo オブジェクトを返すように指定
59        $iterator = new RecursiveIteratorIterator(
60            $pharData,
61            RecursiveIteratorIterator::LEAVES_ONLY | PharData::CURRENT_AS_SELF
62        );
63
64        foreach ($iterator as $key => $value) {
65            // $value は PharFileInfo オブジェクトになる
66            if ($value instanceof PharFileInfo) {
67                echo "- キー: '" . $key . "', 値の型: " . get_class($value) . ", アーカイブ内パス: '" . $value->getPathname() . "'\n";
68            } else {
69                echo "- キー: '" . $key . "', 値の型: " . gettype($value) . " (予期せぬ型)\n";
70            }
71        }
72
73        echo "\n--- 比較例 (PharData::CURRENT_AS_PATHNAME を使用) ---\n";
74        echo "このモードでは、イテレータの `current()` メソッドはパス名の文字列を返します。\n";
75
76        $iteratorPathname = new RecursiveIteratorIterator(
77            $pharData,
78            RecursiveIteratorIterator::LEAVES_ONLY | PharData::CURRENT_AS_PATHNAME
79        );
80
81        foreach ($iteratorPathname as $key => $value) {
82            // $value はパス名の文字列になる
83            echo "- キー: '" . $key . "', 値の型: " . gettype($value) . ", 値: '" . $value . "'\n";
84        }
85
86    } catch (Throwable $e) {
87        // エラーが発生した場合、メッセージを表示
88        echo "エラーが発生しました: " . $e->getMessage() . "\n";
89    } finally {
90        // スクリプト終了時に一時ファイルをクリーンアップ
91        $cleanup();
92    }
93}
94
95// 関数を呼び出して実行
96demonstratePharDataCurrentAsSelf();
97
98?>

PHP 8のPharData::CURRENT_AS_SELFは、PharDataクラスに属する定数で、その値は整数型です。この定数は、主にPhar形式のアーカイブ（複数のファイルをまとめた単一ファイル）の内容を操作する際に利用されます。特に、RecursiveIteratorIteratorのようなイテレータと組み合わせて、アーカイブ内のファイルやディレクトリを一つずつ処理するループの挙動を制御します。PharData::CURRENT_AS_SELFを指定してアーカイブをイテレーションすると、イテレータのcurrent()メソッドが現在の要素であるPharFileInfoオブジェクトを返します。これにより、ループの中でファイルのパス名だけでなく、サイズ、更新日時、パーミッションといった詳細なファイル情報に直接アクセスし、プログラムで利用することが可能になります。例えば、PharData::CURRENT_AS_PATHNAMEがcurrent()メソッドでアーカイブ内のパス名を文字列として返すのに対し、CURRENT_AS_SELFはより多くの情報を持つオブジェクトを提供する点で異なります。

Copy
1<?php
2
3/**
4 * 指定されたURLに対してGETリクエストを実行し、応答内容を返します。
5 * cURL拡張機能とcurl_setopt_array関数を使用して複数のオプションを一度に設定する方法を示します。
6 *
7 * @param string $url リクエストを送信するターゲットURL。
8 * @param array $customOptions オプションとして追加または上書きするcURLオプションの連想配列。
9 *                               キーはCURLOPT_定数（例: CURLOPT_TIMEOUT）、値はその設定値です。
10 * @return string|false 成功した場合はHTTP応答の本文、失敗した場合はfalseを返します。
11 */
12function executeCurlGetRequest(string $url, array $customOptions = []): string|false
13{
14    // cURLセッションを初期化します。
15    $ch = curl_init();
16
17    // cURLセッションの初期化に失敗した場合はエラーとして扱います。
18    if ($ch === false) {
19        error_log("cURLセッションの初期化に失敗しました。");
20        return false;
21    }
22
23    // 基本的なcURLオプションを定義します。
24    // これらのオプションはほとんどのGETリクエストで共通して使用されます。
25    $defaultOptions = [
26        CURLOPT_URL            => $url,            // リクエスト先のURLを設定します。
27        CURLOPT_RETURNTRANSFER => true,            // 転送結果を文字列として返すように設定します (ブラウザへの直接出力を防ぐ)。
28        CURLOPT_TIMEOUT        => 30,              // 接続およびデータ転送の最大秒数を設定します。
29        CURLOPT_FOLLOWLOCATION => true,            // HTTPリダイレクトを自動的に追跡するように設定します。
30        CURLOPT_MAXREDIRS      => 5,               // 追跡するリダイレクトの最大数を設定します。
31        CURLOPT_USERAGENT      => 'PHP cURL Request Example/1.0', // ユーザーエージェントを設定します。
32    ];
33
34    // デフォルトオプションとカスタムオプションをマージします。
35    // カスタムオプションはデフォルトオプションを上書きできます。
36    $mergedOptions = $defaultOptions + $customOptions;
37
38    // curl_setopt_array関数を使用して、複数のcURLオプションを一度に設定します。
39    // これにより、個別にcurl_setoptを呼び出すよりもコードが簡潔になります。
40    if (!curl_setopt_array($ch, $mergedOptions)) {
41        // オプション設定に失敗した場合のエラー処理。
42        error_log("cURLオプションの設定に失敗しました: " . curl_error($ch));
43        curl_close($ch);
44        return false;
45    }
46
47    // cURLリクエストを実行し、結果を取得します。
48    $response = curl_exec($ch);
49
50    // リクエストの実行中にエラーが発生したか確認します。
51    if ($response === false) {
52        error_log("cURLリクエストの実行に失敗しました: " . curl_error($ch));
53        curl_close($ch);
54        return false;
55    }
56
57    // cURLセッションを閉じ、リソースを解放します。
58    curl_close($ch);
59
60    return $response;
61}
62
63// --- サンプル使用例 ---
64
65// テスト用のURLを設定します。
66$targetUrl = 'https://www.example.com';
67
68echo "{$targetUrl} への標準GETリクエストを実行します...\n\n";
69
70// デフォルトオプションでGETリクエストを実行します。
71$responseData = executeCurlGetRequest($targetUrl);
72
73if ($responseData !== false) {
74    echo "リクエスト成功！\n";
75    echo "HTTPステータスコード: " . (int)curl_getinfo(curl_init($targetUrl), CURLINFO_HTTP_CODE) . "\n";
76    echo "取得したコンテンツの最初の500文字:\n";
77    // 取得したコンテンツが非常に長い場合を考慮して、最初の部分のみ表示します。
78    echo mb_substr($responseData, 0, 500, 'UTF-8') . (mb_strlen($responseData) > 500 ? '...' : '') . "\n";
79} else {
80    echo "リクエスト失敗。\n";
81}
82
83echo "\n----------------------------------------\n\n";
84
85// カスタムオプションを指定してGETリクエストを実行します。
86// 例: タイムアウトを5秒に短縮し、HTTPヘッダーを含めて取得する。
87$customRequestOptions = [
88    CURLOPT_TIMEOUT        => 5,  // タイムアウトを5秒に設定。
89    CURLOPT_HEADER         => true, // 応答ヘッダーも結果に含める。
90    CURLOPT_SSL_VERIFYPEER => false, // SSL証明書の検証をスキップ (開発時のみ推奨、本番環境では注意)。
91];
92
93echo "{$targetUrl} へのカスタムオプション付きGETリクエストを実行します (タイムアウト: 5秒, ヘッダー含む)...\n\n";
94$responseDataWithCustomOptions = executeCurlGetRequest($targetUrl, $customRequestOptions);
95
96if ($responseDataWithCustomOptions !== false) {
97    echo "カスタムオプションでのリクエスト成功！\n";
98    echo "取得したコンテンツの最初の500文字:\n";
99    echo mb_substr($responseDataWithCustomOptions, 0, 500, 'UTF-8') . (mb_strlen($responseDataWithCustomOptions) > 500 ? '...' : '') . "\n";
100} else {
101    echo "カスタムオプションでのリクエスト失敗。\n";
102}
103
104?>

このPHPコードは、PHPのcURL拡張機能を使用してHTTP GETリクエストを送信し、その応答内容を取得するexecuteCurlGetRequest関数を示しています。特に重要な点は、curl_setopt_array関数を利用して、複数のcURLオプションを一度に設定できることです。これにより、オプションを一つずつ設定するcurl_setoptを繰り返し呼び出す必要がなくなり、コードの記述がより簡潔になります。

executeCurlGetRequest関数は、リクエストを送信するURLを示す文字列$urlを必須の引数として受け取ります。また、オプションでcURLのデフォルト設定をカスタマイズするための連想配列$customOptionsも受け入れます。この$customOptions配列では、CURLOPT_定数をキーとして、それぞれに対応する設定値を指定することで、タイムアウト時間やユーザーエージェントなどの動作を変更できます。関数が成功した場合、HTTP応答の本文が文字列として返されます。リクエストの初期化失敗や実行中のエラーが発生した場合は、falseが返されます。

関数内部では、まずcurl_init()でcURLセッションを初期化し、基本的なGETリクエストに必要な設定をデフォルトオプションとして定義しています。次に、引数で渡された$customOptionsとデフォルトオプションをマージし、curl_setopt_array()を使ってこれらの設定を一括でcURLセッションに適用します。設定後、curl_exec()で実際にリクエストを実行し、その結果を取得します。処理の完了後やエラー発生時には、curl_close()でcURLセッションを確実に閉じ、リソースを解放しています。

コードの後半のサンプル使用例では、この関数を具体的なURLに対して呼び出し、デフォルト設定での利用方法と、カスタムオプション（例: タイムアウト短縮、ヘッダー取得、SSL検証スキップ）を指定してより詳細な制御を行う方法が示されており、初心者がcURLの柔軟な利用方法を学ぶのに役立ちます。