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

Copy
1<?php
2
3/**
4 * 指定された文字列をタイトルケースに変換します。
5 * 各単語の最初の文字を大文字に、それ以外を小文字に変換します。
6 *
7 * @param string $text 変換する文字列。
8 * @param string $encoding 文字エンコーディング。デフォルトはUTF-8。
9 * @return string タイトルケースに変換された文字列。
10 */
11function convertToTitleCase(string $text, string $encoding = 'UTF-8'): string
12{
13    // MB_CASE_TITLEは、mb_convert_case関数の引数として使用され、
14    // 文字列を「タイトルケース」に変換するよう指示する定数です。
15    // タイトルケースでは、各単語の先頭文字のみが大文字になり、残りは小文字になります。
16    return mb_convert_case($text, MB_CASE_TITLE, $encoding);
17}
18
19// 変換するサンプル文字列
20$sampleText = "hello world! this is a simple example for system engineers.";
21
22// convertToTitleCase関数を呼び出し、文字列をタイトルケースに変換
23$titleCaseResult = convertToTitleCase($sampleText);
24
25// 結果を出力
26echo "元の文字列: " . $sampleText . PHP_EOL;
27echo "タイトルケースに変換された文字列: " . $titleCaseResult . PHP_EOL;
28
29?>

このPHPサンプルコードは、指定された文字列を「タイトルケース」に変換する方法を示しています。PHP 8で利用可能なMB_CASE_TITLE定数と、多バイト文字対応の文字列変換を行うmb_convert_case関数を組み合わせて使用しています。

MB_CASE_TITLEは、mb_convert_case関数の第二引数に渡す定数の一つで、文字列をタイトルケースに変換するよう指示します。タイトルケースとは、文章中の各単語の最初の文字のみを大文字に、それ以外の文字を小文字に変換する形式のことです。例えば、「hello world」は「Hello World」のように変換されます。この定数自体には引数はなく、その値は整数ですが、通常は直接値を操作せず、mb_convert_case関数に渡して利用します。

コード内のconvertToTitleCase関数は、変換したい文字列を$text引数として、また任意で文字エンコーディングを$encoding引数（デフォルトはUTF-8）として受け取ります。この関数は、内部でmb_convert_case関数を呼び出し、受け取った文字列とMB_CASE_TITLE定数、そしてエンコーディングを渡して実際の変換を行います。変換されたタイトルケースの文字列が、この関数の戻り値（string型）として返されます。

サンプルでは、「hello world! this is a simple example for system engineers.」という文字列をconvertToTitleCase関数に渡し、変換された結果を$titleCaseResult変数に格納しています。最終的に、元の文字列とタイトルケースに変換された文字列が画面に出力され、MB_CASE_TITLE定数を使った変換の具体的な効果を確認できます。このように、MB_CASE_TITLE定数を利用することで、多言語の文字列も正確にタイトルケースに整形することが可能になります。

