【PHP8.x】mb_list_encodings()関数の使い方

Copy
1<?php
2
3/**
4 * PHPの多バイト文字列関数 (mb_list_encodings, mb_convert_encoding) の使用例
5 *
6 * システムエンジニアを目指す初心者向けに、mb_list_encodings で利用可能なエンコーディングを確認し、
7 * mb_convert_encoding を使って文字列のエンコーディングを変換する基本を学びます。
8 * 特に「utf8mb4」のキーワードを意識し、絵文字を含む文字列の扱いに焦点を当てています。
9 */
10function demonstrateMbEncodings(): void
11{
12    echo "--- 1. システムで利用可能な文字エンコーディングの確認 ---\n";
13
14    // mb_list_encodings() 関数は、PHPがサポートしているすべての文字エンコーディングのリストを返します。
15    // 「utf8mb4」はUTF-8の拡張であり、通常はこのリストに「UTF-8」として含まれます。
16    // PHPのmb_convert_encoding関数では、'UTF-8'を指定すれば絵文字も正しく扱えます。
17    $availableEncodings = mb_list_encodings();
18
19    echo "利用可能なエンコーディングの例 (いくつか抜粋):\n";
20    $count = 0;
21    foreach ($availableEncodings as $encoding) {
22        echo "- {$encoding}\n";
23        $count++;
24        // 初心者向けに、すべてのリストではなく一部を表示し、UTF-8が見つかったら強調して終了
25        if ($encoding === 'UTF-8') {
26            echo "  (この 'UTF-8' は、絵文字などを扱える 'utf8mb4' 相当の文字もサポートしています。)\n";
27            break; // UTF-8が見つかったら、これ以上は表示しない
28        }
29        if ($count >= 5) { // 最初の5つを表示
30            break;
31        }
32    }
33    if (!in_array('UTF-8', $availableEncodings, true)) {
34        echo "警告: 'UTF-8' エンコーディングがシステムで利用できません。多バイト文字列処理に問題が生じる可能性があります。\n";
35        return; // UTF-8が利用できない場合は以降の処理を中断
36    } else {
37        echo "'UTF-8' エンコーディングは利用可能です。これにより絵文字（utf8mb4相当）も扱えます。\n";
38    }
39
40    echo "\n--- 2. 文字列のエンコーディング変換 (mb_convert_encoding) ---\n";
41
42    // PHPの内部エンコーディングをUTF-8に設定することを強く推奨します。
43    // これにより、mb_strlenなどの多バイト文字列関数が正しく動作します。
44    mb_internal_encoding('UTF-8');
45    echo "PHPの内部エンコーディングを '" . mb_internal_encoding() . "' に設定しました。\n";
46
47    // 変換元の文字列: 絵文字を含むUTF-8文字列を定義します。これは「utf8mb4」文字を内部に含んでいます。
48    $originalUtf8String = "こんにちは世界！🍣寿司とビール🍺";
49    echo "\n元のUTF-8文字列: " . $originalUtf8String . "\n";
50    echo "  - バイト数 (strlen): " . strlen($originalUtf8String) . "\n";
51    echo "  - 文字数 (mb_strlen): " . mb_strlen($originalUtf8String, 'UTF-8') . "\n";
52
53    // シナリオ例: 外部システムからShift_JIS形式でデータが送られてきたと仮定します。
54    // 実際のShift_JISバイト列を模擬的に作成し、これをPHPで扱えるUTF-8に変換します。
55    // (Shift_JISでは絵文字を直接表現できないため、ここでは絵文字を含まない部分でデモします。)
56    $simulatedShiftJisText = "外部からのデータです";
57    // ここではデモンストレーションのため、一時的にShift_JISに変換したバイト列を作成します。
58    // 実際のアプリケーションでは、外部から直接Shift_JISのバイト列が送られてくることを想定します。
59    $simulatedShiftJisBytes = mb_convert_encoding($simulatedShiftJisText, 'Shift_JIS', 'UTF-8');
60    echo "\n模擬Shift_JIS文字列 (バイト列 - 実際の表示は文字化けする可能性あり): " . bin2hex($simulatedShiftJisBytes) . "\n";
61    echo "  - バイト数 (strlen): " . strlen($simulatedShiftJisBytes) . "\n";
62
63    // mb_convert_encoding を使って、Shift_JIS から UTF-8 へ変換します。
64    // これにより、PHP内部で絵文字も扱えるUTF-8 (utf8mb4相当) として文字列を処理できます。
65    $convertedToUtf8String = mb_convert_encoding($simulatedShiftJisBytes, 'UTF-8', 'Shift_JIS');
66
67    echo "\nShift_JISからUTF-8へ変換後の文字列: " . $convertedToUtf8String . "\n";
68    echo "  - バイト数 (strlen): " . strlen($convertedToUtf8String) . "\n";
69    echo "  - 文字数 (mb_strlen): " . mb_strlen($convertedToUtf8String, 'UTF-8') . "\n";
70
71    echo "\n--- 3. 絵文字を含むUTF-8文字列の取り扱いについて --- \n";
72    echo "PHPの内部エンコーディングがUTF-8であれば、絵文字を含む文字列（例: " . $originalUtf8String . "）も\n";
73    echo "mb_convert_encodingを通さずにそのまま安全に扱えます。\n";
74    echo "ただし、データベースへ保存する際は、データベースの文字セットも 'utf8mb4' に設定する必要があります。\n";
75    echo "PHPのコード上では、多くの場合 'UTF-8' を指定すれば 'utf8mb4' 相当の文字も扱えます。\n";
76}
77
78// 関数の実行
79demonstrateMbEncodings();

