【PHP8.x】PhpToken::posプロパティの使い方

Copy
1<?php
2
3// Define a sample PHP code string to analyze.
4// This example includes references to 'POST' and '$_POST',
5// connecting to the 'php post' keyword context.
6// PhpToken is used for parsing PHP code, not for handling HTTP requests directly.
7$phpCode = <<<'PHP_CODE_STRING'
8<?php
9
10// Check if the request method is POST.
11if ($_SERVER['REQUEST_METHOD'] === 'POST') {
12    // Access POST data. The 'param' key might or might not exist.
13    $data = $_POST['param'] ?? 'default_value'; 
14    echo "Processing POST request data: " . htmlspecialchars($data);
15} else {
16    echo "Please send a POST request to this script to see data processing.";
17}
18PHP_CODE_STRING;
19
20// Tokenize the PHP code string.
21// PhpToken::tokenize() breaks the code into an array of PhpToken objects,
22// where each object represents a meaningful piece of the code (like keywords, variables, operators).
23$tokens = PhpToken::tokenize($phpCode);
24
25echo "Analyzing PHP code tokens and their positions:\n";
26echo "------------------------------------------------\n";
27
28// Iterate through each token and display its details.
29foreach ($tokens as $token) {
30    // PhpToken::pos property returns the starting position (offset) of the token
31    // within the original PHP code string. This position is 0-indexed.
32    // It's useful for understanding where specific elements are located in the code.
33    echo sprintf(
34        "Token ID: %-25s | Text: '%-30s' | Position (offset): %d\n",
35        PhpToken::getTokenName($token->id) ?? "Unknown ({$token->id})", // Get human-readable token name
36        str_replace(["\n", "\r"], ['\n', '\r'], $token->text), // Replace newlines for cleaner output
37        $token->pos
38    );
39
40    // Highlight tokens specifically related to 'POST' for better understanding.
41    if ($token->text === 'POST') {
42        echo "  <-- This 'POST' keyword token starts at position " . $token->pos . "\n";
43    } elseif ($token->text === '$_POST') {
44        echo "  <-- This '$_POST' superglobal token starts at position " . $token->pos . "\n";
45    }
46}
47
48echo "------------------------------------------------\n";
49echo "End of token analysis.\n";
50
51// Example of how to programmatically find a specific token's position.
52echo "\nSearching for the first '$_POST' token:\n";
53foreach ($tokens as $token) {
54    if ($token->text === '$_POST') {
55        echo "Found '$_POST' token at position: " . $token->pos . " in the code.\n";
56        break; // Stop after finding the first occurrence
57    }
58}

PhpToken::posは、PHPバージョン8で導入されたPhpTokenクラスに属するプロパティです。このプロパティは、PHPコードをプログラム的に解析する際に用いられ、コードを構成する意味のある最小単位である各「トークン」（例えば、キーワード、変数名、演算子など）が、元のPHPコード文字列の何文字目から始まるかを示す「開始位置（オフセット）」を整数（int）として返します。引数はなく、戻り値は常に整数値となります。

サンプルコードでは、PhpToken::tokenize()関数を使ってPHPコードの文字列を個々のPhpTokenオブジェクトに分解しています。その後、それぞれのPhpTokenオブジェクトが持つposプロパティを利用して、各トークンが元のコード文字列のどの位置から開始しているかを表示しています。

例えば、HTTPのPOSTリクエストを処理する際によく登場する$_POSTというスーパーグローバル変数や、文字列としての'POST'がコードのどの位置に存在するかを、このposプロパティを使って正確に特定できます。これは、コードの構文解析ツールを作成する際や、特定のキーワードや変数がコード内のどこにあるかをプログラム的に検索・分析する際に非常に有用な機能です。PhpToken::posはHTTPリクエストを直接扱うものではなく、あくまでPHPコード文字列内の文字位置を示すものです。

