【PHP8.x】POSITIVE_SIGN定数の使い方

Copy
1<?php
2
3/**
4 * リファレンス情報に基づき定義されるとされる正の符号定数。
5 * PHP 8の標準ではこの名前の定数は一般的に認識されていませんが、
6 * 提供された情報に従い、サンプルコードの動作のため、便宜的に '+' を値として定義します。
7 * この定数は、数値が正であることを示す際に付加される符号を表します。
8 */
9const POSITIVE_SIGN = '+';
10
11/**
12 * 数値が正の整数の場合に、POSITIVE_SIGN 定数で定義された符号を付加して
13 * 文字列としてフォーマットします。
14 *
15 * システムエンジニアを目指す初心者の方へ：
16 * 定数 (constant) は、プログラムの実行中に値が変わらないデータを定義するために使用されます。
17 * ここでは、POSITIVE_SIGN という定数に '+' という文字列を格納し、
18 * 正の数にこの符号を付けて表示する例を示しています。
19 *
20 * @param int $number フォーマットする整数。
21 * @return string 符号が適用された（またはそのままの）文字列。
22 */
23function formatNumberWithPositiveSign(int $number): string
24{
25    // 引数として渡された $number が正の数（0より大きい）であるかを確認
26    if ($number > 0) {
27        // 正の数の場合、POSITIVE_SIGN 定数の値（'+'）を数値の前に結合して返す
28        return POSITIVE_SIGN . $number;
29    }
30
31    // 0 または負の数の場合は、そのまま文字列に変換して返す
32    return (string) $number;
33}

PHPのサンプルコードは、数値が正の場合に「+」符号を付加して表示する方法を示しています。まず、POSITIVE_SIGNという定数が定義されています。これはPHP 8の標準には一般的に認識される定数ではありませんが、このコードの動作のために便宜的に「+」という値を持ち、正の符号を表すものとしています。システムエンジニアを目指す初心者の方へ、定数とはプログラムの実行中にその値が変わらないデータのことで、繰り返し使用する固定値を扱う際に便利です。

次に、formatNumberWithPositiveSign関数について説明します。この関数は、$numberという整数を引数として受け取ります。関数内部では、引数の$numberが0より大きい、つまり正の数であるかどうかをif ($number > 0)で確認します。もし正の数であれば、定義済みのPOSITIVE_SIGN定数の値（「+」）と$numberを結合し、例えば「+123」のような形で文字列として返します。$numberが0または負の数である場合は、特に符号を付加せず、$numberの値をそのまま文字列に変換して返します。この関数の戻り値は、符号が適用された、またはそのままの数値の文字列表現となります。

Copy
1<?php
2
3// プログラミング言語リファレンス情報に基づき、POSITIVE_SIGN 定数を定義します。
4// PHPの標準ライブラリにはグローバルなPOSITIVE_SIGN定数は存在しないため、
5// このサンプルコード内で動作させるために定義しています。
6// この定数は、何らかの「正の符号」を表す文字列であると仮定し、ここでは '+' とします。
7if (!defined('POSITIVE_SIGN')) {
8    define('POSITIVE_SIGN', '+');
9}
10
11/**
12 * 指定されたテキスト内で POSITIVE_SIGN 定数の値が見つかる最初の位置を検索します。
13 *
14 * システムエンジニアを目指す初心者向けに、PHPで文字列内の特定の部分文字列の
15 * 位置を検索する方法を示します。これは「php position」というキーワードに
16 * 関連しており、文字列処理の基本的なスキルです。
17 *
18 * @param string $text 検索対象の文字列
19 * @return int|false 見つかった場合は0から始まる位置、見つからない場合はfalse
20 */
21function findPositiveSignPosition(string $text): int|false
22{
23    // strpos関数は、文字列 ($text) 内で指定された部分文字列 (POSITIVE_SIGN の値) が
24    // 最初に見つかる位置を返します。
25    // 見つからない場合は false を返します。
26    // PHP 8では、strposのようにfalseを返す可能性のある関数に対して、
27    // 戻り値の型として int|false (ユニオン型) を明示することが推奨されます。
28    $position = strpos($text, POSITIVE_SIGN);
29
30    return $position;
31}
32
33// 以下は、findPositiveSignPosition 関数の使用例です。
34$textWithPositiveSign = "数値: +123, -45.6, +7.89";
35$textWithoutPositiveSign = "これは正の記号を含まない文字列です。";
36$textMultipleSigns = "計算式: 10 + 20 - 5 + 3";
37
38echo "--- サンプルコード実行 ---\n\n";
39
40// ケース1: 正の記号が含まれる場合
41$pos1 = findPositiveSignPosition($textWithPositiveSign);
42echo "テキスト: '{$textWithPositiveSign}'\n";
43if ($pos1 !== false) {
44    echo "  POSITIVE_SIGN ('" . POSITIVE_SIGN . "') は位置 {$pos1} で見つかりました。\n";
45} else {
46    echo "  POSITIVE_SIGN は見つかりませんでした。\n";
47}
48echo "\n";
49
50// ケース2: 正の記号が含まれない場合
51$pos2 = findPositiveSignPosition($textWithoutPositiveSign);
52echo "テキスト: '{$textWithoutPositiveSign}'\n";
53if ($pos2 !== false) {
54    echo "  POSITIVE_SIGN ('" . POSITIVE_SIGN . "') は位置 {$pos2} で見つかりました。\n";
55} else {
56    echo "  POSITIVE_SIGN は見つかりませんでした。\n";
57}
58echo "\n";
59
60// ケース3: 複数の正の記号が含まれるが、strposは最初の位置を検出します
61$pos3 = findPositiveSignPosition($textMultipleSigns);
62echo "テキスト: '{$textMultipleSigns}'\n";
63if ($pos3 !== false) {
64    echo "  POSITIVE_SIGN ('" . POSITIVE_SIGN . "') は位置 {$pos3} で見つかりました。\n";
65} else {
66    echo "  POSITIVE_SIGN は見つかりませんでした。\n";
67}
68echo "\n";
69
70echo "--- 実行終了 ---\n";

PHP 8におけるこのサンプルコードは、文字列の中から特定の文字や記号が最初に見つかる位置を検索する基本的な方法を説明しています。ここで登場するPOSITIVE_SIGNは、通常PHPに組み込まれている定数ではなく、このコード内で'+'という値を持つ定数として独自に定義されています。これは、数値の正負を表す記号などを探す状況を想定したものです。

findPositiveSignPosition関数は、引数として受け取った文字列（$text）の中にPOSITIVE_SIGN、つまり'+'の文字がどこにあるかを調べます。検索にはstrpos関数が使用され、もし'+'が見つかれば、その文字が文字列の先頭から何文字目に位置するかを数値（0から始まるインデックス）で返します。例えば、文字列の最初の文字であれば0が返されます。もし文字列内に'+'が見つからない場合は、この関数はfalseを返します。PHP 8では、戻り値の型としてint|falseのように見つかった場合と見つからなかった場合の両方を表現できます。

この機能は、ユーザーが入力したデータの中に特定の記号が含まれているかを確認したり、文字列から必要な部分を抽出したりする際に非常に役立ちます。システムエンジニアを目指す上で、このような文字列の位置検索は、テキスト処理の基本として重要なスキルとなります。