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

Copy
1<?php
2
3/**
4 * MySQLデータベースへの接続を試行し、そのステータスを確認します。
5 *
6 * この関数は、mysqli拡張機能を使用してMySQLデータベースに接続し、
7 * 接続が成功したかどうかを検証する方法を示します。
8 *
9 * @param string $host     データベースホスト (例: 'localhost')。
10 * @param string $username データベースのユーザー名。
11 * @param string $password データベースのパスワード。
12 * @param string $database 接続するデータベース名。
13 * @param int    $port     オプション。MySQLサーバーへ接続するポート番号。
14 * @return bool 接続が成功した場合はtrue、それ以外はfalseを返します。
15 */
16function checkMySqlConnectionStatus(string $host, string $username, string $password, string $database, int $port = 3306): bool
17{
18    // MySQLiのエラー報告を例外としてスローするように設定
19    // これにより、接続エラーやクエリエラーがtry-catchブロックで捕捉可能になります。
20    mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
21
22    try {
23        // 新しいmysqliオブジェクトを作成して、データベースへの接続を試みます。
24        // 接続に失敗した場合、mysqli_sql_exceptionがスローされます。
25        $mysqli = new mysqli($host, $username, $password, $database, $port);
26
27        // 接続が確立された場合、オブジェクトが返され、この行に到達します。
28        // ここで接続を閉じ、成功を返します。
29        $mysqli->close();
30        
31        return true; // 接続成功
32    } catch (mysqli_sql_exception $e) {
33        // データベース接続エラーが発生した場合、ここで捕捉されます。
34        // 初心者向けに、エラーメッセージをログに出力するか、より詳細な情報を提供できます。
35        error_log("MySQL 接続エラー: " . $e->getMessage());
36        return false; // 接続失敗
37    }
38}
39
40// データベース接続情報 (ご自身の環境に合わせて変更してください)
41$dbHost = 'localhost';
42$dbUser = 'root';
43$dbPass = 'your_password'; // ★★★ 実際のMySQLパスワードに置き換えてください ★★★
44$dbName = 'test_database'; // ★★★ 接続したいデータベース名に置き換えてください ★★★
45$dbPort = 3306; // 通常のMySQLポート
46
47// 関数を実行し、接続ステータスを表示
48if (checkMySqlConnectionStatus($dbHost, $dbUser, $dbPass, $dbName, $dbPort)) {
49    echo "MySQLデータベースへの接続に成功しました。\n";
50} else {
51    echo "MySQLデータベースへの接続に失敗しました。\n";
52    echo "接続情報、データベースの状態、またはMySQLエラーログを確認してください。\n";
53}
54
55?>

このPHPサンプルコードは、MySQLデータベースへの接続が正しく行えるかどうかを確認する方法を示しています。checkMySqlConnectionStatus関数は、指定されたホスト、ユーザー名、パスワード、データベース名、ポート番号を用いてMySQLデータベースへの接続を試みます。

関数内部では、mysqli_reportによりMySQLiのエラーを例外として扱う設定がされており、堅牢なエラーハンドリングを実現しています。try-catchブロックを使用することで、データベース接続時に発生する可能性のあるmysqli_sql_exception（接続エラーなど）を捕捉し、プログラムの予期せぬ停止を防ぎます。

接続が成功した場合、new mysqli()でデータベースオブジェクトが作成され、その後$mysqli->close()で接続を閉じ、関数はtrueを返します。接続に失敗した場合はcatchブロックが実行され、エラーメッセージをログに出力し、関数はfalseを返します。

この関数の引数には、MySQLサーバーへの接続に必要な情報（ホスト名、ユーザー名、パスワード、データベース名、ポート番号）を渡します。戻り値は、接続が成功すればブール値のtrue、失敗すればfalseです。これにより、データベースへのアクセスが可能かどうかの状態を簡単に確認できます。