Copy
1<?php
2
3/**
4 * HTTP POSTリクエストを受信し、送信されたデータを安全に処理するサンプル関数。
5 *
6 * システムエンジニアを目指す初心者向けに、Webアプリケーションにおける
7 * POSTデータの基本的な受信、サニタイズ、バリデーション処理を示します。
8 * PHP 8の推奨コーディングスタイルに従い、単一関数で動作します。
9 */
10function handlePostSubmission(): void
11{
12    // HTTPリクエストメソッドがPOSTであることを確認
13    if ($_SERVER['REQUEST_METHOD'] === 'POST') {
14        echo "<h2>POSTデータ受信</h2>\n";
15
16        // filter_input_array() を使用して、$_POSTデータを安全に取得・検証します。
17        // 各フィールドに対して、サニタイズ（安全な形式に変換）や
18        // バリデーション（正しい形式か検証）を適用します。
19        $formData = filter_input_array(INPUT_POST, [
20            'username' => [
21                'filter' => FILTER_SANITIZE_FULL_SPECIAL_CHARS, // HTML特殊文字をエンティティに変換し、XSS攻撃を防止
22                'flags'  => FILTER_FLAG_STRIP_LOW | FILTER_FLAG_STRIP_HIGH, // 不適切な文字を除去
23            ],
24            'email' => [
25                'filter' => FILTER_VALIDATE_EMAIL, // メールアドレス形式として検証
26            ],
27            'age' => [
28                'filter' => FILTER_VALIDATE_INT, // 整数値として検証
29                'options' => ['min_range' => 0, 'max_range' => 120], // 0から120までの範囲に制限
30            ],
31        ]);
32
33        // 各フィールドの処理結果を表示
34        if ($formData['username'] !== null && $formData['username'] !== false) {
35            echo "<strong>ユーザー名:</strong> " . $formData['username'] . "<br>\n";
36        } else {
37            echo "ユーザー名が無効か、送信されていません。<br>\n";
38        }
39
40        if ($formData['email'] !== null && $formData['email'] !== false) {
41            echo "<strong>メールアドレス:</strong> " . $formData['email'] . "<br>\n";
42        } else {
43            echo "メールアドレスが無効か、送信されていません。<br>\n";
44        }
45
46        if ($formData['age'] !== null && $formData['age'] !== false) {
47            echo "<strong>年齢:</strong> " . $formData['age'] . "<br>\n";
48        } else {
49            echo "年齢が無効か、送信されていません。<br>\n";
50        }
51
52    } else {
53        // POSTリクエストではない場合、データ送信用のHTMLフォームを表示
54        echo "<h2>データを送信してください</h2>\n";
55        echo '<!DOCTYPE html>
56<html lang="ja">
57<head>
58    <meta charset="UTF-8">
59    <title>POSTデータ送信フォーム</title>
60    <style>
61        body { font-family: sans-serif; margin: 2em; }
62        form div { margin-bottom: 1em; }
63        label { display: block; margin-bottom: 0.5em; font-weight: bold; }
64        input[type="text"], input[type="email"], input[type="number"] {
65            width: 300px;
66            padding: 8px;
67            border: 1px solid #ccc;
68            border-radius: 4px;
69        }
70        input[type="submit"] {
71            padding: 10px 20px;
72            background-color: #007bff;
73            color: white;
74            border: none;
75            border-radius: 4px;
76            cursor: pointer;
77            font-size: 16px;
78        }
79        input[type="submit"]:hover {
80            background-color: #0056b3;
81        }
82    </style>
83</head>
84<body>
85    <form method="POST" action="">
86        <div>
87            <label for="username">ユーザー名:</label>
88            <input type="text" id="username" name="username" value="John Doe" required>
89        </div>
90        <div>
91            <label for="email">メールアドレス:</label>
92            <input type="email" id="email" name="email" value="john.doe@example.com" required>
93        </div>
94        <div>
95            <label for="age">年齢 (0-120):</label>
96            <input type="number" id="age" name="age" value="30" min="0" max="120" required>
97        </div>
98        <div>
99            <input type="submit" value="データを送信">
100        </div>
101    </form>
102</body>
103</html>';
104    }
105}
106
107// 関数を実行してリクエストを処理します
108handlePostSubmission();

このPHPコードは、WebアプリケーションにおいてHTTP POSTリクエストで送信されたデータを安全に受信し、処理する基本的な方法をシステムエンジニアを目指す初心者向けに解説しています。

handlePostSubmission() 関数は、この一連のデータ処理を担当します。この関数は引数を受け取らず、処理結果として特定の値を返しません（void）。まず、$_SERVER['REQUEST_METHOD'] を利用して、現在のリクエストがPOSTメソッドで送信されたものであるかを確認します。

POSTリクエストの場合、filter_input_array(INPUT_POST, ...) 関数を使用して、送信されたデータ（例えばユーザー名、メールアドレス、年齢）を安全に取得・検証します。この関数は、指定された入力タイプ（ここでは INPUT_POST でPOSTデータ）に対し、各フィールドに設定されたフィルターを適用します。具体的には、username フィールドではHTML特殊文字をエスケープしてXSS攻撃を防ぐサニタイズ、email フィールドではメールアドレスの形式を検証、age フィールドでは整数値として0から120の範囲で検証します。これにより、不正なデータや悪意のある入力からアプリケーションを保護し、データの信頼性を高めます。

検証後、$formData 変数に格納された各フィールドの処理結果を確認し、有効なデータは表示し、無効なデータにはその旨を伝えるメッセージを出力します。もしリクエストがPOSTメソッドではない場合は、ユーザーがデータを入力して送信するためのHTMLフォームを表示し、データの送信を促します。このコードは、PHP 8における安全なWebデータ処理の基礎を示すものです。