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

Copy
1<?php
2
3/**
4 * iconv_substr と iconv_strlen 関数の使用例
5 *
6 * この関数は、多バイト文字を含む文字列（例：日本語）から安全に部分文字列を抽出し、
7 * その正確な文字数を取得する方法を示します。
8 * PHPで多バイト文字を扱う際の基本的な手法として、システムエンジニアを目指す初心者に役立ちます。
9 */
10function demonstrateIconvFunctions(): void
11{
12    // ① 多バイト文字を含む文字列を定義します。
13    $multibyteString = "これはPHPの多バイト文字の例です。";
14    // 使用する文字エンコーディングを指定します。通常は 'UTF-8' です。
15    $encoding = 'UTF-8';
16
17    echo "元の文字列: " . $multibyteString . "\n";
18    echo "使用エンコーディング: " . $encoding . "\n\n";
19
20    // ② iconv_strlen() を使用して、多バイト文字文字列の「文字数」を正確に取得します。
21    //    PHPの標準関数 strlen() は「バイト数」を返すため、多バイト文字では正確な文字数を示しません。
22    $stringLength = iconv_strlen($multibyteString, $encoding);
23
24    if ($stringLength === false) {
25        echo "エラー: iconv_strlen で文字数を取得できませんでした。\n";
26        return;
27    }
28
29    echo "strlen() によるバイト数: " . strlen($multibyteString) . " バイト\n";
30    echo "iconv_strlen() による文字数: " . $stringLength . " 文字\n\n";
31
32    // ③ iconv_substr() を使用して、多バイト文字文字列から部分文字列を抽出します。
33    //    $offset（開始位置）と $length（長さ）は、バイト数ではなく「文字数」で指定します。
34
35    // 例1: 文字列の最初の5文字を抽出します。
36    $offset1 = 0; // 開始位置（0から数えます）
37    $length1 = 5; // 抽出する文字数
38    $subString1 = iconv_substr($multibyteString, $offset1, $length1, $encoding);
39
40    if ($subString1 === false) {
41        echo "エラー: iconv_substr で部分文字列を抽出できませんでした (例1)。\n";
42    } else {
43        echo "最初の {$length1} 文字を抽出 (オフセット {$offset1}): '" . $subString1 . "'\n";
44        echo "抽出された部分文字列の文字数: " . iconv_strlen($subString1, $encoding) . " 文字\n\n";
45    }
46
47    // 例2: 7文字目から4文字を抽出します。
48    // オフセットは0から始まるため、7文字目はインデックス6です。
49    $offset2 = 6;
50    $length2 = 4;
51    $subString2 = iconv_substr($multibyteString, $offset2, $length2, $encoding);
52
53    if ($subString2 === false) {
54        echo "エラー: iconv_substr で部分文字列を抽出できませんでした (例2)。\n";
55    } else {
56        echo "{$offset2} 番目の文字から {$length2} 文字を抽出: '" . $subString2 . "'\n";
57        echo "抽出された部分文字列の文字数: " . iconv_strlen($subString2, $encoding) . " 文字\n\n";
58    }
59
60    // 例3: 負のオフセットを使用し、文字列の末尾から数えて部分文字列を抽出します。
61    $offset3 = -7; // 末尾から7文字目から開始
62    $length3 = 4;  // 4文字抽出
63    $subString3 = iconv_substr($multibyteString, $offset3, $length3, $encoding);
64
65    if ($subString3 === false) {
66        echo "エラー: iconv_substr で部分文字列を抽出できませんでした (例3)。\n";
67    } else {
68        echo "末尾から {$length3} 文字を抽出 (オフセット {$offset3}): '" . $subString3 . "'\n";
69        echo "抽出された部分文字列の文字数: " . iconv_strlen($subString3, $encoding) . " 文字\n\n";
70    }
71
72    // 例4: $length を指定しない（または null にする）場合、オフセットから文字列の最後まで抽出されます。
73    $offset4 = 8;
74    $subString4 = iconv_substr($multibyteString, $offset4, null, $encoding);
75
76    if ($subString4 === false) {
77        echo "エラー: iconv_substr で部分文字列を抽出できませんでした (例4)。\n";
78    } else {
79        echo "{$offset4} 番目の文字から最後まで抽出: '" . $subString4 . "'\n";
80        echo "抽出された部分文字列の文字数: " . iconv_strlen($subString4, $encoding) . " 文字\n\n";
81    }
82}
83
84// 上で定義した関数を実行します。
85demonstrateIconvFunctions();