Copy
1<?php
2
3/**
4 * クライアントとの接続状態を確認し、その詳細な状態を文字列で返します。
5 *
6 * この関数は主にWebサーバーで実行されるPHPスクリプトにおいて、
7 * クライアント（例: Webブラウザ）とのHTTP接続が正常であるか、
8 * または中断・タイムアウトしたかを監視するために使用されます。
9 *
10 * connection_status() は、現在のPHPスクリプトとクライアント間の接続状態を示す
11 * ビットマスク整数値を返します。この値は、以下のPHP定義済み定数と組み合わせて評価します。
12 * - CONNECTION_NORMAL (0): 接続は正常です。
13 * - CONNECTION_ABORTED (1): クライアントが接続を中断しました。
14 * - CONNECTION_TIMEOUT (2): 接続がタイムアウトしました。
15 *
16 * 注意: この関数は、PHPスクリプト内で別途開いたソケット接続
17 * (例: fsockopen() や socket_create() などで作成された外部サーバーへのソケット接続)
18 * の状態を直接チェックするものではありません。
19 *
20 * @return string 現在のクライアント接続状態を示す説明文
21 */
22function getClientConnectionStatus(): string
23{
24    $status = connection_status(); // 現在のクライアント接続状態を取得
25
26    $statusMessages = [];
27
28    // CONNECTION_NORMAL は0であり、他のフラグが立っていない状態を示します。
29    // まず、中断またはタイムアウトのフラグが立っているかを確認します。
30    if (($status & CONNECTION_ABORTED) === CONNECTION_ABORTED) {
31        $statusMessages[] = "クライアントが接続を中断しました (CONNECTION_ABORTED).";
32    }
33    if (($status & CONNECTION_TIMEOUT) === CONNECTION_TIMEOUT) {
34        $statusMessages[] = "接続がタイムアウトしました (CONNECTION_TIMEOUT).";
35    }
36
37    // どちらのフラグも立っておらず、状態が CONNECTION_NORMAL (0) の場合
38    if (empty($statusMessages) && $status === CONNECTION_NORMAL) {
39        $statusMessages[] = "接続は正常です (CONNECTION_NORMAL).";
40    } elseif (empty($statusMessages)) {
41        // 上記のどの状態にも当てはまらない場合 (例えば、将来的な新しいステータスコードや複合状態)
42        $statusMessages[] = "不明な接続状態 (Raw Status: {$status}).";
43    }
44
45    return "接続状態: " . implode(" ", $statusMessages);
46}
47
48// スクリプトの実行例:
49// このスクリプトはWebサーバー経由で実行されることを想定しています。
50// 以下のコードは、現在の接続状態を表示し、その後一定時間処理をシミュレートしながら、
51// 接続状態が変化するかどうかを監視します。
52//
53// テスト方法:
54// 1. このPHPファイルをWebサーバーに配置し、ブラウザでアクセスします。
55// 2. ページが完全に読み込まれる前にブラウザを閉じたり、ページの読み込みを中断したりしてください。
56//    これにより "クライアントが接続を中断しました" のメッセージが表示される場合があります。
57
58echo "現在のクライアント接続状態をチェックします。\n";
59echo getClientConnectionStatus() . "\n";
60
61echo "\n30秒間処理をシミュレートします。その間に接続を切断してみてください。\n";
62for ($i = 1; $i <= 30; $i++) {
63    // 5秒ごとに接続状態をチェックし、表示
64    if (($i % 5) === 0) {
65        echo "経過時間: {$i}秒 - " . getClientConnectionStatus() . "\n";
66    }
67
68    // クライアントが接続を中断した場合、これ以上処理を続けるのは無駄な場合があるため、
69    // 処理を中断することが推奨されます。
70    if ((connection_status() & CONNECTION_ABORTED) === CONNECTION_ABORTED) {
71        echo "クライアントが接続を中断したため、処理を終了します。\n";
72        break; // ループを抜ける
73    }
74
75    sleep(1); // 1秒間処理を停止
76}
77echo "シミュレーション終了。\n";
78echo "最終接続状態: " . getClientConnectionStatus() . "\n";
79
80?>

PHPのconnection_status関数は、Webサーバーで実行されるPHPスクリプトと、それにアクセスしているクライアント（Webブラウザなど）との間のHTTP接続状態を確認するために使用されます。この関数は引数を取らず、現在の接続状態を示す整数値を返します。

