【PHP8.x】RoundingMode::TowardsZero定数の使い方

Copy
1<?php
2
3/**
4 * RoundingMode::TowardsZero の使い方を実演します。
5 *
6 * この関数は、PHP 8で導入されたRoundingMode::TowardsZero定数を使用して、
7 * 浮動小数点数を丸める方法をデモンストレーションします。
8 * システムエンジニアを目指す初心者の方にも、数値計算の正確性が
9 * いかに重要であるかを理解していただくことを目的としています。
10 *
11 * RoundingMode::TowardsZero は、常に0に近い方向に数値を丸めます。
12 * 具体的には、正の数では小数点以下を切り捨て、負の数では小数点以下を切り上げます。
13 */
14function demonstrateRoundingTowardsZero(): void
15{
16    echo "--- RoundingMode::TowardsZero のデモンストレーション ---\n";
17    echo "このモードは、常に0に近い方向に数値を丸めます。\n";
18    echo "正の数では切り捨て、負の数では切り上げに相当します。\n\n";
19
20    // 丸め処理を試すための様々な浮動小数点数
21    $numbers = [
22        2.7,  // 正の数、小数点以下が5より大きい
23        2.3,  // 正の数、小数点以下が5より小さい
24        -2.7, // 負の数、小数点以下が5より大きい
25        -2.3, // 負の数、小数点以下が5より小さい
26        0.5,  // ちょうど中間値 (正)
27        -0.5, // ちょうど中間値 (負)
28        0.0001, // 非常に小さい正の数
29        -0.0001 // 非常に小さい負の数
30    ];
31
32    foreach ($numbers as $number) {
33        // RoundingMode::TowardsZero を使用して丸める
34        // PHP 8のround()関数は第3引数にRoundingMode enumを受け取ります。
35        $roundedTowardsZero = round($number, 0, RoundingMode::TowardsZero);
36
37        // 比較のために、デフォルトの丸めモード (RoundingMode::HalfUp、いわゆる四捨五入) で丸めた結果も表示
38        $roundedDefault = round($number);
39
40        echo "元の数値              : " . sprintf('% 9.4f', $number) . "\n";
41        echo "  - TowardsZero で丸め  : " . sprintf('% 9.4f', $roundedTowardsZero) . "\n";
42        echo "  - デフォルト (HalfUp) で丸め: " . sprintf('% 9.4f', $roundedDefault) . "\n";
43        echo "-----------------------------------------\n";
44    }
45
46    echo "\nこのデモンストレーションは、数値の丸め処理において、\n";
47    echo "デフォルトの挙動だけでなく、RoundingModeのような詳細な制御を学ぶことで、\n";
48    echo "特定のビジネスロジックや要件に合わせたより正確なシステムを構築できることを示します。\n";
49    echo "これが、PHPの基礎から応用へと進む「zero to hero」の第一歩となるでしょう。\n";
50}
51
52// 関数を実行してデモンストレーションを開始
53demonstrateRoundingTowardsZero();

PHP 8で導入されたRoundingMode::TowardsZeroは、浮動小数点数の丸め方を指定するための定数です。この定数は、数値を常に0に近い方向に丸める役割を持ちます。具体的には、正の数では小数点以下を切り捨て、負の数では小数点以下を切り上げる挙動をします。例えば、2.7は2に、-2.7は-2になります。これは、通常の四捨五入とは異なる丸め方が必要な場合に非常に便利です。round()関数の第3引数にRoundingMode::TowardsZeroを指定することで、この丸めモードを適用できます。この定数自体に引数はなく、RoundingModeという列挙型（enum）の値として機能し、round()関数に丸めモードを指示します。システムエンジニアを目指す初心者の方にとって、数値計算の細かな挙動を理解し制御することは、信頼性の高いシステムを構築する上で不可欠であり、PHPの基礎から応用へと進む「zero to hero」の過程において重要な知識となります。

