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

Copy
1<?php
2
3/**
4 * strnatcasecmp関数の使用例。
5 *
6 * この関数は、大文字小文字を区別せずに「自然な順序」で文字列を比較します。
7 * 特に、ファイル名やバージョン番号のように数字を含む文字列のソートに役立ちます。
8 *
9 * 戻り値:
10 *   - $string1 が $string2 より小さい場合、負の値
11 *   - $string1 が $string2 より大きい場合、正の値
12 *   - 両者が等しい場合、0
13 */
14function demonstrateStrnatcasecmpUsage(): void
15{
16    // 例1: 自然順比較と通常の辞書順比較の違い
17    $stringA = "img2.png";
18    $stringB = "img10.png";
19    $stringC = "IMG2.PNG"; // 大文字小文字の違い
20
21    echo "--- 文字列比較の基本 ---\n";
22
23    // strnatcasecmp は自然順 (2 < 10) で比較し、大文字小文字を区別しない
24    $result1 = strnatcasecmp($stringA, $stringB);
25    echo "strnatcasecmp('{$stringA}', '{$stringB}'): " . $result1 . " (自然順では '{$stringA}' は '{$stringB}' より小さい)\n";
26
27    $result2 = strnatcasecmp($stringA, $stringC);
28    echo "strnatcasecmp('{$stringA}', '{$stringC}'): " . $result2 . " (自然順かつ大文字小文字無視で '{$stringA}' と '{$stringC}' は等しい)\n";
29
30    // 参考: strcasecmp は通常の辞書順 (文字ごとに比較) で比較し、大文字小文字を区別しない
31    $result3 = strcasecmp($stringA, $stringB);
32    echo "strcasecmp('{$stringA}', '{$stringB}'): " . $result3 . " (辞書順では '{$stringA}' は '{$stringB}' より大きい)\n"; // '2' > '1' のため
33
34
35    echo "\n--- 配列の自然順ソート例 ---\n";
36
37    // ファイル名のような数字を含む文字列の配列
38    $fileNames = [
39        "image10.jpg",
40        "image2.jpg",
41        "Image1.JPG", // 大文字小文字の違いも無視される
42        "image05.jpg",
43        "image_a.jpg"
44    ];
45
46    echo "ソート前の配列:\n";
47    print_r($fileNames);
48
49    // usort関数とstrnatcasecmpを組み合わせて、配列を自然順かつ大文字小文字を無視してソート
50    usort($fileNames, 'strnatcasecmp');
51
52    echo "\n自然順ソート後の配列:\n";
53    print_r($fileNames);
54    /* 期待される出力順序:
55     * Image1.JPG
56     * image2.jpg
57     * image05.jpg
58     * image10.jpg
59     * image_a.jpg
60     */
61}
62
63// デモンストレーション関数を実行
64demonstrateStrnatcasecmpUsage();
65
66?>

PHP 8のstrnatcasecmp関数は、2つの文字列を「自然な順序」で、かつ大文字と小文字を区別せずに比較するための関数です。これは、ファイル名やバージョン番号など、文字列中に数字が含まれるデータをソートする際に特に役立ちます。

この関数は、比較したい2つの文字列を引数として受け取ります。戻り値は整数値で、最初の文字列が2番目の文字列より小さい場合は負の値、大きい場合は正の値、両者が等しい場合は0を返します。

「自然な順序」とは、文字列中の数字部分を数値として比較する方式を指します。例えば、「img2.png」と「img10.png」を比較する場合、通常の辞書順では「img10.png」が「img2.png」より先にくることがありますが、strnatcasecmpでは数字の「2」と「10」を数値として捉えるため、「img2.png」が「img10.png」より小さいと判断します。また、大文字小文字を区別しないため、「IMG2.PNG」と「img2.png」は等しいと評価されます。

サンプルコードでは、「img2.png」と「img10.png」の比較において、この自然順比較と通常の辞書順比較の違いを示し、strnatcasecmpが直感的な順序で比較することを確認できます。さらに、ファイル名の配列をこの関数を使ってソートすることで、ユーザーが期待する自然な並び順に整理できる実用的な例も示しています。これにより、ファイルリストやデータ表示がより分かりやすくなります。