戻り値の整数値はビットマスクとして扱われ、PHPの定義済み定数であるCONNECTION_NORMAL（接続が正常）、CONNECTION_ABORTED（クライアントが接続を中断）、CONNECTION_TIMEOUT（接続がタイムアウト）と組み合わせて評価することで、接続の具体的な状態を判別できます。例えば、サーバーで時間のかかる処理を実行中に、クライアントがブラウザを閉じて接続を中断したかどうかをCONNECTION_ABORTEDのフラグで検知し、無駄な処理を停止するといった用途に役立ちます。

ただし、この関数はfsockopen()などで別途開かれた外部サーバーへのソケット接続の状態を直接チェックするものではありませんのでご注意ください。サンプルコードでは、connection_status()が返す整数値をビット演算子で確認し、どの定数の状態に合致するかを判断して、現在の接続状態を分かりやすい文字列で表示しています。これにより、スクリプトの実行中にクライアントが接続を維持しているか、あるいは切断したかをリアルタイムに監視し、状況に応じた処理を行うことが可能になります。

Copy
1<?php
2
3/**
4 * 長時間実行される可能性のある処理の中で、Webクライアントとの接続状態をチェックする関数。
5 *
6 * connection_status() は、Webクライアント（ブラウザなど）がサーバーへの接続を維持しているか、
7 * または切断したかを示すビットフィールドを返します。
8 * この関数は、PHPスクリプトとWebクライアント間の接続状態を示し、
9 * データベース接続（例: MySQLi）の状態とは異なりますのでご注意ください。
10 */
11function checkClientConnectionStatus(): void
12{
13    echo "スクリプト実行を開始します。\n";
14
15    // クライアントが接続を切断してもスクリプトの実行を継続する設定。
16    // これを設定しない場合、クライアントが切断するとスクリプトも終了することがあります。
17    ignore_user_abort(true);
18
19    $maxIterations = 5;
20    for ($i = 1; $i <= $maxIterations; $i++) {
21        echo "現在処理ステップ: " . $i . "/" . $maxIterations . "。\n";
22
23        // connection_status() を呼び出し、現在の接続状態を取得します。
24        // これは、CONNECTION_NORMAL, CONNECTION_ABORTED, CONNECTION_TIMEOUT などの定数と
25        // ビット演算子で比較することで、詳細な状態を判別できます。
26        $status = connection_status();
27
28        if (($status & CONNECTION_ABORTED) === CONNECTION_ABORTED) {
29            echo "接続状態: クライアントが接続を切断しました。\n";
30            // クライアントが切断された場合でもスクリプトは継続しますが、
31            // ここで処理を終了することも可能です（例: break;）。
32        } elseif (($status & CONNECTION_TIMEOUT) === CONNECTION_TIMEOUT) {
33            echo "接続状態: 接続がタイムアウトしました。\n";
34        } elseif ($status === CONNECTION_NORMAL) {
35            echo "接続状態: 接続は正常です。\n";
36        } else {
37            echo "接続状態: その他の状態 (" . $status . ")。\n";
38        }
39
40        // 長時間かかる処理をシミュレートするため、2秒間一時停止します。
41        sleep(2);
42
43        // 出力バッファをフラッシュして、クライアントにメッセージがすぐに届くようにします。
44        // Webブラウザでテストする際に、進行状況が表示されるようになります。
45        ob_flush();
46        flush();
47    }
48
49    echo "スクリプト実行が完了しました。\n";
50}
51
52// 関数を実行します。
53// このスクリプトをWebサーバー経由で実行し、途中でブラウザを閉じたり、
54// リロードしたりすることで、connection_status() の挙動を確認できます。
55checkClientConnectionStatus();
56

PHP 8のconnection_status関数は、Webサーバーで実行中のPHPスクリプトとWebクライアント（ブラウザなど）との接続状態を確認するために使用されます。この関数は引数を取らず、現在の接続状態を示す整数値（ビットフィールド）を返します。戻り値は、CONNECTION_NORMAL（正常接続）、CONNECTION_ABORTED（クライアント切断）、CONNECTION_TIMEOUT（接続タイムアウト）といったPHPの定数とビット演算子（&）を用いて比較することで、具体的な状態を判別できます。