Copy
1<?php
2
3/**
4 * マルチバイト文字列のタイトルケース変換と不正文字置換の例。
5 *
6 * この関数は、PHPのmbstring拡張機能を使用して文字列をタイトルケースに変換する方法と、
7 * 不正な文字が検出された場合の置換文字 (mb_substitute_character) の動作を示します。
8 * システムエンジニアを目指す初心者の方にも分かりやすいように、各ステップにコメントを付与しています。
9 *
10 * @param string $inputString 処理する入力文字列。
11 * @param string $inputEncoding 入力文字列のエンコーディング (例: 'UTF-8', 'SJIS' など)。
12 * @return void
13 */
14function demonstrateMbCaseTitleWithSubstitution(string $inputString, string $inputEncoding): void
15{
16    // 1. PHPの内部エンコーディングをUTF-8に設定します。
17    //    これは、マルチバイト文字列関数がデフォルトで扱うエンコーディングを指定する、推奨されるプラクティスです。
18    mb_internal_encoding("UTF-8");
19
20    echo "--- 変換処理の開始 ---" . PHP_EOL;
21    echo "入力文字列: " . $inputString . PHP_EOL;
22    echo "指定された入力エンコーディング: " . $inputEncoding . PHP_EOL;
23
24    // 2. 不正な文字が検出された場合の置換文字を「?」に設定します。
25    //    mb_convert_case などのマルチバイト文字列関数が、入力文字列内に指定された
26    //    エンコーディングとして解釈できないバイトシーケンスを見つけた場合、
27    //    この置換文字が使用されます。
28    mb_substitute_character("?");
29    echo "設定された置換文字: '?'" . PHP_EOL;
30
31    // 3. mb_convert_case 関数を使用して文字列をタイトルケースに変換します。
32    //    MB_CASE_TITLE は、各単語の最初の文字を大文字にし、残りを小文字にする定数です。
33    //    第3引数には入力文字列のエンコーディングを指定します。
34    //    入力エンコーディングが内部エンコーディングと異なる場合、自動的に変換が試みられます。
35    $convertedString = mb_convert_case($inputString, MB_CASE_TITLE, $inputEncoding);
36
37    echo "タイトルケース変換結果: " . $convertedString . PHP_EOL . PHP_EOL;
38
39    // 4. 置換文字を "[?]" に変更して、再度試すことで動作の違いを示します。
40    mb_substitute_character("[?]");
41    echo "設定された置換文字: '[?]'" . PHP_EOL;
42
43    $convertedStringWithNewSub = mb_convert_case($inputString, MB_CASE_TITLE, $inputEncoding);
44
45    echo "タイトルケース変換結果 (新しい置換文字): " . $convertedStringWithNewSub . PHP_EOL;
46    echo "--- 変換処理の終了 ---" . PHP_EOL . PHP_EOL;
47}
48
49// --- サンプル実行例 ---
50
51// ■ 正常なUTF-8文字列の例
52echo "■ 正常なUTF-8文字列の例:" . PHP_EOL;
53demonstrateMbCaseTitleWithSubstitution("hello world in php 8", "UTF-8");
54
55// ■ 日本語の正常なUTF-8文字列の例
56echo "■ 日本語の正常なUTF-8文字列の例:" . PHP_EOL;
57demonstrateMbCaseTitleWithSubstitution("これはマルチバイト文字列のテストです", "UTF-8");
58
59// ■ 不正なバイトシーケンスを含む文字列の例
60//    ここでは、Shift_JISでエンコードされた「テスト」という文字列のバイト列を、
61//    入力エンコーディングが「UTF-8」であるかのように扱わせます。
62//    この結果、UTF-8としては不正なバイトシーケンスが検出され、
63//    mb_substitute_character で設定された文字に置換されることを確認できます。
64echo "■ 不正なバイトシーケンスを含む文字列の例 (Shift_JISバイト列をUTF-8として処理):" . PHP_EOL;
65$sjisBytesOfTest = mb_convert_encoding("テスト", "SJIS", "UTF-8"); // UTF-8からSJISへ変換されたバイト列を生成
66demonstrateMbCaseTitleWithSubstitution($sjisBytesOfTest . " example", "UTF-8");
67
68// ■ さらに直接的な不正なバイトシーケンスの例
69//    \xe0 はUTF-8の3バイト文字の開始バイトですが、それに続くバイトがないため不正です。
70//    \xc0, \xc1 はUTF-8では使用されない無効なバイトです。
71echo "■ 直接不正なバイトシーケンスを含む文字列の例:" . PHP_EOL;
72demonstrateMbCaseTitleWithSubstitution("Invalid \xe0 Byte \xc0\xc1 Here", "UTF-8");

このサンプルコードは、PHPのマルチバイト文字列処理、特に文字列をタイトルケースに変換する方法と、不正な文字が検出された場合の置換動作について示すものです。

MB_CASE_TITLEは、mb_convert_case関数で使用される定数で、文字列を「タイトルケース」に変換する際に指定します。タイトルケースとは、各単語の最初の文字を大文字にし、残りを小文字にする書式のことです。この定数自体は引数を取らず、内部的に整数値（int）として機能します。

一方、mb_substitute_character関数は、PHPのマルチバイト文字列関数が、与えられたエンコーディングで解釈できない不正なバイトシーケンスに遭遇した際に、その代わりにどのような文字を挿入するかを設定するものです。引数には置換文字として使用する文字列を指定します。

サンプルコードでは、まずmb_internal_encodingで内部エンコーディングをUTF-8に設定し、次にmb_substitute_characterで置換文字を「?」や「[?]」に設定しています。その後、mb_convert_case関数を使って入力文字列をMB_CASE_TITLE形式に変換します。ここで、入力エンコーディングと内部エンコーディングが異なる場合や、不正なバイトシーケンスが含まれる場合に、mb_substitute_characterで設定した文字がどのように挿入されるかが確認できます。demonstrateMbCaseTitleWithSubstitution関数は、処理する文字列とそのエンコーディングを引数として受け取り、変換結果を表示します。これにより、マルチバイト文字を扱う際のエンコーディングの重要性と、不正文字への対処方法を理解できます。