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

Copy
1<?php
2
3/**
4 * mb_strtoupper() 関数と MB_CASE_UPPER_SIMPLE 定数の使用例。
5 *
6 * この関数は、マルチバイト文字を含む文字列を大文字に変換する際に、
7 * MB_CASE_UPPER_SIMPLE 定数を使用して特定の変換モードを指定する方法を示します。
8 *
9 * MB_CASE_UPPER_SIMPLE は、mb_strtoupper() 関数などのマルチバイト文字列関数において、
10 * 「単純な」大文字変換ルールを適用するためのモードを指定する定数です。
11 * これは、特定の文字が持つ複数の大文字表現のうち、最も単純な形式を選択する際に使用されます。
12 * 通常の英語文字の大文字変換ではデフォルトモード (MB_CASE_UPPER) と同じ結果になることが多いですが、
13 * 特定の言語や特殊な文字においては挙動が異なる場合があります。
14 */
15function demonstrateMbCaseUpperSimple(): void
16{
17    // 変換する元の文字列を定義します。
18    // 日本語のようなマルチバイト文字と英語の両方を含んでいます。
19    $originalString = "こんにちは World! PHP 8 の新機能。";
20    $encoding = 'UTF-8'; // 文字エンコーディングを指定することは重要です。
21
22    echo "元の文字列: " . $originalString . PHP_EOL;
23
24    // mb_strtoupper() を使用して、文字列を大文字に変換します。
25    // 第2引数でエンコーディングを指定し、第3引数で変換モードを MB_CASE_UPPER_SIMPLE に設定します。
26    // これにより、「単純な」大文字変換が適用されます。
27    $upperSimpleString = mb_strtoupper($originalString, $encoding, MB_CASE_UPPER_SIMPLE);
28    echo "MB_CASE_UPPER_SIMPLE で大文字変換: " . $upperSimpleString . PHP_EOL;
29
30    // 参考として、デフォルトのモード (MB_CASE_UPPER) での変換も示します。
31    // 第3引数を省略すると、MB_CASE_UPPER がデフォルトで適用されます。
32    // 多くの場合、MB_CASE_UPPER_SIMPLE と MB_CASE_UPPER の結果は同じになります。
33    $upperDefaultString = mb_strtoupper($originalString, $encoding);
34    echo "デフォルトモード (MB_CASE_UPPER) で大文字変換: " . $upperDefaultString . PHP_EOL;
35
36    echo PHP_EOL;
37    echo "注: この例では、日本語部分に大文字・小文字の区別がないため、" . PHP_EOL;
38    echo "    主に英語部分 ('World', 'PHP') が大文字に変換されます。" . PHP_EOL;
39    echo "    MB_CASE_UPPER_SIMPLE とデフォルトモードの出力が同じに見える場合がありますが、" . PHP_EOL;
40    echo "    これは対象となる文字によるものです。" . PHP_EOL;
41}
42
43// 上記で定義した関数を実行します。
44demonstrateMbCaseUpperSimple();

このPHPサンプルコードは、mb_strtoupper()関数とMB_CASE_UPPER_SIMPLE定数を用いて、マルチバイト文字を含む文字列を大文字に変換する方法を示しています。

mb_strtoupper()関数は、与えられた文字列を指定されたエンコーディングで大文字に変換する機能を持っています。引数としては、変換したい文字列、その文字列の文字エンコーディング、そしてオプションで変換モードを指定する定数を取ります。この関数の戻り値は、大文字に変換された新しい文字列です。

MB_CASE_UPPER_SIMPLEはPHPの組み込み定数（型はint）で、mb_strtoupper()関数などのマルチバイト文字列変換関数において、「単純な」大文字変換ルールを適用するよう指示します。これは、特定の文字が持つ複数の大文字表現の中から、最も基本的な形を選択する場合に使用されます。多くの一般的な文字や英語においては、デフォルトの変換モード（MB_CASE_UPPER）と同じ結果になることが多いですが、特定の言語や文字セットでは異なる挙動を示す可能性があります。