PHPのmb_list_encodings関数は、現在実行中のPHP環境で利用可能なすべての文字エンコーディングのリストを配列として返します。この関数は引数を取りません。システムでどのような文字コードがサポートされているかを確認する際に役立ち、特に多バイト文字を扱うアプリケーション開発の基盤となります。

提供されたサンプルコードでは、まずmb_list_encodingsを使用して利用可能なエンコーディングの一覧を取得しています。このリストには、絵文字などの幅広い文字を表現できるutf8mb4に相当する「UTF-8」が含まれていることを確認しています。PHPでは通常「UTF-8」を指定することでutf8mb4の文字も適切に扱えます。

次に、多バイト文字列のエンコーディングを変換するmb_convert_encoding関数の利用例を示しています。この関数は、異なる文字エンコーディングのデータをPHPアプリケーション内で統一的に処理するために非常に重要です。例えば、外部システムから送られてきたShift_JIS形式のデータをPHPで安全に扱えるUTF-8に変換する際に使用します。サンプルコードでは、一時的にShift_JISバイト列を生成し、それをmb_convert_encodingでUTF-8に変換することで、文字化けを防ぎ正しく処理できることを示しています。

PHPで多バイト文字列を扱う際は、mb_internal_encoding関数でPHPの内部エンコーディングをUTF-8に設定することが推奨されます。これにより、mb_strlenなどの関数が正しく機能し、絵文字を含むUTF-8文字列も安全に取り扱えます。ただし、データベースに絵文字などのutf8mb4文字を保存する場合は、データベース側の文字セットもutf8mb4に設定する必要がある点に注意が必要です。これらの関数を理解することで、多様な文字コードに対応した堅牢なシステムを構築する基礎を学ぶことができます。