Copy
1<?php
2
3/**
4 * strnatcasecmp と strcasecmp 関数の違いを示すサンプルコードです。
5 *
6 * strnatcasecmp は「自然順アルゴリズム」を使って、大文字小文字を区別せずに文字列を比較します。
7 * これは、ファイル名やバージョン番号のように数字部分を数値として扱う場合に特に役立ちます。
8 *
9 * strcasecmp は通常の辞書順で、大文字小文字を区別せずに文字列を比較します。
10 * 数字部分も文字として扱われるため、「10」は「2」より小さいと判断されることがあります。
11 *
12 * 戻り値:
13 *  - 0: 両方の文字列が等しい場合
14 *  - <0: string1 が string2 より小さい場合
15 *  - >0: string1 が string2 より大きい場合
16 */
17function demonstrateStringComparison(): void
18{
19    // 自然順比較と通常の比較の違いがわかりやすい文字列の配列
20    $data = ["img1.png", "img10.png", "img2.png", "IMG1.png"];
21
22    echo "元の配列:\n";
23    print_r($data);
24    echo "\n";
25
26    // strnatcasecmp を使用したソートの例
27    $dataNaturalSorted = $data; // 元の配列をコピー
28    usort($dataNaturalSorted, 'strnatcasecmp');
29    echo "strnatcasecmp (自然順、大文字小文字無視) でソートした結果:\n";
30    print_r($dataNaturalSorted);
31    echo "  // -> img1.png, IMG1.png, img2.png, img10.png の順に並びます。\n";
32    echo "  //    数字部分 (1, 10, 2) を数値として扱い、'IMG1'と'img1'を同じと見なします。\n";
33    echo "\n";
34
35    // strcasecmp (キーワードに関連する関数) を使用したソートの例
36    $dataRegularSorted = $data; // 元の配列をコピー
37    usort($dataRegularSorted, 'strcasecmp');
38    echo "strcasecmp (通常の辞書順、大文字小文字無視) でソートした結果:\n";
39    print_r($dataRegularSorted);
40    echo "  // -> IMG1.png, img1.png, img10.png, img2.png の順に並びます。\n";
41    echo "  //    数字部分 (10 と 2) を文字として扱い、'1'が'2'より小さいので'10'が'2'より前に来ます。\n";
42    echo "\n";
43
44    // 個別の比較例: strnatcasecmp
45    $stringA = "Version 10";
46    $stringB = "Version 2";
47    $resultNatCaseCmp = strnatcasecmp($stringA, $stringB);
48
49    echo "個別の比較例 (strnatcasecmp):\n";
50    echo "  \"{$stringA}\" と \"{$stringB}\" を比較:\n";
51    echo "  結果: {$resultNatCaseCmp}\n";
52    if ($resultNatCaseCmp < 0) {
53        echo "  -> \"{$stringA}\" は \"{$stringB}\" より小さい (自然順で比較)\n";
54    } elseif ($resultNatCaseCmp > 0) {
55        echo "  -> \"{$stringA}\" は \"{$stringB}\" より大きい (自然順で比較)\n";
56    } else {
57        echo "  -> 両者は等しい (自然順で比較)\n";
58    }
59    echo "  // 数字部分を数値として比較するため、Version 10 は Version 2 より大きいと判断されます。\n";
60}
61
62// 関数を実行します。
63demonstrateStringComparison();
64
65?>

PHP 8のstrnatcasecmp関数は、二つの文字列を大文字小文字を区別せず、「自然順アルゴリズム」に基づいて比較します。この関数は、引数として比較したい二つの文字列$string1と$string2を受け取ります。戻り値は整数で、$string1が$string2より小さい場合は負の数、大きい場合は正の数、等しい場合は0を返します。

「自然順アルゴリズム」とは、文字列中の数字部分を数値として比較する方式のことです。例えば、「img10.png」と「img2.png」を比較する場合、通常の辞書順では「1」が「2」より小さいため「img10.png」が「img2.png」より小さいと判断されることがありますが、strnatcasecmpでは数字の「10」を「2」よりも大きいと正確に判断します。この特性は、ファイル名やバージョン番号など、数字を含む文字列を直感的な順序でソートする際に非常に役立ちます。

関連関数のstrcasecmpも大文字小文字を区別せずに文字列を比較しますが、こちらは数字部分も文字として扱う通常の辞書順です。そのため、strnatcasecmpとは異なる結果になる場合があります。サンプルコードでは、ファイル名のソートを通じて、strnatcasecmpが「img1.png」「IMG1.png」「img2.png」「img10.png」といった自然な順序で並べるのに対し、strcasecmpが「IMG1.png」「img1.png」「img10.png」「img2.png」のように並べる違いを具体的に示しています。これにより、数字を含む文字列の比較ではstrnatcasecmpの使用が推奨されます。