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

Copy
1<?php
2
3// PHP 8以降で利用可能な組み込みのRoundingMode enum。
4// これは数値を丸める際の振る舞いを定義するもので、手動で定義する必要はありません。
5// 例えば RoundingMode::AwayFromZero は、数値を「ゼロから遠ざかる方向へ」丸めます。
6// 例: 2.5 は 3 に、-2.5 は -3 に丸められます。
7
8/**
9 * 非同期処理の待機をシミュレートし、指定された丸めモードで数値を処理します。
10 *
11 * この関数は、PHPに直接的な「await」キーワードは存在しないものの、
12 * 時間のかかる処理の「待機」を sleep() で模倣し、
13 * その後の数値処理に PHP 8 の RoundingMode 列挙型を適用する方法を示します。
14 *
15 * @param float $value 丸め処理を行う元の数値。
16 * @param RoundingMode $mode 適用する丸めモード。
17 * @return int 処理された整数値。
18 * @throws InvalidArgumentException 未対応の丸めモードが指定された場合。
19 */
20function simulateAsyncOperationAndRound(float $value, RoundingMode $mode): int
21{
22    echo "処理を開始します。非同期データ取得を待機中...\n";
23    // PHPにはJavaScriptの 'await' のような直接的なキーワードはありません。
24    // ここでは sleep() を使って処理の「待機」を概念的に表現します。
25    // 実際の非同期処理では、PHP 8.1のFiberや、Amp、ReactPHPなどのライブラリが使われます。
26    sleep(1); // 1秒間待機
27    echo "データ取得が完了しました。\n";
28
29    echo "取得データ: " . $value . "\n";
30    echo "適用する丸めモード: " . $mode->name . " (値: " . $mode->value . ")\n";
31
32    // 指定されたRoundingModeに基づいて丸め処理を適用します。
33    // PHPの標準的な round() 関数は RoundingMode Enum を直接サポートしないため、
34    // ここでは指定されたモードの動作を switch 文で自前で実装します。
35    switch ($mode) {
36        case RoundingMode::AwayFromZero:
37            // RoundingMode::AwayFromZero: 常にゼロから遠ざかる方向へ丸めます。
38            // 例: 2.1 -> 3, 2.5 -> 3, 2.9 -> 3
39            // 例: -2.1 -> -3, -2.5 -> -3, -2.9 -> -3
40            // このロジックは、絶対値を取り四捨五入した結果に元の数値の符号を適用することで実現できます。
41            // ($value <=> 0) は宇宙船演算子で、負なら-1、0なら0、正なら1を返します。
42            return (int) (round(abs($value)) * ($value <=> 0));
43        case RoundingMode::Up:
44            // RoundingMode::Up: 常に正の無限大方向へ丸めます（切り上げ）。
45            return (int) ceil($value);
46        case RoundingMode::Down:
47            // RoundingMode::Down: 常に負の無限大方向へ丸めます（切り捨て）。
48            return (int) floor($value);
49        case RoundingMode::TowardZero:
50            // RoundingMode::TowardZero: 常にゼロ方向へ丸めます（truncate）。
51            return (int) $value;
52        case RoundingMode::HalfUp:
53            // RoundingMode::HalfUp: 最も近い整数に丸め、0.5は切り上げ。
54            return (int) round($value, 0, PHP_ROUND_HALF_UP);
55        case RoundingMode::HalfDown:
56            // RoundingMode::HalfDown: 最も近い整数に丸め、0.5は切り捨て。
57            return (int) round($value, 0, PHP_ROUND_HALF_DOWN);
58        case RoundingMode::HalfEven:
59            // RoundingMode::HalfEven: 最も近い整数に丸め、0.5は偶数方向へ。
60            return (int) round($value, 0, PHP_ROUND_HALF_EVEN);
61        case RoundingMode::HalfOdd:
62            // RoundingMode::HalfOdd: 最も近い整数に丸め、0.5は奇数方向へ。
63            return (int) round($value, 0, PHP_ROUND_HALF_ODD);
64        default:
65            throw new InvalidArgumentException("未対応の丸めモードです: " . $mode->name);
66    }
67}
68
69// このコードがCLI環境で実行された場合のみ、以下のサンプルを実行します。
70if (php_sapi_name() == 'cli') {
71    echo "--- サンプル1: 正の数と AwayFromZero 丸め ---\n";
72    $result1 = simulateAsyncOperationAndRound(2.5, RoundingMode::AwayFromZero);
73    echo "丸められた結果: " . $result1 . "\n\n"; // 期待値: 3
74
75    echo "--- サンプル2: 負の数と AwayFromZero 丸め ---\n";
76    $result2 = simulateAsyncOperationAndRound(-2.5, RoundingMode::AwayFromZero);
77    echo "丸められた結果: " . $result2 . "\n\n"; // 期待値: -3
78
79    echo "--- サンプル3: 別の丸めモード (HalfUp) ---\n";
80    $result3 = simulateAsyncOperationAndRound(3.5, RoundingMode::HalfUp);
81    echo "丸められた結果: " . $result3 . "\n\n"; // 期待値: 4
82
83    echo "--- サンプル4: 別の丸めモード (TowardZero) ---\n";
84    $result4 = simulateAsyncOperationAndRound(-3.7, RoundingMode::TowardZero);
85    echo "丸められた結果: " . $result4 . "\n\n"; // 期待値: -3
86}