Copy
1<?php
2
3/**
4 * PHPのマルチバイト文字列処理機能の例を示す関数です。
5 *
6 * この関数は、システムがサポートする文字エンコーディングのリストを取得し、
7 * 特にUTF-8が利用可能であることを確認します。
8 * その後、特定の文字列をUTF-8エンコーディングに変換する基本的な方法を実演します。
9 *
10 * @return void
11 */
12function demonstrateMbEncodingConversion(): void
13{
14    echo "--- システムで利用可能な文字エンコーディングのリスト ---\n";
15
16    // mb_list_encodings() を使用して、利用可能なすべてのエンコーディングを取得します。
17    // これは、どのような文字エンコーディングに変換できるか、または入力として扱えるかを確認するために役立ちます。
18    $availableEncodings = mb_list_encodings();
19
20    // 初心者向けに、利用可能なエンコーディングの一部を表示します。
21    echo "利用可能なエンコーディングの例 (最初の5つ):\n";
22    foreach (array_slice($availableEncodings, 0, 5) as $encoding) {
23        echo "- " . $encoding . "\n";
24    }
25
26    // UTF-8がシステムでサポートされているかを確認します。
27    if (in_array('UTF-8', $availableEncodings, true)) {
28        echo "\n✓ UTF-8 はシステムでサポートされているエンコーディングです。\n";
29    } else {
30        echo "\n✗ 警告: UTF-8 はシステムでサポートされていません。変換に問題が生じる可能性があります。\n";
31    }
32
33    echo "\n--- 文字列のUTF-8エンコーディング変換の例 ---\n";
34
35    // 変換対象の文字列を準備します。ここではShift_JISからの変換を想定します。
36    // 実際のシナリオでは、ファイルの読み込みやフォームからの入力など、
37    // 変換元のエンコーディングを正確に知ることが非常に重要です。
38    $originalString = "これは日本語の文字列です。PHPのmb_convert_encodingでUTF-8に変換します。";
39    $inputEncoding = 'SJIS'; // 例として入力エンコーディングをShift_JISとします。
40
41    echo "元の文字列 (想定入力エンコーディング: {$inputEncoding}): " . $originalString . "\n";
42
43    // mb_convert_encoding() を使用して、文字列をUTF-8に変換します。
44    // 第一引数: 変換したい文字列
45    // 第二引数: 変換後のエンコーディング (出力エンコーディング)
46    // 第三引数: 変換元のエンコーディング (入力エンコーディング)。
47    //           省略した場合や自動判別させたい場合は array('SJIS', 'EUC-JP', 'UTF-8', 'auto') などの形式で指定します。
48    $utf8String = mb_convert_encoding($originalString, 'UTF-8', $inputEncoding);
49
50    echo "UTF-8 に変換された文字列: " . $utf8String . "\n";
51}
52
53// サンプル関数を実行します。
54demonstrateMbEncodingConversion();

mb_list_encodingsは、PHPがシステムで利用可能なすべての文字エンコーディングのリストを取得するための関数です。この関数は引数を必要とせず、サポートされているエンコーディング名が文字列の配列として返されます。これにより、プログラムがどのようなエンコーディングを処理できるか、あるいは特定のエンコーディング（例えばUTF-8）が利用可能であるかを事前に確認できます。

サンプルコードでは、まずmb_list_encodingsを使用して利用可能なエンコーディングの一覧を取得し、特にUTF-8がサポートされているかどうかを検証しています。この確認は、後続の文字エンコーディング変換処理が正しく行われるための前提となります。

次にmb_convert_encoding関数が登場します。この関数は、ある文字エンコーディングの文字列を別の文字エンコーディングに変換するために用いられます。第一引数に変換したい文字列、第二引数に変換後のエンコーディング、第三引数に変換元のエンコーディングを指定し、変換された文字列が戻り値として得られます。サンプルコードでは、「これは日本語の文字列です。」というShift_JISを想定した文字列を、mb_convert_encodingを使ってUTF-8エンコーディングへ変換し、その結果を表示しています。このような変換は、ウェブサイトでの表示やデータベースへの保存時など、異なるエンコーディングが混在する環境で文字化けを防ぎ、データの一貫性を保つために不可欠な処理です。