Copy
1<?php
2
3// 分析対象のPHPコードを定義します。
4// ここではPHP 8で導入されたRoundingMode::TowardsZero定数を使用した例を含めます。
5// この定数は、数値を0の方向へ丸める際にround()関数などで利用されます。
6$phpCodeToAnalyze = <<<'PHP'
7<?php
8
9$num = 5.6;
10$negativeNum = -5.6;
11
12// RoundingMode::HalfUp を使用して四捨五入（一般的な丸め方）
13$roundedHalfUp = round($num, 0, RoundingMode::HalfUp); // 結果: 6.0
14$roundedNegativeHalfUp = round($negativeNum, 0, RoundingMode::HalfUp); // 結果: -6.0
15
16// RoundingMode::TowardsZero を使用して数値を0の方向に丸めます。
17// round() 関数の第3引数に指定することで、この丸めモードが適用されます。
18$roundedTowardsZero = round($num, 0, RoundingMode::TowardsZero); // 結果: 5.0
19$roundedNegativeTowardsZero = round($negativeNum, 0, RoundingMode::TowardsZero); // 結果: -5.0
20
21echo "元の値: " . $num . ", - " . $negativeNum . "\n";
22echo "HalfUpで丸めた値: " . $roundedHalfUp . ", - " . $roundedNegativeHalfUp . "\n";
23echo "TowardsZeroで丸めた値: " . $roundedTowardsZero . ", - " . $roundedNegativeTowardsZero . "\n";
24
25// このコードは RoundingMode::TowardsZero の使い方を示しています。
26PHP;
27
28/**
29 * PHPコードをトークンに分解し、特定のキーワード（RoundingMode::TowardsZero）の出現を検出する関数。
30 * システムエンジニアを目指す初心者がPHPのトークナイザーの基本的な使い方を理解し、
31 * コード内で特定の定数やパターンを検出する方法を学ぶのに役立ちます。
32 *
33 * @param string $phpCode 分析対象のPHPコード文字列
34 * @return void
35 */
36function detectRoundingModeTowardsZeroUsage(string $phpCode): void
37{
38    echo "--- PHPコード分析開始 ---\n";
39    echo "分析対象のコード:\n";
40    echo "```php\n" . $phpCode . "\n```\n\n";
41
42    // PhpToken::getAll() を使用して、PHPコード文字列を個々のトークンに分解します。
43    // これはPHP 8.0 以降で利用可能な、よりオブジェクト指向的なトークナイザーAPIです。
44    // 各トークンは PhpToken オブジェクトとして表現され、そのID、テキスト、行番号などの情報を含みます。
45    $tokens = PhpToken::getAll($phpCode);
46
47    $found = false;
48
49    // 分解されたトークンを順番に検査します。
50    // 'RoundingMode::TowardsZero' という連続する3つのトークンシーケンスを探します。
51    for ($i = 0; $i < count($tokens); $i++) {
52        // 現在のトークンのテキストが 'RoundingMode' であるか確認します。
53        if ($tokens[$i]->text === 'RoundingMode') {
54            // 次のトークンが存在し、そのテキストがクラス定数アクセス演算子 '::' であるか確認します。
55            // (T_PAAMAYIM_NEKUDOTAYIM のテキスト表現は '::' です)
56            if (isset($tokens[$i + 1]) && $tokens[$i + 1]->text === '::') {
57                // さらにその次のトークンが存在し、そのテキストが 'TowardsZero' であるか確認します。
58                if (isset($tokens[$i + 2]) && $tokens[$i + 2]->text === 'TowardsZero') {
59                    echo "コード内で 'RoundingMode::TowardsZero' の使用を発見しました。\n";
60                    echo " - 発見行番号: " . $tokens[$i]->line . "\n";
61                    $found = true;
62                    // 最初の出現を見つけたら、これ以上検索する必要がないためループを終了します。
63                    break;
64                }
65            }
66        }
67    }
68
69    if (!$found) {
70        echo "コード内で 'RoundingMode::TowardsZero' の使用は見つかりませんでした。\n";
71    }
72    echo "--- PHPコード分析終了 ---\n";
73}
74
75// 定義した関数を実行し、上記のPHPコードを分析します。
76detectRoundingModeTowardsZeroUsage($phpCodeToAnalyze);

このPHPサンプルコードは、RoundingMode::TowardsZero定数の利用方法と、PHPコードを分析するPhpToken::getAll()の基本的な使い方を示しています。

RoundingMode::TowardsZeroはPHP 8で導入された定数で、round()関数などで数値を丸める際に「0の方向へ丸める」という挙動を指定します。例えば、正の数では小数点以下を切り捨て、負の数では小数点以下を切り上げて0に近づけます。サンプルコードでは、5.6が5.0に、-5.6が-5.0になる例が示されており、round()関数の第3引数として指定されています。

detectRoundingModeTowardsZeroUsage関数は、分析対象のPHPコード文字列を引数（string $phpCode）として受け取り、戻り値はありません（void）。この関数内では、PhpToken::getAll()を使ってPHPコードを個々の「トークン」と呼ばれる最小単位に分解しています。PhpToken::getAll()はPHP 8以降で利用可能な機能で、コードの構造をプログラムで解析する際に役立ちます。分解されたトークン配列を順に検査し、'RoundingMode'、'::'、'TowardsZero'という連続したトークンシーケンスが見つかることで、RoundingMode::TowardsZero定数がコード内で使用されていることを検出しています。これにより、コード内の特定の要素を自動的に検索し、その使用状況を把握する方法を理解できます。