【PHP8.x】get_browser()関数の使い方

Copy
1<?php
2
3/**
4 * 現在のブラウザ情報を取得し、表示します。
5 *
6 * 注意: get_browser関数を使用するには、php.iniでbrowscap設定が必要です。
7 * 例: browscap = /path/to/browscap.ini
8 * browscap.iniファイルは https://browscap.org/ からダウンロードできます。
9 *
10 * この関数はブラウザの種類、バージョン、OSなどの情報を取得しますが、
11 * ブラウザの言語設定（例: 'en-US', 'ja-JP'）は直接取得しません。
12 * ブラウザの言語設定は通常、HTTPヘッダーの 'Accept-Language' から取得します。
13 */
14function displayCurrentBrowserDetails(): void
15{
16    // 現在のHTTP User-Agentヘッダー文字列を取得します。
17    // $_SERVER['HTTP_USER_AGENT'] が存在しない場合を考慮し、デフォルト値を提供します。
18    $userAgent = $_SERVER['HTTP_USER_AGENT'] ?? 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36';
19
20    // get_browser関数を呼び出し、ブラウザ情報を取得します。
21    // 第二引数を true にすると、結果がオブジェクトではなく連想配列として返されます。
22    $browserInfo = get_browser($userAgent, true);
23
24    if ($browserInfo === false) {
25        echo "エラー: ブラウザ情報の取得に失敗しました。\n";
26        echo "php.iniの 'browscap' 設定が正しく行われているか確認してください。\n";
27        return;
28    }
29
30    echo "--- 現在のブラウザ情報 ---\n";
31    foreach ($browserInfo as $key => $value) {
32        // キーを読みやすい形式に整形し、値を出力します。
33        // 値が真偽値の場合は 'Yes' または 'No' で表示します。
34        echo sprintf(
35            "%s: %s\n",
36            str_replace('_', ' ', ucfirst($key)), // 例: 'ismobiledevice' -> 'Ismobiledevice'
37            is_bool($value) ? ($value ? 'Yes' : 'No') : $value
38        );
39    }
40    echo "--------------------------\n";
41}
42
43// 関数を実行して、現在のブラウザ情報を表示します。
44displayCurrentBrowserDetails();

PHPのget_browser関数は、ウェブブラウザの種類、バージョン、OSといった詳細情報を取得する際に利用されます。第一引数$user_agentで解析対象のUser-Agent文字列を任意で指定でき、省略した場合は現在のHTTP User-Agentが使われます。第二引数$return_arrayにtrueを渡すと、戻り値が連想配列として提供されます。関数は成功するとブラウザ情報をオブジェクトまたは配列で返し、失敗時はfalseを返します。この関数を使うには、php.iniファイルでbrowscap設定を有効にし、browscap.iniファイルのパスを指定する必要があります。サンプルコードでは、現在のUser-Agentを取得し、get_browser関数で情報を取得後、成功時にはその内容を整形して表示しています。情報取得失敗時のエラー処理も記述されています。なお、get_browser関数はブラウザの言語設定（例: 'ja-JP'）を直接取得しません。ブラウザの言語設定は通常、HTTPヘッダーのAccept-Languageから取得します。

Copy
1<?php
2
3/**
4 * 現在のユーザーエージェントからブラウザ情報を取得し、主要な情報を表示する関数。
5 *
6 * 注意: get_browser関数を使用するには、php.iniで'browscap'設定を有効にし、
7 * browscap.iniファイルへの正しいパスを指定する必要があります。
8 * 例: browscap = "ext/browscap/browscap.ini" (Windowsの場合)
9 *     browscap = "/path/to/browscap.ini" (Linuxの場合)
10 * この設定がない場合、get_browserはfalseを返すか、期待通りの情報を提供できないことがあります。
11 * browscap.iniファイルは http://browscap.org/ からダウンロードできます。
12 */
13function getAndDisplayBrowserName(): void
14{
15    // 現在のHTTPリクエストのユーザーエージェント文字列を取得します。
16    // コマンドラインから実行する場合やHTTPリクエストがない場合は、
17    // デフォルトのテスト用文字列を使用します。
18    $userAgent = $_SERVER['HTTP_USER_AGENT'] ?? 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4896.88 Safari/537.36';
19
20    echo "現在のユーザーエージェント: " . $userAgent . PHP_EOL . PHP_EOL;
21
22    // get_browser関数を呼び出し、ユーザーエージェント情報を解析します。
23    // 第2引数をtrueに設定すると、結果が連想配列として返されます。
24    $browserInfo = get_browser($userAgent, true);
25
26    // 取得結果がfalseの場合（browscap設定の問題など）
27    if ($browserInfo === false) {
28        echo "エラー: ブラウザ情報の取得に失敗しました。php.iniのbrowscap設定を確認してください。" . PHP_EOL;
29    }
30    // ブラウザ情報が配列として正常に取得できた場合
31    elseif (is_array($browserInfo)) {
32        echo "--- 取得されたブラウザ情報 ---" . PHP_EOL;
33        // 特に「ブラウザ名」を表示します。
34        echo "ブラウザ名: " . ($browserInfo['browser'] ?? '情報なし') . PHP_EOL;
35        echo "バージョン: " . ($browserInfo['version'] ?? '情報なし') . PHP_EOL;
36        echo "プラットフォーム: " . ($browserInfo['platform'] ?? '情報なし') . PHP_EOL;
37        echo "メジャーバージョン: " . ($browserInfo['majorver'] ?? '情報なし') . PHP_EOL;
38        echo "マイナーバージョン: " . ($browserInfo['minorver'] ?? '情報なし') . PHP_EOL;
39        echo "ブラウザタイプ: " . ($browserInfo['browser_type'] ?? '情報なし') . PHP_EOL;
40    }
41}
42
43// 関数を実行してブラウザ情報を表示します。
44getAndDisplayBrowserName();