特に長時間実行される可能性のあるスクリプトにおいて、クライアントが接続を維持しているか、あるいは切断したかをチェックする際に役立ちます。サンプルコードでは、ignore_user_abort(true)を設定し、クライアントが接続を切断してもスクリプトの実行を継続させています。その上で、ループ内でconnection_statusを定期的に呼び出し、接続状態をチェックしてメッセージを表示しています。また、ob_flush()とflush()を使用することで、処理の進行状況をリアルタイムでクライアントに送信し、ブラウザで確認できるようになります。この関数は、データベース接続の状態（例えばMySQLiの接続状態）とは異なり、あくまでPHPスクリプトとWebクライアント間の接続状態を扱う点にご注意ください。

Copy
1<?php
2
3/**
4 * クライアントとの接続状態を定期的にチェックする関数
5 *
6 * このスクリプトは、Webサーバー環境で実行する必要があります。
7 * 実行中にブラウザのタブを閉じたり、ページの読み込みを停止したりすると、
8 * 接続状態が 'ABORTED' に変わることを確認できます。
9 * コマンドライン (CLI) 環境では、接続状態は常に 'NORMAL' (0) となります。
10 *
11 * @return void
12 */
13function checkClientConnectionStatus(): void
14{
15    // PHPの実行時間制限を解除（長時間実行のため）
16    set_time_limit(0);
17    // ユーザーによる接続中断を検知できるようにする
18    ignore_user_abort(false);
19
20    header('Content-Type: text/plain; charset=utf-8');
21    // 出力バッファリングを無効にし、出力を即座にクライアントへ送信する
22    ob_end_flush();
23
24    echo "クライアントとの接続状態を15秒間、1秒ごとにチェックします。\n";
25    echo "処理中にブラウザを閉じるか、読み込みを停止してみてください。\n\n";
26    flush();
27
28    for ($i = 1; $i <= 15; $i++) {
29        // 現在の接続状態を取得する
30        // 戻り値: 0 (NORMAL), 1 (ABORTED), 2 (TIMEOUT)
31        $status = connection_status();
32
33        // 接続状態を人間が読みやすい文字列に変換
34        $statusText = match ($status) {
35            CONNECTION_NORMAL => 'NORMAL (正常)',
36            CONNECTION_ABORTED => 'ABORTED (中断)',
37            CONNECTION_TIMEOUT => 'TIMEOUT (タイムアウト)',
38            default => 'UNKNOWN (不明)',
39        };
40
41        echo "{$i}秒経過: 接続状態は {$statusText} です。\n";
42        flush();
43
44        // 接続が正常でない場合、処理を中断する
45        if ($status !== CONNECTION_NORMAL) {
46            // 本来はここでログ記録などの後処理を行う
47            error_log('Client connection was lost. Status: ' . $statusText);
48            break;
49        }
50
51        // 1秒待機
52        sleep(1);
53    }
54
55    if (connection_status() === CONNECTION_NORMAL) {
56        echo "\nチェックが完了しました。接続は正常に維持されました。\n";
57    } else {
58        echo "\nクライアントとの接続が切断されたため、処理を中断しました。\n";
59    }
60}
61
62// 関数を実行
63checkClientConnectionStatus();
64

connection_status関数は、PHPスクリプトを実行しているサーバーと、ページを閲覧しているユーザーのブラウザ（クライアント）との間の接続状態を取得するための関数です。この関数は引数を必要としません。

戻り値は、接続状態を表す整数（int型）です。主に3つの状態があり、0 (CONNECTION_NORMAL) は接続が正常な状態、1 (CONNECTION_ABORTED) はユーザーがブラウザを閉じるなどして接続が中断された状態、2 (CONNECTION_TIMEOUT) はタイムアウトによって接続が切れた状態を示します。

サンプルコードは、時間のかかる処理の途中でユーザーが離脱していないかを確認する実用的な例です。1秒ごとにconnection_status()を呼び出し、戻り値が正常を示すCONNECTION_NORMALでなくなった場合にループ処理を中断しています。これにより、ユーザーがページを離れた後もサーバー側で無駄な処理を続けることを防ぎ、リソースを効率的に使用できます。

なお、この関数はWebサーバー環境で動作させた場合に意味を持ちます。コマンドライン環境で実行した場合、接続の概念がないため常に正常状態である0を返します。