【PHP8.x】strcoll()関数の使い方
strcoll関数の使い方について、初心者にもわかりやすく解説します。
基本的な使い方
strcoll関数は、現在のロケール設定に基づいて2つの文字列を比較する関数です。この関数は、単に文字列のバイト値を比較するstrcmp関数とは異なり、言語や地域によって異なる文字の並び順、つまり「照合順序」を考慮して比較を行います。
たとえば、ドイツ語では「ä」と「a」の順序が通常のアルファベット順と異なる場合がありますが、strcoll関数を使用すると、PHPが実行されている環境のロケール設定に応じて、これらの文字を正しく比較し、適切な並び順を決定することができます。これにより、多言語対応のアプリケーションで、ユーザーが期待する正確な文字列のソートや検索を実現できます。
strcoll関数は2つの必須引数として比較したい文字列を受け取ります。戻り値は整数値で、最初の文字列が2番目の文字列より小さい場合は負の値を、等しい場合は0を、大きい場合は正の値を返します。この戻り値は、strcmp関数と同様の形式です。
この関数を効果的に利用するには、setlocale()関数を使って適切なロケールを設定することが重要です。ロケールが設定されていない場合や、デフォルトのロケールでは意図した結果が得られないことがあります。国際化されたアプリケーションにおいて、言語に依存する文字列比較が求められる場面で特に役立つ関数です。
構文(syntax)
1<?php 2$string1 = 'Hello'; 3$string2 = 'hello'; 4$comparisonResult = strcoll($string1, $string2); 5?>
引数(parameters)
string $string1, string $string2
- string $string1: 比較対象となる最初の文字列
- string $string2: 比較対象となる2番目の文字列
戻り値(return)
int
strcoll関数は、現在のロケール設定に基づいて、2つの文字列を比較した結果を整数で返します。比較結果は、返される整数の符号によって示されます。具体的には、最初の文字列が2番目の文字列より小さい場合は負の値、等しい場合は0、大きい場合は正の値が返されます。
サンプルコード
PHP strcollでロケール比較する
1<?php 2 3/** 4 * strcoll関数の使用例をデモンストレーションします。 5 * strcollは、現在のロケール設定に基づいて2つの文字列を比較します。 6 * これは、通常の文字列比較関数 (例: strcmp) とは異なり、 7 * 特定の言語の文字順序や規則（ウムラウトなど）を考慮します。 8 * 9 * strcollの戻り値: 10 * - 0: string1 と string2 がロケールに基づいて等しい場合 11 * - 正の値: string1 が string2 より大きい場合 12 * - 負の値: string1 が string2 より小さい場合 13 */ 14function demonstrateStrcollComparison(): void 15{ 16 echo "--- strcoll関数による文字列比較のデモンストレーション ---" . PHP_EOL; 17 echo "（ロケールによって比較結果が異なる点に注目してください）" . PHP_EOL . PHP_EOL; 18 19 $string1 = "äpfel"; 20 $string2 = "apfel"; 21 $string3 = "aepfel"; 22 23 echo "比較対象の文字列:" . PHP_EOL; 24 echo " \$string1: '{$string1}'" . PHP_EOL; 25 echo " \$string2: '{$string2}'" . PHP_EOL; 26 echo " \$string3: '{$string3}'" . PHP_EOL . PHP_EOL; 27 28 // 1. デフォルト (C) ロケールでの比較 29 // Cロケールでは、言語固有の文字順序は考慮されず、通常はバイト値順で比較されます。 30 echo "1. C ロケール (setlocale(LC_ALL, 'C')):" . PHP_EOL; 31 setlocale(LC_ALL, 'C'); 32 $resultC1 = strcoll($string1, $string2); 33 $resultC2 = strcoll($string1, $string3); 34 35 echo " strcoll('{$string1}', '{$string2}'): {$resultC1} (" . 36 ($resultC1 < 0 ? "'{$string1}' は '{$string2}' より小さい)" : 37 ($resultC1 > 0 ? "'{$string1}' は '{$string2}' より大きい)" : 38 "'{$string1}' と '{$string2}' は等しい)")) . PHP_EOL; 39 40 echo " strcoll('{$string1}', '{$string3}'): {$resultC2} (" . 41 ($resultC2 < 0 ? "'{$string1}' は '{$string3}' より小さい)" : 42 ($resultC2 > 0 ? "'{$string1}' は '{$string3}' より大きい)" : 43 "'{$string1}' と '{$string3}' は等しい)")) . PHP_EOL . PHP_EOL; 44 45 // 2. ドイツ語 (de_DE) ロケールでの比較 46 // ドイツ語ロケールでは 'ä' は 'a' と同等か、それに近い順序で扱われることがあります。 47 // そのため、'äpfel' と 'apfel' が異なる結果になることがあります。 48 echo "2. ドイツ語ロケール (例: setlocale(LC_ALL, 'de_DE.UTF-8', 'de_DE', 'German_Germany.1252')):" . PHP_EOL; 49 // 環境によって利用可能なロケール名が異なるため、複数の候補を試します。 50 if (setlocale(LC_ALL, 'de_DE.UTF-8', 'de_DE', 'German_Germany.1252')) { 51 $resultDE1 = strcoll($string1, $string2); 52 $resultDE2 = strcoll($string1, $string3); 53 54 echo " strcoll('{$string1}', '{$string2}'): {$resultDE1} (" . 55 ($resultDE1 < 0 ? "'{$string1}' は '{$string2}' より小さい)" : 56 ($resultDE1 > 0 ? "'{$string1}' は '{$string2}' より大きい)" : 57 "'{$string1}' と '{$string2}' は等しい)")) . PHP_EOL; 58 59 echo " strcoll('{$string1}', '{$string3}'): {$resultDE2} (" . 60 ($resultDE2 < 0 ? "'{$string1}' は '{$string3}' より小さい)" : 61 ($resultDE2 > 0 ? "'{$string1}' は '{$string3}' より大きい)" : 62 "'{$string1}' と '{$string3}' は等しい)")) . PHP_EOL; 63 } else { 64 echo " ドイツ語ロケールの設定に失敗しました。Cロケールと同様の結果になる可能性があります。" . PHP_EOL; 65 } 66 echo PHP_EOL; 67 68 // 3. 英語 (en_US) ロケールでの比較 69 // 英語ロケールでは 'ä' は 'a' とは異なる文字として扱われるか、バイト値に基づいて比較されます。 70 echo "3. 英語ロケール (例: setlocale(LC_ALL, 'en_US.UTF-8', 'en_US', 'English_United States.1252')):" . PHP_EOL; 71 // 環境によって利用可能なロケール名が異なるため、複数の候補を試します。 72 if (setlocale(LC_ALL, 'en_US.UTF-8', 'en_US', 'English_United States.1252')) { 73 $resultEN1 = strcoll($string1, $string2); 74 $resultEN2 = strcoll($string1, $string3); 75 76 echo " strcoll('{$string1}', '{$string2}'): {$resultEN1} (" . 77 ($resultEN1 < 0 ? "'{$string1}' は '{$string2}' より小さい)" : 78 ($resultEN1 > 0 ? "'{$string1}' は '{$string2}' より大きい)" : 79 "'{$string1}' と '{$string2}' は等しい)")) . PHP_EOL; 80 81 echo " strcoll('{$string1}', '{$string3}'): {$resultEN2} (" . 82 ($resultEN2 < 0 ? "'{$string1}' は '{$string3}' より小さい)" : 83 ($resultEN2 > 0 ? "'{$string1}' は '{$string3}' より大きい)" : 84 "'{$string1}' と '{$string3}' は等しい)")) . PHP_EOL; 85 } else { 86 echo " 英語ロケールの設定に失敗しました。Cロケールと同様の結果になる可能性があります。" . PHP_EOL; 87 } 88 echo PHP_EOL; 89} 90 91// デモンストレーション関数の実行 92demonstrateStrcollComparison(); 93 94?>
PHP 8のstrcoll関数は、2つの文字列を現在のロケール設定に基づいて比較する機能を提供します。通常の文字列比較関数（例えばstrcmp）が文字のバイト値で比較するのに対し、strcollは地域や言語のルールを考慮して比較を行う点が特徴です。これにより、ドイツ語の「ä」が「a」とどのように扱われるかなど、言語固有の文字順序や規則を反映した比較が可能です。
引数には比較したい2つの文字列（$string1, $string2）を指定します。戻り値は整数値で、$string1と$string2がロケールに基づいて等しい場合は0を返します。$string1が$string2より大きい場合は正の値を、小さい場合は負の値を返します。
サンプルコードでは、「äpfel」と「apfel」などの文字列を例に、setlocale関数でロケール（C、ドイツ語、英語）を切り替えながらstrcollを実行しています。これにより、同じ文字列の組み合わせでも、ロケール設定によって比較結果が変動する様子を確認できます。多言語環境で、各言語の正確な辞書順で文字列を比較したい場合にstrcollは非常に役立ちます。
strcoll関数は、setlocaleで設定された現在のロケールに基づいて文字列を比較します。このため、特定の言語における文字の並び順（例：ドイツ語のウムラウト）を考慮した比較が可能ですが、ロケール設定が不適切だと期待する結果が得られない点が重要です。setlocale関数はシステム環境によって指定できるロケール名が異なるため、設定に失敗しないか確認するようにしてください。また、setlocaleはグローバルな設定を変更するため、ウェブアプリケーションなどで安易に利用すると、他の処理に予期せぬ影響を与える可能性があります。より安全かつ柔軟な多言語対応が必要な場合は、PHPの国際化拡張（Intl extension）が提供するIntlCollatorクラスの利用も検討することをお勧めします。
PHP strcollでロケール比較とstrtolowerの対比
1<?php 2 3/** 4 * strcoll関数を使用して、ロケールに基づいた文字列比較をデモンストレーションします。 5 * また、キーワードであるstrtolower関数を用いたシンプルな大文字小文字を区別しない比較との違いも示します。 6 * 7 * strcollは、現在のロケール（言語や地域の設定）の照合ルールに従って2つの文字列を比較します。 8 * これにより、文字の並び順や大文字小文字の扱いが、ロケール（例：ドイツ語、スウェーデン語）によって 9 * 変化する可能性があります。 10 * 11 * 初心者にとって、strcollとstrcmp、strcasecmp、strtolowerのようなよりシンプルな比較関数との 12 * 使い分けを理解することは重要です。strcollは、国際化された正しいソートには不可欠です。 13 */ 14function demonstrateStrcollAndStrtolowerComparison(): void 15{ 16 // 現在のロケール設定を保存し、後で元に戻せるようにします。 17 // LC_ALLを指定すると、すべてのロケールカテゴリが取得されます。 18 $originalLocale = setlocale(LC_ALL, 0); 19 20 // LC_COLLATEカテゴリにドイツ語ロケールを設定してみます。 21 // これにより、「ß」（エスツェット）が「ss」と類似した順序で扱われるなど、 22 // ロケール固有の照合ルールをデモンストレーションできます。 23 // 注意: ロケールの利用可能性はオペレーティングシステムに依存します。 24 // 一般的なドイツ語ロケール: 'de_DE.utf8', 'de_DE', 'German_Germany.1252' 25 $localeSet = setlocale(LC_COLLATE, 'de_DE.utf8', 'de_DE', 'German_Germany.1252'); 26 27 if ($localeSet === false) { 28 echo "警告: LC_COLLATEに特定のロケールを設定できませんでした。ロケール固有の動作が期待通りでない可能性があります。\n"; 29 echo "現在のLC_COLLATEロケール: " . setlocale(LC_COLLATE, 0) . "\n\n"; 30 } else { 31 echo "LC_COLLATEロケールが「{$localeSet}」に設定されました。\n\n"; 32 } 33 34 echo "--- strcollによる比較 (ロケール依存の比較) ---\n"; 35 36 // 例1: 「ß」（ドイツ語のエスツェット）と「ss」の比較。 37 // 多くのドイツ語ロケールでは、「ß」は「ss」としてソートされます。 38 $string1 = "Straße"; // ドイツ語で「通り」 39 $string2 = "Strasse"; // 別の綴り、または比較上の同等物 40 41 $result1 = strcoll($string1, $string2); 42 echo "strcollで「{$string1}」と「{$string2}」を比較:\n"; 43 if ($result1 === 0) { 44 echo " 結果: 現在のロケールでは同等（またはソート順で非常に近い）と見なされます。\n"; 45 } elseif ($result1 < 0) { 46 echo " 結果: ソート順で「{$string1}」が「{$string2}」より前に来ます。\n"; 47 } else { 48 echo " 結果: ソート順で「{$string1}」が「{$string2}」より後に来ます。\n"; 49 } 50 echo " （通常、ドイツ語ロケールでは、「ß」と「ss」は照合において同様に扱われます。）\n\n"; 51 52 // 例2: 大文字小文字が異なる文字列の比較。 53 // strcollは一般的に大文字小文字を区別します。ただし、ロケールが明示的に 54 // 特定の文字に対して大文字小文字を区別しない照合ルールを定義している場合は除きます。 55 $string3 = "Apfel"; // りんご（大文字） 56 $string4 = "apfel"; // りんご（小文字） 57 58 $result2 = strcoll($string3, $string4); 59 echo "strcollで「{$string3}」と「{$string4}」を比較:\n"; 60 if ($result2 === 0) { 61 echo " 結果: 現在のロケールで同等と見なされます（大文字小文字の変換が有効な場合）。\n"; 62 } elseif ($result2 < 0) { 63 echo " 結果: ソート順で「{$string3}」が「{$string4}」より前に来ます。\n"; 64 } else { 65 echo " 結果: ソート順で「{$string3}」が「{$string4}」より後に来ます。\n"; 66 } 67 echo " （ほとんどのロケールでは、strcollは明示的なロケールルールが指示しない限り大文字小文字を区別します。）\n\n"; 68 69 echo "--- strtolowerによるシンプルな大文字小文字を区別しない比較との対比 ---\n"; 70 // シンプルな大文字小文字を区別しない「同等性チェック」（ソート順ではない）の場合、 71 // 両方の文字列をstrtolowerで小文字に変換する方法が一般的です。 72 // この方法では、複雑なロケール固有の照合ルールは考慮されません。 73 $string5 = "Banana"; 74 $string6 = "banana"; 75 76 echo "strtolowerを使用して「{$string5}」と「{$string6}」を比較:\n"; 77 if (strtolower($string5) === strtolower($string6)) { 78 echo " 結果: 小文字に変換すると、同等と見なされます。\n"; 79 } else { 80 echo " 結果: 小文字に変換しても、同等とは見なされません。\n"; 81 } 82 echo " （これは、同等性チェックにおいて大文字小文字を区別しない、分かりやすい方法です。）\n\n"; 83 84 // 元のロケール設定を復元し、アプリケーションの他の部分に影響を与えないようにします。 85 if ($originalLocale !== false) { 86 setlocale(LC_ALL, $originalLocale); 87 echo "元のロケール設定が復元されました。\n"; 88 } 89} 90 91// デモンストレーション関数を実行します。 92demonstrateStrcollAndStrtolowerComparison(); 93
PHPのstrcoll関数は、現在のロケール（言語や地域設定）に基づいて2つの文字列を比較します。この関数は、比較する2つの文字列を引数として受け取り、比較結果を整数値で返します。戻り値が0の場合は文字列が同等、負の値の場合は最初の文字列が2番目の文字列より前にソートされ、正の値の場合は後にソートされることを示します。strcollは、ドイツ語の「ß」と「ss」のように、特定のロケールで文字の並び順や大文字小文字の扱いが異なる場合に、国際化されたアプリケーションで正確なソートを行うために不可欠です。
一方、キーワードとして挙げられているstrtolower関数は、文字列に含まれるすべてのアルファベットを小文字に変換します。この関数は、引数として文字列を受け取り、小文字に変換された新しい文字列を返します。strtolowerは、大文字と小文字の違いを無視して文字列が同じであるかを判断したい場合に便利で、例えばユーザー入力の検索などで大文字小文字を区別せずに一致を調べたい場合に利用します。
このように、strcollはロケールに依存した複雑なソート順の比較に用いられ、strtolowerはよりシンプルな大文字小文字を区別しない同等性の判定に役立ちます。それぞれの関数の特性を理解し、目的に応じて適切に使い分けることが重要です。
strcoll関数は、現在のロケール設定に基づいて文字列を比較するため、比較結果が地域や言語によって変化する点にご注意ください。特にドイツ語の「ß」と「ss」のように、ロケール特有の照合ルールが適用されます。ロケールを設定するsetlocale関数はOSによって利用可能なロケール名が異なり、設定に失敗する可能性もあります。strcollは通常、大文字小文字を区別しますが、単純に大文字小文字を区別せず比較したい場合は、両方の文字列をstrtolowerで小文字に変換する方法が手軽です。setlocaleでロケールを変更した場合、その変更はグローバルに影響するため、他の処理に影響を与えないよう、必ず元のロケール設定に戻すようにしてください。