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

Copy
1<?php
2
3// 一時的なディレクトリとファイルを作成します。
4// これは、サンプルコードが単体で動作し、ファイルシステムを操作する例を示すために必要です。
5$tempDir = __DIR__ . '/temp_glob_example';
6if (!is_dir($tempDir)) {
7    mkdir($tempDir);
8}
9file_put_contents($tempDir . '/example_file1.txt', 'Hello PHP');
10file_put_contents($tempDir . '/example_file2.log', 'Log entry');
11
12echo "--- GlobIterator::CURRENT_AS_SELF の使用例 ---" . PHP_EOL;
13echo "このフラグは、GlobIteratorが返す要素の形式を制御します。" . PHP_EOL;
14echo "CURRENT_AS_SELF を指定すると、ファイルパスの文字列が返されます。" . PHP_EOL . PHP_EOL;
15
16try {
17    // GlobIterator::CURRENT_AS_SELF フラグを指定してイテレータを作成します。
18    // このフラグにより、イテレータはファイルパス（文字列）を直接返します。
19    // ワイルドカード '*' は指定ディレクトリ内のすべてのファイルに一致します。
20    $iterator = new GlobIterator($tempDir . '/*', GlobIterator::CURRENT_AS_SELF);
21
22    echo "foreach ループでの要素の確認:" . PHP_EOL;
23    // foreach ループでイテレータを処理します。
24    // CURRENT_AS_SELF の効果により、$filePath はファイルパスの文字列になります。
25    foreach ($iterator as $filePath) {
26        echo "  型: " . gettype($filePath) . ", 値: " . $filePath . PHP_EOL;
27    }
28
29    echo PHP_EOL . "current() 関数での要素の確認:" . PHP_EOL;
30
31    // イテレータのポインタを最初の要素に巻き戻します。
32    $iterator->rewind();
33
34    // current() 関数で現在の要素を取得します。
35    // ここでも CURRENT_AS_SELF の効果により、ファイルパスの文字列が返されます。
36    if ($iterator->valid()) {
37        $firstElement = $iterator->current();
38        echo "  最初の要素の型: " . gettype($firstElement) . ", 値: " . $firstElement . PHP_EOL;
39    } else {
40        echo "  イテレータは空です。" . PHP_EOL;
41    }
42
43} catch (Exception $e) {
44    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
45} finally {
46    // 作成した一時ファイルとディレクトリをクリーンアップします。
47    if (is_file($tempDir . '/example_file1.txt')) {
48        unlink($tempDir . '/example_file1.txt');
49    }
50    if (is_file($tempDir . '/example_file2.log')) {
51        unlink($tempDir . '/example_file2.log');
52    }
53    if (is_dir($tempDir)) {
54        rmdir($tempDir);
55    }
56}
57
58?>

PHPのGlobIterator::CURRENT_AS_SELFは、ファイルシステムを探索するGlobIteratorクラスで利用される特別な定数（フラグ）です。この定数自体に引数や直接の戻り値はありませんが、GlobIteratorのオブジェクトを作成する際に指定することで、イテレータがどのようにファイルやディレクトリの情報を返すかを変更する役割を持ちます。

通常、GlobIteratorはファイルやディレクトリの詳細情報を含むSplFileInfoオブジェクトを要素として返します。しかし、コンストラクタの第二引数にGlobIterator::CURRENT_AS_SELFを指定すると、イテレータが返す各要素は、現在指し示しているファイルやディレクトリへの完全なパスを表す文字列になります。

サンプルコードでは、このフラグを指定してGlobIteratorを作成しています。そのため、foreachループでファイルパスを処理する際や、current()メソッドを使用して現在の要素を取得する際に、$filePathや$firstElement変数にはtemp_glob_example/example_file1.txtのような文字列が直接代入されます。これにより、ファイルパスをすぐに利用したい場合に、余分な処理なしでシンプルにコードを記述できるようになります。

