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

Copy
1<?php
2
3/**
4 * PHPのiconv_strlen関数の使用例。
5 * マルチバイト文字列の正確な文字数を取得する方法を示します。
6 * 標準のstrlen関数との違いにも注目してください。
7 */
8function useIconvStrlenExample(): void
9{
10    // 日本語を含むマルチバイト文字列を定義します。
11    // この文字列はUTF-8エンコーディングで保存されていると仮定します。
12    $multibyteString = "こんにちは、PHP！"; // この文字列は10文字です
13
14    // 英語のシングルバイト文字列を定義します。
15    $singlebyteString = "Hello, PHP!"; // この文字列は11文字です
16
17    echo "--- マルチバイト文字列: '{$multibyteString}' ---\n";
18
19    // strlen() は文字列のバイト数を返します。
20    // 日本語のようなマルチバイト文字の場合、1文字が複数バイトで表現されるため、
21    // 実際の文字数とは異なる結果になります。
22    $byteCount = strlen($multibyteString);
23    echo "strlen() (バイト数): {$byteCount}\n";
24
25    // iconv_strlen() は指定されたエンコーディングでの文字列の「文字数」を返します。
26    // 日本語文字列はUTF-8で記述されているため、第2引数に'UTF-8'を指定します。
27    $charCount = iconv_strlen($multibyteString, 'UTF-8');
28
29    // iconv_strlen() はエラー時に false を返す可能性があるため、結果をチェックします。
30    if ($charCount !== false) {
31        echo "iconv_strlen() (UTF-8エンコーディングでの文字数): {$charCount}\n";
32    } else {
33        echo "エラー: iconv_strlen() の実行に失敗しました。\n";
34        echo "これは、不正なエンコーディングの指定や、無効な文字列データが原因かもしれません。\n";
35    }
36
37    echo "\n--- シングルバイト文字列: '{$singlebyteString}' ---\n";
38
39    // 英語のようなシングルバイト文字列の場合、
40    // strlen() と iconv_strlen() は同じ結果を返します。
41    $byteCountSingle = strlen($singlebyteString);
42    echo "strlen() (バイト数): {$byteCountSingle}\n";
43
44    $charCountSingle = iconv_strlen($singlebyteString, 'UTF-8');
45    if ($charCountSingle !== false) {
46        echo "iconv_strlen() (UTF-8エンコーディングでの文字数): {$charCountSingle}\n";
47    } else {
48        echo "エラー: iconv_strlen() の実行に失敗しました。\n";
49    }
50}
51
52// サンプル関数を実行します。
53useIconvStrlenExample();
54

iconv_strlen関数は、PHPでマルチバイト文字列の正確な文字数を取得するために使用されます。通常のstrlen関数が文字列のバイト数を数えるのに対し、iconv_strlenは指定された文字エンコーディングに基づいて、実際に人間が認識する「文字」の数を数えます。

サンプルコードでは、日本語の「こんにちは、PHP！」という文字列と、英語の「Hello, PHP!」という文字列を例に、両関数の違いを示しています。日本語のようなマルチバイト文字を含む文字列では、strlenはバイト数である20を返しますが、iconv_strlenはエンコーディングとして'UTF-8'を指定することで、正確な文字数である10を返します。これは、日本語の文字がUTF-8エンコーディングでは1文字あたり複数バイトで表現されるためです。一方、英語のようなシングルバイト文字列の場合、strlenとiconv_strlenはどちらも同じ文字数を返します。

この関数は、最初の引数に文字数を数えたい文字列（$string）を取り、2番目の引数にはその文字列のエンコーディング（$encoding）を指定します。$encodingの指定は非常に重要で、正しくないエンコーディングを指定すると、正確な文字数を取得できなかったり、関数がエラーを返したりする可能性があります。関数の戻り値は、成功した場合は整数値の文字数ですが、エラーが発生した場合はfalseを返します。そのため、falseが返されていないかを常に確認し、適切なエラー処理を行うことが推奨されます。

Webアプリケーションなどでユーザー入力の文字数制限を設ける場合や、データベースへの保存前に文字列の長さを検証する際など、マルチバイト文字を正確に扱いたい場面で非常に役立つ関数です。

