PHPのstrcoll()関数とは？ロケールに基づく文字列比較の使い方を解説

PHPのstrcoll()関数は、現在設定されているロケール（言語・地域の設定）に基づいて、2つの文字列を比較するための関数です。通常の文字列比較関数とは異なり、ロケールの照合規則（照合順序）を考慮して比較が行われる点が特徴です。

注意： この関数は大文字と小文字を区別します。そのため、比較の結果は大文字・小文字の違いによって変わる可能性があります。

構文

strcoll(str1, str2)

パラメータ

• str1 − 比較する1つ目の文字列

• str2 − 比較する2つ目の文字列

戻り値

strcoll()関数は、比較結果に応じて以下の値を返します。

• 0 − 2つの文字列が等しい場合

• 0より小さい値 − str1がstr2より小さい（前に並ぶ）場合

• 0より大きい値 − str1がstr2より大きい（後に並ぶ）場合

使用例

以下は、同じ文字列を比較する例です。

<?php
   setlocale(LC_COLLATE, 'en_US'); 
   echo strcoll("Demo text!", "Demo text!");
?>

出力

0

2つの文字列が完全に一致しているため、戻り値は「0」になります。

使用例：大文字と小文字の比較

次の例では、ロケールを「de_CH」（スイスのドイツ語）に設定し、大文字の「A」と小文字の「a」を比較しています。

<?php
   $x = 'a'; $y = 'A';
   setlocale(LC_COLLATE, 'de_CH'); 
   print "de_CH: " . strcoll($x, $y) . "\n";
?>

出力

de_CH: 32

ポイントのまとめ

• strcoll()関数は、setlocale()関数で設定したロケールの影響を受けます。事前にsetlocale()で適切なロケールを設定しておく必要があります。

• ロケールが「C」または「POSIX」に設定されている場合、strcoll()はstrcmp()と同じ動作になります。

• 大文字と小文字を区別せずに比較したい場合は、strcasecmp()などの関数を検討するとよいでしょう。