PHPのget_browser関数は、ウェブブラウザがサーバーに送信する「ユーザーエージェント」という文字列を解析し、ブラウザの種類やバージョン、OSなどの詳細な情報を取得するために使用されます。この関数を正しく利用するには、PHPの設定ファイルphp.iniにおいてbrowscapディレクティブを有効にし、http://browscap.org/からダウンロードできる最新のbrowscap.iniファイルへの正しいパスを指定する必要があります。この設定がない場合、関数は期待通りの情報を返さないか、falseを返します。

引数としては、解析したいユーザーエージェント文字列を渡すことができますが、省略した場合は現在のHTTPリクエストのユーザーエージェントが自動的に利用されます。2つ目の引数をtrueに設定すると、結果が連想配列として返され、false（デフォルト）の場合はオブジェクトとして返されます。サンプルコードでは連想配列として取得しています。

戻り値は、情報が正常に取得できた場合は指定に応じたオブジェクトまたは連想配列です。解析に失敗した場合やbrowscap設定が不適切な場合はfalseが返されるため、戻り値がfalseでないかを確認する処理が重要です。サンプルコードでは、現在のユーザーエージェントを取得し、get_browser関数で解析後、ブラウザ名やバージョン、プラットフォームなどの主要な情報を表示しています。

Copy
1<?php
2
3/**
4 * ユーザーエージェント文字列からブラウザ情報を取得し、その詳細を表示する関数。
5 *
6 * この関数は `get_browser()` を利用して、指定されたユーザーエージェント、
7 * または現在のHTTPリクエストのユーザーエージェント（`$_SERVER['HTTP_USER_AGENT']`）
8 * に基づいてブラウザの詳細情報を取得します。
9 *
10 * 【重要】`get_browser()` 関数を動作させるには、`php.ini` ファイルで 'browscap' ディレクティブが
11 * 有効な `browscap.ini` ファイルへのパスを指すように設定されている必要があります。
12 * 例: `browscap = "C:\php\extras\browscap.ini"` (Windowsの場合)
13 *     `browscap = "/etc/php/browscap.ini"` (Linuxの場合)
14 * `browscap.ini` ファイルはインターネットからダウンロードできます。
15 *
16 * @param string|null $userAgent 取得するブラウザ情報の元となるユーザーエージェント文字列。
17 *                                `null` の場合、`$_SERVER['HTTP_USER_AGENT']` が使用されます。
18 * @return void
19 */
20function displayBrowserInfo(?string $userAgent = null): void
21{
22    echo "<h2>ブラウザ情報取得の例</h2>";
23
24    // 使用されるUser-Agentを表示
25    if ($userAgent === null) {
26        $actualUserAgent = $_SERVER['HTTP_USER_AGENT'] ?? 'User-Agentが利用できません (サーバー変数なし)';
27        echo "<p>現在のリクエストUser-Agent: " . htmlspecialchars($actualUserAgent) . "</p>";
28    } else {
29        $actualUserAgent = $userAgent;
30        echo "<p>指定されたUser-Agent: " . htmlspecialchars($actualUserAgent) . "</p>";
31    }
32
33    // User-Agentが有効でない場合は処理を中断
34    if (empty($actualUserAgent) || $actualUserAgent === 'User-Agentが利用できません (サーバー変数なし)') {
35        echo "<p style='color: orange;'>有効なUser-Agent文字列がないため、ブラウザ情報を取得できません。</p>";
36        return;
37    }
38
39    // get_browser() を呼び出してブラウザ情報を取得
40    // 第2引数を true にすると結果が配列で返されますが、ここではオブジェクトで受け取ります。
41    $browserInfo = get_browser($actualUserAgent, false);
42
43    // 取得結果のチェック
44    if ($browserInfo === false) {
45        echo "<p style='color: red;'>ブラウザ情報の取得に失敗しました。</p>";
46        echo "<p style='color: red;'>";
47        echo "<b>注意:</b> `get_browser()` 関数を使用するには、`php.ini` で 'browscap' ディレクティブが ";
48        echo "有効な `browscap.ini` ファイルを指すように設定されているか確認してください。";
49        echo "設定が誤っているか、`browscap.ini` が見つからない、または破損している可能性があります。";
50        echo "</p>";
51    } else {
52        echo "<p><b>取得されたブラウザ情報:</b></p>";
53        echo "<pre>";
54        // オブジェクトの内容を整形して表示
55        print_r($browserInfo);
56        echo "</pre>";
57
58        // いくつかの主要なプロパティを個別に表示することで、情報の構造を理解しやすくします。
59        echo "<p><b>主要な情報 (抜粋):</b></p>";
60        echo "<ul>";
61        echo "<li>ブラウザ名: " . htmlspecialchars($browserInfo->browser ?? '不明') . "</li>";
62        echo "<li>バージョン: " . htmlspecialchars($browserInfo->version ?? '不明') . "</li>";
63        echo "<li>プラットフォーム: " . htmlspecialchars($browserInfo->platform ?? '不明') . "</li>";
64        echo "<li>JavaScript対応: " . (($browserInfo->javascript ?? false) ? 'はい' : 'いいえ') . "</li>";
65        echo "<li>Cookies対応: " . (($browserInfo->cookies ?? false) ? 'はい' : 'いいえ') . "</li>";
66        echo "<li>デバイスタイプ: " . htmlspecialchars($browserInfo->device_type ?? '不明') . "</li>";
67        echo "</ul>";
68
69        echo "<p><i>このブラウザ情報は、ユーザーがアクセスしたWebページ (URL) と関連付けて、</i></p>";
70        echo "<p><i>どのようなデバイスやブラウザからアクセスされたか、といったユーザー環境を把握する際に活用できます。</i></p>";
71    }
72}
73
74// --- サンプルコードの実行例 ---
75
76// 1. 現在のリクエストのブラウザ情報を取得して表示する
77//    (WebブラウザからこのPHPファイルにアクセスすると、自身のUser-Agentが使用されます)
78displayBrowserInfo();
79
80echo "<hr>";
81
82// 2. 特定のUser-Agent文字列を指定してブラウザ情報を取得・表示する例
83//    (テスト目的や、アクセスログの解析などで特定の環境をシミュレートする場合に有用です)
84displayBrowserInfo("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36");
85
86echo "<hr>";
87
88// 3. 別のUser-Agent文字列の例 (モバイルデバイス)
89displayBrowserInfo("Mozilla/5.0 (iPhone; CPU iPhone OS 14_6 like Mac OS X) AppleWebKit/605.1.15 (KHTML, Mac OS X) Version/14.0.3 Mobile/15E148 Safari/604.1");
90
91?>

