"自然順"アルゴリズムにより文字列比較を行う

# strnatcmp

(PHP 4, PHP 5, PHP 7, PHP 8)

strnatcmp — "自然順"アルゴリズムにより文字列比較を行う

### 説明

function strnatcmp(string `$string1`, string `$string2`): int

この関数は、人間が行うような手法でアルファベットまたは数字の 文字列の順序を比較するアルゴリズムを実装します。この手法は、"自然順" と言われます。 この比較は、大文字小文字を区別することに注意してください。

### パラメータ

`string1`

  最初の文字列。

`string2`

  次の文字列。

### 戻り値

`string1` が `string2` より小さければ 0 より小さな値を、 `string1` が `string2` より大きければ 0 より大きな値を、 両者が等しければ `0` を返します。 返却される値の絶対値に、特に意味はありません。

### 変更履歴

バージョン | 説明
--- | ---
8.2.0 | この関数は、2つの文字列の長さが等しくない場合に `strlen($string1) - strlen($string2)` を返すとは限らなくなりました。 代わりに、`-1` や `1` を返す可能性があります。

### 例

このアルゴリズムと (strcmp() を使用した) 通常のコンピュータ文字列ソートの間の違いの例を次に示します。

例1 strcmp() の例

    <?php
    $arr1 = $arr2 = array("img12.png", "img10.png", "img2.png", "img1.png");
    echo "標準の文字列比較\n";
    usort($arr1, "strcmp");
    print_r($arr1);
    echo "\n自然順での文字列比較\n";
    usort($arr2, "strnatcmp");
    print_r($arr2);
    ?>

上の例の出力は以下となります。

    標準の文字列比較
    Array
    (
        [0] => img1.png
        [1] => img10.png
        [2] => img12.png
        [3] => img2.png
    )

    自然順での文字列比較
    Array
    (
        [0] => img1.png
        [1] => img2.png
        [2] => img10.png
        [3] => img12.png
    )

詳細な情報については、Martin Pool の » 自然順文字列比較 のページを参照ください。

### 参考

- preg_match() - 正規表現によるマッチングを行う
- strcasecmp() - 大文字小文字を区別しないバイナリセーフな文字列比較を行う
- substr() - 文字列の一部分を返す
- stristr() - 大文字小文字を区別しない strstr
- strcmp() - バイナリセーフな文字列比較
- strncmp() - 最初の n 文字についてバイナリセーフな文字列比較を行う
- strncasecmp() - バイナリセーフで大文字小文字を区別しない文字列比較を、最初の n 文字について行う
- strnatcasecmp() - "自然順"アルゴリズムにより大文字小文字を区別しない文字列比較を行う
- strstr() - 文字列が最初に現れる位置を見つける
- natsort() - "自然順"アルゴリズムで配列をソートする
- natcasesort() - 大文字小文字を区別しない"自然順"アルゴリズムを用いて配列をソートする

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open