Copy
1<?php
2
3/**
4 * 指定されたURLに対してGETリクエストを送信し、その内容を取得します。
5 * cURL拡張機能とcurl_setopt_array関数を使用して、複数のcURLオプションを一度に設定する方法を示します。
6 *
7 * @param string $url リクエストを送信するURL。
8 * @return string|false リクエストのレスポンス本文、またはエラー発生時はfalseを返します。
9 */
10function fetchUrlContent(string $url): string|false
11{
12    // cURLセッションを初期化します。
13    $ch = curl_init();
14
15    // cURLオプションを連想配列として定義します。
16    // curl_setopt_array関数は、この配列を使って複数のオプションを一度に設定できます。
17    $curlOptions = [
18        CURLOPT_URL            => $url,            // リクエストを送信するURL
19        CURLOPT_RETURNTRANSFER => true,            // レスポンスデータを文字列として受け取る（画面には出力しない）
20        CURLOPT_TIMEOUT        => 10,              // 接続タイムアウト秒数
21        CURLOPT_FOLLOWLOCATION => true,            // 3xx系のリダイレクトを自動的に追跡する
22        CURLOPT_MAXREDIRS      => 5,               // 追跡するリダイレクトの最大数
23        CURLOPT_HEADER         => false,           // レスポンスヘッダーを含めない
24        // 必要に応じて、他のcURLオプションを追加できます。
25        // 例: CURLOPT_USERAGENT => 'My Simple PHP Client',
26    ];
27
28    // curl_setopt_arrayを使用して、定義した全てのオプションを一度にcURLセッションに設定します。
29    if (!curl_setopt_array($ch, $curlOptions)) {
30        // オプション設定に失敗した場合のエラー処理
31        error_log('cURLオプションの設定に失敗しました: ' . curl_error($ch));
32        curl_close($ch);
33        return false;
34    }
35
36    // cURLセッションを実行し、レスポンスを取得します。
37    $response = curl_exec($ch);
38
39    // cURL実行中にエラーが発生したか確認します。
40    if (curl_errno($ch)) {
41        // エラーが発生した場合、エラーメッセージをログに出力し、falseを返します。
42        error_log('cURL実行エラー: ' . curl_error($ch));
43        $response = false;
44    }
45
46    // cURLセッションを閉じ、リソースを解放します。
47    curl_close($ch);
48
49    return $response;
50}
51
52// 関数を呼び出す例
53$targetUrl = 'https://www.example.com'; // 取得したいWebページのURL
54echo "Fetching content from: " . $targetUrl . "\n";
55
56$content = fetchUrlContent($targetUrl);
57
58if ($content !== false) {
59    echo "Content fetched successfully. Displaying first 200 characters:\n";
60    // 取得したコンテンツの最初の200文字を表示
61    echo substr($content, 0, 200) . "...\n";
62} else {
63    echo "Failed to fetch content from " . $targetUrl . ". Check error logs.\n";
64}

このPHPコードは、cURL拡張機能を利用して、指定されたURLからウェブコンテンツを取得するfetchUrlContent関数の使い方を示しています。この関数は、引数としてコンテンツを取得したいウェブサイトのURL（string型）を受け取ります。

関数内部では、まずcurl_init()でcURLセッションを初期化し、ウェブ通信の準備をします。次に、curl_setopt_array関数が使用されています。この関数は、複数のcURLオプション（例えば、リクエストするURLやレスポンスの扱い方、タイムアウト時間など）を連想配列として一度に設定できるため、コードが読みやすく、オプション管理が効率的になります。具体的には、CURLOPT_URLで対象URL、CURLOPT_RETURNTRANSFERでレスポンスを文字列として取得する設定、CURLOPT_TIMEOUTで通信の待機時間などを指定しています。

オプション設定後、curl_exec()で実際のウェブ通信が実行され、その結果が取得されます。通信中にエラーが発生した場合は、curl_errno()で検出され、エラーログに出力されます。処理が完了したら、curl_close()でcURLセッションを閉じ、リソースを解放します。

この関数の戻り値は、成功した場合は取得したウェブページのコンテンツ（string型）であり、通信エラーなどが発生した場合はfalseを返します。これにより、呼び出し側は取得の成否を判断し、適切な処理を行うことができます。