Copy
1<?php
2
3/**
4 * iconv_strlen と mb_strlen を使用して文字列の文字数を取得するサンプルコード。
5 *
6 * iconv_strlen は iconv 拡張機能、mb_strlen は mbstring 拡張機能に依存します。
7 * これらの関数は、マルチバイト文字（日本語、絵文字など）を含む文字列の
8 * 正しい「文字数」を数えるために使用されます。
9 *
10 * システムエンジニアを目指す初心者の方へ：
11 * PHPの標準関数 strlen() は文字列の「バイト数」を返します。
12 * 例えばUTF-8エンコーディングの日本語1文字は3バイト、絵文字は4バイト以上になるため、
13 * strlen() を使用すると意図しない結果になります。
14 * そこで、iconv_strlen() や mb_strlen() のようなマルチバイト対応の関数が不可欠です。
15 * Web開発で広く使われるUTF-8エンコーディングでは、特に重要になります。
16 */
17
18function demonstrateStringLengthFunctions(): void
19{
20    // テスト用の文字列を用意
21    $string_single_byte = "Hello, PHP!"; // 全てシングルバイト文字
22    $string_multi_byte = "こんにちは世界！"; // 日本語（マルチバイト文字）
23    $string_emoji = "PHP 8 ✨🚀"; // 絵文字を含むマルチバイト文字
24
25    echo "--- iconv_strlen の使用例 ---" . PHP_EOL;
26
27    // iconv_strlen は、第二引数で文字列のエンコーディングを明示的に指定する必要があります。
28    // 指定されたエンコーディングで文字列を解釈し、文字数を返します。
29    // エンコーディングが不正確な場合、false を返すか、誤った結果になる可能性があります。
30
31    // シングルバイト文字列の文字数を取得
32    $length_single_iconv = iconv_strlen($string_single_byte, 'UTF-8');
33    if ($length_single_iconv !== false) {
34        echo "文字列: '{$string_single_byte}' (UTF-8) -> iconv_strlen: {$length_single_iconv} 文字" . PHP_EOL;
35    } else {
36        echo "エラー: '{$string_single_byte}' の iconv_strlen 処理に失敗しました。" . PHP_EOL;
37    }
38
39    // マルチバイト文字列（日本語）の文字数を取得
40    $length_multi_iconv = iconv_strlen($string_multi_byte, 'UTF-8');
41    if ($length_multi_iconv !== false) {
42        echo "文字列: '{$string_multi_byte}' (UTF-8) -> iconv_strlen: {$length_multi_iconv} 文字" . PHP_EOL;
43    } else {
44        echo "エラー: '{$string_multi_byte}' の iconv_strlen 処理に失敗しました。" . PHP_EOL;
45    }
46
47    // 絵文字を含む文字列の文字数を取得
48    $length_emoji_iconv = iconv_strlen($string_emoji, 'UTF-8');
49    if ($length_emoji_iconv !== false) {
50        echo "文字列: '{$string_emoji}' (UTF-8) -> iconv_strlen: {$length_emoji_iconv} 文字" . PHP_EOL;
51    } else {
52        echo "エラー: '{$string_emoji}' の iconv_strlen 処理に失敗しました。" . PHP_EOL;
53    }
54
55    echo PHP_EOL . "--- mb_strlen との比較 ---" . PHP_EOL;
56
57    // mb_strlen は、PHPでマルチバイト文字列を扱う際に一般的に推奨される関数です。
58    // mbstring 拡張機能が有効な場合に利用できます。
59    if (extension_loaded('mbstring')) {
60        // mb_strlen も第二引数でエンコーディングを指定できます。
61        // mbstring.internal_encoding が適切に設定されている場合は省略も可能ですが、
62        // 明示的な指定が推奨されます。
63        $length_single_mb = mb_strlen($string_single_byte, 'UTF-8');
64        echo "文字列: '{$string_single_byte}' (UTF-8) -> mb_strlen: {$length_single_mb} 文字" . PHP_EOL;
65
66        $length_multi_mb = mb_strlen($string_multi_byte, 'UTF-8');
67        echo "文字列: '{$string_multi_byte}' (UTF-8) -> mb_strlen: {$length_multi_mb} 文字" . PHP_EOL;
68
69        $length_emoji_mb = mb_strlen($string_emoji, 'UTF-8');
70        echo "文字列: '{$string_emoji}' (UTF-8) -> mb_strlen: {$length_emoji_mb} 文字" . PHP_EOL;
71    } else {
72        echo "注意: mbstring 拡張機能が有効ではないため、mb_strlen の例はスキップされます。" . PHP_EOL;
73    }
74
75    echo PHP_EOL . "--- 通常の strlen() との比較 (バイト数) ---" . PHP_EOL;
76
77    // strlen() は文字列のバイト数を返します。
78    // マルチバイト文字を含む文字列では、文字数とバイト数が異なります。
79    echo "文字列: '{$string_multi_byte}' -> strlen(): " . strlen($string_multi_byte) . " バイト (文字数ではない)" . PHP_EOL;
80}
81
82// 関数を実行して結果を表示
83demonstrateStringLengthFunctions();
84

このサンプルコードは、PHPで文字列の文字数を正確に取得する方法として、iconv_strlen関数とmb_strlen関数を紹介しています。PHPの標準関数であるstrlen()は文字列の「バイト数」を返しますが、日本語のようなマルチバイト文字や絵文字を含む文字列では、1文字が複数バイトになるため、見た目の文字数と一致しません。そこで、これらのマルチバイト対応関数が重要になります。

iconv_strlen関数は、指定されたエンコーディングに基づいて文字列の文字数を返します。第一引数に数えたい文字列、第二引数にその文字列のエンコーディング（例: 'UTF-8'）を指定します。エンコーディングが正しくない場合や処理に失敗した場合はfalseを返します。サンプルコードでは、「Hello, PHP!」のようなシングルバイト文字、日本語の「こんにちは世界！」、絵文字を含む「PHP 8 ✨🚀」といった様々な文字列に対してiconv_strlenを使用し、それぞれ正しい文字数を取得できることを示しています。

また、サンプルコードではmb_strlen関数との比較も行っています。mb_strlenも同様にマルチバイト対応の文字数取得関数で、PHPのmbstring拡張機能が有効な場合に利用できます。これも第二引数でエンコーディングを指定することで、正確な文字数を数えることができます。これらの関数は、特にWeb開発で広く使われるUTF-8エンコーディングにおいて、文字列の処理を正確に行うために不可欠です。strlen()が返すバイト数とは異なり、これらの関数は私たちが「文字」と認識する単位で数を数えるため、システムエンジニアとして文字列を扱う際に役立ちます。