【PHP8.x】natsort関数の使い方

<?php

/**
 * natsort() 関数のサンプルコード。
 *
 * この関数は、配列の値を「自然順アルゴリズム」でソートします。
 * キーワード「natsort by key」を考慮し、特に連想配列（文字列キーを持つ配列）の場合に、
 * キーと値の関連が維持されることを示します。
 *
 * 注意: natsort() は配列の「値」をソートし、元のキーを並べ替えます。
 * 数値キーを持つ配列の場合、ソート後にキーは0から始まる連番に再インデックスされます。
 * 文字列キーを持つ連想配列の場合、キーとその値の関連は維持されます。
 */
function demonstrateNatsortBehavior(): void
{
    // ファイル名のような文字列を含む連想配列を準備します。
    // キーは元の識別子、値はソートしたいデータです。
    $data = [
        'first_entry'  => 'document10.txt',
        'second_entry' => 'document2.txt',
        'third_entry'  => 'document1.txt',
        'fourth_entry' => 'document20.txt',
        'fifth_entry'  => 'document_alpha.txt',
        'sixth_entry'  => 'document_beta.txt',
    ];

    echo "--- ソート前の配列の状態 ---\n";
    print_r($data);

    // natsort() を使って配列の値を自然順でソートします。
    // 関数は配列自体を直接変更し、成功した場合は true、失敗した場合は false を返します。
    $success = natsort($data);

    if ($success) {
        echo "\n--- natsort() でソート後の配列の状態 ---\n";
        echo "  (値は自然順に並べ替えられ、元の文字列キーは維持されます)\n";
        print_r($data);
    } else {
        echo "\n配列のソートに失敗しました。\n";
    }

    // 参考: 数値キーの配列で natsort() を使うと、キーは再インデックスされます。
    // 例えば、[0 => 'document10.txt', 1 => 'document2.txt'] が
    // natsort() 後に [0 => 'document2.txt', 1 => 'document10.txt'] となります。
}

// 関数を実行して動作を確認します。
demonstrateNatsortBehavior();

natsort関数は、PHPにおいて配列の値を「自然順アルゴリズム」に基づいてソートするために使用されます。このアルゴリズムは、特にファイル名など数字を含む文字列を扱う際に非常に便利です。例えば、「document1.txt」の次に「document2.txt」、そして「document10.txt」といったように、数字の部分を数値として認識し、人間が直感的に理解しやすい順序で並べ替えることができます。これは、一般的な文字列ソート（辞書順ソート）で「document10.txt」が「document2.txt」より前に来てしまう挙動とは異なります。

この関数は、引数としてソートしたい配列を「参照渡し」で受け取ります。そのため、渡された配列自体が直接変更されます。処理が成功した場合はtrueを、何らかの理由で失敗した場合はfalseを戻り値として返します。

natsortは配列の「値」をソートしますが、連想配列（文字列キーを持つ配列）の場合、ソート後も元のキーとその値の関連は維持されます。しかし、数値キーを持つ配列に対して使用した場合は、ソート後にキーが0から始まる連番に再インデックスされますので、この挙動の違いには注意が必要です。サンプルコードでは、ファイル名のような文字列を含む連想配列をnatsortでソートし、値が自然順に並び替えられながらも、元の文字列キーが維持される様子を確認できます。

<?php

/**
 * PHPのnatsort関数を使った多次元配列内の自然順ソートのデモンストレーション。
 *
 * natsortは配列の値を「自然順」（natural order）でソートします。
 * これは、文字列を数字として扱い、「file1.txt」「file2.txt」「file10.txt」のように
 * 人間が認識する順序でソートするアルゴリズムです。通常の辞書順ソートでは、
 * 「file1.txt」「file10.txt」「file2.txt」となってしまいます。
 *
 * この関数は、多次元配列内の各サブ配列にnatsortを適用する方法を示します。
 */
function demonstrateNatsortWithMultidimensionalArray(): void
{
    // ソート対象となる多次元配列の例
    $fileGroups = [
        'category_A' => [
            'item10.txt',
            'item2.txt',
            'item1.txt',
            'document_2.pdf',
            'document_10.pdf',
            'document_1.pdf',
        ],
        'category_B' => [
            'log_b_1.log',
            'log_b_10.log',
            'log_b_2.log',
        ],
        'category_C' => [
            'report_Z.csv',
            'report_A.csv',
            'data_10.json',
            'data_2.json',
            'data_1.json',
        ],
    ];

    echo "--- ソート前の配列の状態 ---\n";
    print_r($fileGroups);

    // メイン配列を反復処理し、各サブ配列にnatsortを適用します。
    // `&$group` の '&' は、ループ内で $group に加えた変更が元の $fileGroups 配列に直接反映されることを意味します。
    foreach ($fileGroups as $key => &$group) {
        echo "\n'{$key}' カテゴリのサブ配列を自然順でソート中...\n";
        // natsortは配列をその場で（インプレースで）ソートし、成功した場合にtrueを返します。
        $success = natsort($group); 
        if ($success) {
            echo "'{$key}' は正常にソートされました。\n";
        } else {
            echo "'{$key}' のソートに失敗しました。\n";
        }
    }
    // 参照を使ったループの後は、意図しない挙動を防ぐために参照を解除することが推奨されます。
    unset($group); 

    echo "\n--- natsort適用後の配列の状態 ---\n";
    print_r($fileGroups);

    echo "\n--- natsortの単一配列への適用例（比較用） ---\n";
    $simpleArray = ['photo10.jpg', 'photo2.jpg', 'photo1.jpg'];
    echo "ソート前の単一配列: ";
    print_r($simpleArray);
    natsort($simpleArray); // natsortは元の配列を自然順で並べ替えます
    echo "ソート後の単一配列: ";
    print_r($simpleArray);
}

// 上記の関数を実行し、natsortのデモンストレーションを開始します。
demonstrateNatsortWithMultidimensionalArray();

natsort関数は、配列の要素を人間が認識しやすい「自然順」でソートするためのPHP関数です。これは、数字を含む文字列を数字として適切に扱い、例えば「item1.txt」「item2.txt」「item10.txt」のように並べ替えることを意味します。一般的な辞書順ソートで起こる「item1.txt」「item10.txt」「item2.txt」といった不自然な順序を防ぐことができます。

この関数の引数array &$arrayは、ソートしたい配列を参照渡しで受け取ります。そのため、natsort関数が実行されると、呼び出し元の配列自体が直接変更され（インプレースソート）、並べ替えられた状態になります。戻り値はbool型で、ソート処理が成功した場合はtrue、何らかの理由で失敗した場合はfalseを返します。

サンプルコードでは、多次元配列内の各サブ配列に対してnatsortを適用する方法を具体的に示しています。foreachループでサブ配列を&$groupのように参照渡しで取得し、その$groupに対してnatsortを呼び出すことで、元の多次元配列内の各サブ配列が自然順にソートされる様子を確認できます。ループで参照を使った後は、意図しない影響を避けるためunset($group)で参照を解除することが推奨されます。