PHPのget_browser関数は、WebブラウザがWebサーバーに送信する「ユーザーエージェント」という情報文字列を解析し、そのブラウザに関する詳細な情報を取得するために使用されます。例えば、使用されているブラウザの種類、バージョン、オペレーティングシステム、JavaScriptやCookiesへの対応状況などがわかります。

この関数は、引数として解析したいユーザーエージェント文字列を受け取ります。もし文字列を省略（null）した場合、現在アクセスしているクライアントのユーザーエージェント（$_SERVER['HTTP_USER_AGENT']）が自動的に使用されます。第2引数をtrueにすると、取得結果は連想配列として、false（デフォルト）の場合はオブジェクトとして返されます。ブラウザ情報の取得に成功するとその情報が、失敗した場合はfalseが戻り値となります。

【重要】 get_browser関数を利用するためには、php.iniファイル内でbrowscapディレクティブが、解析用のデータベースファイルであるbrowscap.iniの正しいパスを指すように設定されている必要があります。この設定がなければ、関数は期待通りに動作せず、falseを返します。

サンプルコードでは、displayBrowserInfo関数内でこのget_browser関数を呼び出し、現在のアクセスや指定された特定のユーザーエージェント文字列からブラウザ情報を取得し、その詳細を表示しています。取得した情報は、Webサイトへのアクセス元（URL）がどのような環境から行われたかを把握し、サービスの改善や統計分析などに役立てることができます。