iconv_substr関数とiconv_strlen関数は、PHPで日本語などの多バイト文字を安全かつ正確に扱うために非常に重要な機能です。これらの関数は、特に文字エンコーディングを意識した文字列操作が必要なシステム開発において利用されます。

まず、iconv_strlen($string, $encoding)は、指定された文字エンコーディング$encodingに従って$stringに含まれる文字の総数を正確に取得します。PHPの標準関数であるstrlen()が文字列のバイト数を返すのに対し、iconv_strlen()は「文字数」を返します。例えば、日本語のような1文字が複数バイトで構成される場合でも、期待通りの文字数が得られます。処理に失敗した場合はfalseを返します。

次に、iconv_substr($string, $offset, ?int $length = NULL, ?string $encoding = NULL)は、多バイト文字を含む$stringから部分文字列を抽出する関数です。この関数もiconv_strlenと同様に、$encodingで指定された文字エンコーディングを考慮して処理を行います。引数$offsetは部分文字列の開始位置を文字数で指定し、文字列の先頭を0とします。負の値を指定すると、文字列の末尾から数えた位置が開始点となります。$lengthは抽出する文字数を指定し、省略（またはNULLを指定）した場合は$offsetから文字列の最後までが抽出されます。この関数も処理に失敗した際にはfalseを返します。

これらの関数を使用することで、文字化けや意図しない文字列の切り詰めを防ぎ、多バイト文字を適切に処理する堅牢なシステムを構築することができます。

Copy
1<?php
2
3/**
4 * iconv_substr関数の基本的な使用例。
5 *
6 * この関数は、指定されたエンコーディングに基づき、マルチバイト文字列からバイト数ではなく
7 * 文字数で部分文字列を安全に抽出します。
8 * 日本語のようなマルチバイト文字を含む文字列の操作に特に適しています。
9 */
10function demonstrateIconvSubstr(): void
11{
12    // 処理対象の日本語UTF-8文字列を定義します。
13    $originalString = "PHPでiconv_substr関数を使って日本語を扱います。";
14    // 文字列のエンコーディングを指定します。UTF-8が一般的です。
15    $encoding = 'UTF-8';
16
17    echo "元の文字列: " . $originalString . "\n";
18    echo "エンコーディング: " . $encoding . "\n\n";
19
20    // 例: 先頭から10文字を抽出する
21    // offsetは部分文字列の開始位置（文字単位、0から始まる）。
22    // lengthは抽出する文字数。nullの場合、offsetから文字列の最後までを抽出します。
23    $offset = 0;
24    $length = 10;
25
26    $subString = iconv_substr($originalString, $offset, $length, $encoding);
27
28    if ($subString !== false) {
29        echo "抽出された部分文字列 (オフセット{$offset}、長さ{$length}):\n";
30        echo "\"" . $subString . "\"\n"; // 期待される出力: "PHPでiconv_substr関数を"
31    } else {
32        // iconv_substrは、エンコーディングの不一致や無効なエンコーディングが指定された場合などにfalseを返します。
33        echo "エラー: iconv_substrの実行に失敗しました。\n";
34    }
35}
36
37// サンプル関数を実行します。
38demonstrateIconvSubstr();
39
40?>

PHPのiconv_substr関数は、特に日本語のようなマルチバイト文字を含む文字列から、安全に部分文字列を抽出するために使用されます。通常のsubstr関数がバイト単位で切り出すのに対し、この関数は指定されたエンコーディングに基づいて「文字単位」で処理を行うため、文字化けや意図しない部分切り出しを防ぎます。

この関数は、最初の引数$stringに処理対象の文字列を、$offsetに部分文字列の開始位置を文字数で（0から数えて）指定します。続く$length引数には抽出する文字数を指定し、これをnullにすると$offsetから文字列の最後までが抽出されます。最も重要なのが$encoding引数で、対象文字列のエンコーディング（例: 'UTF-8'）を正確に指定することで、文字の境界を正しく認識し、適切な部分文字列を生成します。

関数が成功すると、抽出された部分文字列が文字列型で返されます。しかし、エンコーディングの指定が不正だったり、処理に失敗したりした場合にはfalseが返されるため、戻り値の確認によるエラーハンドリングが重要です。

提供されたサンプルコードでは、「PHPでiconv_substr関数を使って日本語を扱います。」というUTF-8文字列に対し、先頭から10文字を抽出する例を示しています。iconv_substr($originalString, 0, 10, 'UTF-8')と記述することで、「PHPでiconv_substr関数を」という期待通りの部分文字列が取得でき、マルチバイト文字の正確な操作が可能であることがわかります。システム開発において、多言語対応や正確な文字列処理が求められる場面で、この関数は非常に役立ちます。