このPHPコードは、PHP 8以降で利用できるRoundingModeという、数値を丸める際の振る舞いを定義する機能について説明しています。特にRoundingMode::AwayFromZeroは、数値をゼロから遠ざかる方向へ丸める挙動を示します。例えば、2.5は3に、-2.5は-3に丸められます。

simulateAsyncOperationAndRound関数は、非同期処理の待機を模擬しつつ、数値を指定した丸めモードで処理します。PHPにはJavaScriptのawaitのような直接的なキーワードはありませんが、ここではsleep()を使って処理の「待機」を表現し、データ取得の完了を模倣しています。この関数は、float $valueとして丸め処理を行う元の数値、RoundingMode $modeとして適用する丸めモードを引数として受け取ります。関数内部では、switch文を使い、AwayFromZeroを含む様々なRoundingModeの動作を実装し、丸められた結果をint型の整数値として返します。これにより、データ取得後の数値に多様な丸め方を適用する例を理解できます。

Copy
1<?php
2
3/**
4 * 数値を指定された最小長でゼロ埋めして文字列化し、
5 * その後、先頭のゼロを削除して元の数値に戻すプロセスを示す関数です。
6 *
7 * システムエンジニアを目指す初心者向けに、数値の表示整形とデータクリーニングの
8 * 基本的な操作をPHP 8の推奨コーディングスタイルで提供します。
9 *
10 * PHPのRoundingMode::AwayFromZero定数は数値の丸め方に関連するものであり、
11 * 本関数で扱う「ゼロ埋め」や「ゼロ削除」の処理とは直接的な関連がないため、
12 * このサンプルコードでは使用していません。
13 *
14 * @param int $number ゼロ埋めおよび削除の対象となる整数値。
15 * @param int $minLength ゼロ埋め後の目標最小文字列長。
16 * @return array<string, string|int> ゼロ埋めされた文字列と、ゼロが削除され数値に戻された値を含む連想配列。
17 *                                   キー 'paddedString' にゼロ埋めされた文字列、
18 *                                   キー 'unpaddedNumber' に数値に戻された値が格納されます。
19 */
20function formatAndCleanNumber(int $number, int $minLength): array
21{
22    // 1. 数値を指定された最小長でゼロ埋めして文字列化します。
23    // str_pad() 関数は、文字列を指定した長さになるまで特定の文字で埋めます。
24    // (string)$number で整数値を文字列に変換し、'0' で左側を埋めます。
25    $paddedString = str_pad((string)$number, $minLength, '0', STR_PAD_LEFT);
26
27    // 2. ゼロ埋めされた文字列から先頭のゼロを削除し、数値に戻します。
28    // ltrim() 関数は、文字列の左側から指定した文字（ここでは'0'）を削除します。
29    // その後、(int) にキャストすることで、結果を整数型として取得します。
30    // 例: "00123" -> "123" -> 123
31    // 例: "0000"  -> "0"   -> 0 (0の場合は'0'が残り、数値キャストで0になる)
32    $unpaddedNumber = (int)ltrim($paddedString, '0');
33
34    // 結果を分かりやすく出力します。
35    echo "元の数値: " . $number . PHP_EOL;
36    echo "ゼロ埋めされた文字列: '" . $paddedString . "'" . PHP_EOL;
37    echo "ゼロを削除し数値に戻した値: " . $unpaddedNumber . PHP_EOL;
38
39    return [
40        'paddedString' => $paddedString,
41        'unpaddedNumber' => $unpaddedNumber,
42    ];
43}
44
45// --- 関数利用のサンプル ---
46echo "--- 例1: 5 を 3桁でゼロ埋め ---" . PHP_EOL;
47formatAndCleanNumber(5, 3);
48echo PHP_EOL;
49
50echo "--- 例2: 123 を 6桁でゼロ埋め ---" . PHP_EOL;
51formatAndCleanNumber(123, 6);
52echo PHP_EOL;
53
54echo "--- 例3: 0 を 4桁でゼロ埋め ---" . PHP_EOL;
55formatAndCleanNumber(0, 4);
56echo PHP_EOL;
57
58echo "--- 例4: 元の桁数が最小長以上の場合 (ゼロ埋めは発生しません) ---" . PHP_EOL;
59formatAndCleanNumber(12345, 3);
60echo PHP_EOL;
61

このPHPサンプルコードは、システムエンジニアを目指す初心者の方々に向けて、数値の表示整形とデータクリーニングの基本的な操作を、PHP 8の推奨コーディングスタイルで紹介しています。具体的には、formatAndCleanNumber関数が、渡された整数値を指定された最小桁数まで左側からゼロで埋めて文字列化し、その文字列から先頭のゼロを削除して再び数値に戻す一連のプロセスを実行します。

ゼロ埋め処理では、str_pad()関数を使用し、数値を文字列に変換した上で、指定の文字数になるまで左側を'0'で埋めます。その後のゼロ削除と数値への変換では、ltrim()関数で文字列の左端から'0'を取り除き、最後に(int)で整数型にキャストしています。

関数には、処理対象の整数値を指定する$numberと、ゼロ埋め後の目標最小文字列長を指定する$minLengthの2つの引数があります。戻り値としては、ゼロ埋めされた文字列と、ゼロが削除され数値に戻された値が格納された連想配列が提供され、キーはそれぞれ'paddedString'と'unpaddedNumber'です。

ご提供いただいたリファレンス情報にあるRoundingMode::AwayFromZero定数は、数値の丸め方を制御するものであり、このサンプルコードで扱っているゼロ埋めやゼロ削除の処理とは直接的な関連はありません。