Copy
1<?php
2
3/**
4 * 指定されたユーザーエージェント文字列からブラウザ名とバージョン情報を取得します。
5 *
6 * 注意: この関数は、PHPの設定ファイル (php.ini) で `browscap` ディレクティブが
7 *       適切に設定されている必要があります。
8 *       最新の `browscap.ini` ファイルは https://browscap.org/ からダウンロードし、
9 *       `php.ini` 内で `browscap = "/path/to/browscap.ini"` のように設定してください。
10 *       設定がされていない場合、またはファイルの読み込みに失敗した場合は機能しません。
11 *
12 * @param string $userAgent 処理するユーザーエージェント文字列。
13 * @return string ブラウザ名とバージョンを含む文字列、またはエラーメッセージ。
14 */
15function getBrowserInfoFromUserAgent(string $userAgent): string
16{
17    // get_browser関数は、browscap.iniの設定に依存します。
18    // 設定が不適切であるか、または情報の取得に失敗した場合は false を返します。
19    // 第二引数を false にすることで、結果をオブジェクトとして取得します。
20    $browserInfo = get_browser($userAgent, false);
21
22    if ($browserInfo === false) {
23        // browscap.ini の設定が不足しているか、情報取得に失敗した場合のエラーメッセージ
24        return "ブラウザ情報の取得に失敗しました。php.iniのbrowscap設定を確認してください。";
25    }
26
27    // オブジェクトからブラウザ名とバージョン情報を安全に取得します。
28    // プロパティが存在しない場合に備え、null合体演算子 (??) を使用してデフォルト値を設定しています。
29    $browserName = $browserInfo->browser ?? '不明';
30    $browserVersion = $browserInfo->version ?? '不明';
31
32    return "ブラウザ: {$browserName}, バージョン: {$browserVersion}";
33}
34
35// --- サンプルコードの実行例 ---
36
37// Chrome ブラウザのユーザーエージェント文字列の例
38$chromeUserAgent = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36';
39echo "ユーザーエージェント: " . $chromeUserAgent . PHP_EOL;
40echo getBrowserInfoFromUserAgent($chromeUserAgent) . PHP_EOL . PHP_EOL;
41
42// Firefox ブラウザのユーザーエージェント文字列の例
43$firefoxUserAgent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/121.0';
44echo "ユーザーエージェント: " . $firefoxUserAgent . PHP_EOL;
45echo getBrowserInfoFromUserAgent($firefoxUserAgent) . PHP_EOL . PHP_EOL;
46
47// Edge ブラウザのユーザーエージェント文字列の例
48$edgeUserAgent = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36 Edg/120.0.0.0';
49echo "ユーザーエージェント: " . $edgeUserAgent . PHP_EOL;
50echo getBrowserInfoFromUserAgent($edgeUserAgent) . PHP_EOL . PHP_EOL;
51
52// 認識されない可能性のある、架空のユーザーエージェント文字列の例
53$unknownUserAgent = 'MyCustomBrowser/1.0 (Linux)';
54echo "ユーザーエージェント: " . $unknownUserAgent . PHP_EOL;
55echo getBrowserInfoFromUserAgent($unknownUserAgent) . PHP_EOL . PHP_EOL;
56
57// Webサーバー上でこのスクリプトを実行する場合、現在のブラウザ情報を取得するには
58// get_browser(null, false) を呼び出すこともできます。
59// ただし、コマンドライン (CLI) で実行する際は $_SERVER['HTTP_USER_AGENT'] が存在しないため、
60// 明示的にユーザーエージェント文字列を渡す方が動作確認に適しています。

get_browser関数は、ウェブブラウザが送信するユーザーエージェント文字列を解析し、ブラウザの種類やバージョン、オペレーティングシステムなどの詳細な情報を取得するためのPHPの機能です。この関数を利用するには、PHPの設定ファイル（php.ini）においてbrowscapディレクティブが正しく設定され、browscap.iniファイルのパスが指定されていることが必須です。この設定がない場合やファイルが読み込めない場合、関数は期待通りに動作しません。

第一引数には解析したいユーザーエージェント文字列を指定し、省略した場合は現在のHTTPリクエストのユーザーエージェントが使用されます。第二引数にtrueを渡すと結果が配列で、false（デフォルト）を渡すとオブジェクトで返されます。サンプルコードでは、結果をオブジェクトとして受け取り、ブラウザ名とバージョン情報を取得しています。

関数の戻り値は、情報が正常に取得できた場合はブラウザ情報を格納したオブジェクト、または配列です。情報が見つからない場合や、設定不備などにより取得に失敗した場合はfalseが返されます。サンプルコードでは、戻り値がfalseである場合にエラーメッセージを表示して対処し、正常な場合はオブジェクトからbrowser（ブラウザ名）やversion（バージョン）などのプロパティを安全に取り出して表示しています。プロパティが存在しない可能性に備え、??（null合体演算子）を使用してデフォルト値を設定している点も確認できます。複数のユーザーエージェント例を通じて、異なるブラウザ情報が取得できることを示しており、この関数がどのように利用されるかを具体的に理解できます。