サンプルコードでは、「こんにちは World! PHP 8 の新機能。」という文字列をUTF-8エンコーディングで、MB_CASE_UPPER_SIMPLEを指定して大文字に変換しています。また、比較のためにデフォルトモードでの変換結果も表示しています。日本語のひらがなやカタカナには大文字・小文字の区別がないため、この例では主に英語部分が変換されます。このコードを通じて、マルチバイト文字列を扱う際に、特定の変換ルールを適用する方法を理解することができます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * マルチバイト文字列の一部分を置換し、挿入する文字列をシンプルな大文字に変換して適用する関数。
7 *
8 * PHPには `mb_substr_replace` という直接の関数は存在しませんが、
9 * `mb_substr` と文字列結合を組み合わせることで同等の機能を実現できます。
10 * この関数では、その置換処理に加えて `MB_CASE_UPPER_SIMPLE` 定数を
11 * `mb_convert_case` 関数とともに利用し、挿入する文字列をシンプルな大文字に変換します。
12 *
13 * `MB_CASE_UPPER_SIMPLE` は `mb_convert_case` 関数のモードの一つで、
14 * ロケールに依存しない一般的な大文字変換を行います。
15 * 英字（a-zなど）には効果がありますが、日本語のひらがなや漢字のように
16 * 大文字・小文字の区別がない文字には通常効果がありません。
17 *
18 * @param string $originalString 元のマルチバイト文字列。
19 * @param string $replacement 挿入する文字列。この文字列が `MB_CASE_UPPER_SIMPLE` で大文字に変換されます。
20 * @param int $start 置換を開始する位置 (文字単位)。
21 * @param int|null $length 置換する文字数。null の場合、`$start` から文字列の最後までを置換します。
22 * @param string $encoding 文字エンコーディング (デフォルトは UTF-8)。
23 * @return string 置換および大文字変換後の文字列。
24 */
25function mbReplaceWithSimpleUppercase(
26    string $originalString,
27    string $replacement,
28    int $start,
29    ?int $length = null,
30    string $encoding = 'UTF-8'
31): string {
32    $originalLength = mb_strlen($originalString, $encoding);
33
34    // 置換する長さが指定されていない場合、開始位置から文字列の最後までを対象とする
35    if ($length === null) {
36        $length = $originalLength - $start;
37    }
38
39    // 開始位置が負の場合、文字列の末尾から数える (0を下回らないように調整)
40    if ($start < 0) {
41        $start = max(0, $originalLength + $start);
42    }
43    // 置換する長さが負の場合、0として処理 (実質何も置換せず挿入のみ)
44    if ($length < 0) {
45        $length = 0;
46    }
47
48    // 挿入する文字列を MB_CASE_UPPER_SIMPLE を用いて大文字に変換
49    $convertedReplacement = mb_convert_case($replacement, MB_CASE_UPPER_SIMPLE, $encoding);
50
51    // 元の文字列の置換前部分を取得
52    $before = mb_substr($originalString, 0, $start, $encoding);
53
54    // 元の文字列の置換後部分を取得
55    $after = mb_substr($originalString, $start + $length, null, $encoding);
56
57    // 分割した文字列と変換済みの置換文字列を結合して返す
58    return $before . $convertedReplacement . $after;
59}
60
61// --- サンプルコードの利用例 ---
62
63echo "--- 日本語文字列の例 ---" . PHP_EOL;
64$japaneseText = "こんにちは、phpの世界へようこそ！";
65echo "元の文字列: " . $japaneseText . PHP_EOL;
66
67// 7文字目の"php"を"プログラミング"に置換。
68// MB_CASE_UPPER_SIMPLEは日本語には通常効果がないため、"プログラミング"はそのまま挿入されます。
69$resultJp1 = mbReplaceWithSimpleUppercase($japaneseText, "プログラミング", 7, 3);
70echo "結果: " . $resultJp1 . PHP_EOL;
71
72echo PHP_EOL . "--- 英語文字列の例 ---" . PHP_EOL;
73$englishText = "hello, php world!";
74echo "元の文字列: " . $englishText . PHP_EOL;
75
76// 1. 7文字目の"php"を"wonderful"に置換。
77// "wonderful"はMB_CASE_UPPER_SIMPLEで"WONDERFUL"に変換されて挿入されます。
78$resultEn1 = mbReplaceWithSimpleUppercase($englishText, "wonderful", 7, 3);
79echo "結果1 (7文字目から3文字を「WONDERFUL」に置換): " . $resultEn1 . PHP_EOL;
80
81// 2. 7文字目から最後までを"awesome place"に置換 (length = null)。
82// "awesome place"はMB_CASE_UPPER_SIMPLEで"AWESOME PLACE"に変換されて挿入されます。
83$resultEn2 = mbReplaceWithSimpleUppercase($englishText, "awesome place", 7, null);
84echo "結果2 (7文字目から最後までを「AWESOME PLACE」に置換): " . $resultEn2 . PHP_EOL;
85
86// 3. 末尾から7文字(" world!")を"big place"に置換 (負の開始位置)。
87// "big place"はMB_CASE_UPPER_SIMPLEで"BIG PLACE"に変換されて挿入されます。
88$resultEn3 = mbReplaceWithSimpleUppercase($englishText, "big place", -7, null);
89echo "結果3 (末尾から7文字を「BIG PLACE」に置換): " . $resultEn3 . PHP_EOL;

このPHPコードは、マルチバイト文字列（日本語のように複数のバイトで1文字を表す文字列）の一部分を、指定された文字列で置き換える機能を、mb_substr関数と文字列結合を組み合わせて実現したものです。加えて、挿入する文字列をシンプルな大文字に変換する処理を含んでいます。

ここで使われるMB_CASE_UPPER_SIMPLE定数は、mb_convert_case関数と併用されるモードの一つで、ロケール（地域や言語設定）に依存せず、一般的な英字の大文字変換を行います。例えば「hello」を「HELLO」に変換しますが、日本語のひらがなや漢字のように大文字・小文字の区別がない文字には通常効果がありません。

関数の引数$originalStringは元の文字列、$replacementは挿入し、かつ大文字変換の対象となる文字列、$startは置換を開始する位置、$lengthは置換する文字数を指定します。$lengthにnullを指定すると、$startから文字列の最後までを置換対象とします。$encodingは文字エンコーディングを指定し、デフォルトはUTF-8です。この関数は、置換と大文字変換が適用された新しい文字列を戻り値として返します。

サンプルコードの実行例では、英語文字列に対してMB_CASE_UPPER_SIMPLEが適用され、「php」が「WONDERFUL」などの大文字に変換されて挿入されていることが確認できます。一方、日本語文字列の例では、日本語部分には大文字・小文字の概念がないため、「プログラミング」という文字列はそのまま挿入され、変換効果が現れていないことが示されています。