【PHP8.x】RecursiveArrayIterator::natcasesort()メソッドの使い方

Copy
1<?php
2
3/**
4 * RecursiveArrayIterator::natcasesort() の使用例を示します。
5 * このメソッドは、イテレータが保持する配列の要素を
6 * 大文字・小文字を区別しない自然順序でソートします。
7 */
8
9// ソート対象となる文字列の配列を定義します。
10// 数字を含む文字列が含まれており、一般的なアルファベット順では期待通りにならない場合があります。
11$unsortedData = [
12    'img10.png',
13    'img1.png',
14    'IMG2.png',
15    'img01.png',
16    'img100.png',
17    'file_a.txt',
18    'file_B.txt',
19];
20
21echo "--- ソート前のデータ --- \n";
22print_r($unsortedData);
23
24// RecursiveArrayIterator のインスタンスを作成し、上記の配列を渡します。
25// これにより、配列をイテレータとして操作できるようになります。
26$iterator = new RecursiveArrayIterator($unsortedData);
27
28// natcasesort() メソッドを呼び出し、イテレータ内の要素を自然順序でソートします。
29// このメソッドは元の配列の順序を変更します。
30// 大文字・小文字を区別せず、数字の部分を値として比較します (例: 'img10' は 'img2' の後に来ます)。
31$iterator->natcasesort();
32
33echo "\n--- natcasesort() でソート後のデータ --- \n";
34
35// ソートされた結果はイテレータ内に反映されています。
36// イテレータをループして、ソート後の要素を表示します。
37foreach ($iterator as $key => $value) {
38    echo "  [" . $key . "] => " . $value . "\n";
39}
40
41// 必要であれば、ソートされたイテレータから新しい配列のコピーを取得することも可能です。
42echo "\n--- ソート後の配列 (getArrayCopy() で取得) --- \n";
43$sortedArray = $iterator->getArrayCopy();
44print_r($sortedArray);
45
46?>

RecursiveArrayIterator::natcasesort()メソッドは、PHPのRecursiveArrayIteratorクラスに属する機能で、イテレータが内部に保持する配列の要素を「自然順序」でソートします。自然順序ソートとは、一般的な辞書順ソートとは異なり、文字列に含まれる数字部分を数値として正しく比較し、さらに大文字と小文字を区別せずに並べ替える方法です。

例えば、「img1.png」と「img10.png」のようなファイル名をソートする際、一般的な辞書順だと「img10.png」が「img1.png」より先に来ることがありますが、本メソッドを使用すると「img1.png」の後に「IMG2.png」、「img10.png」というように、人間が直感的に理解しやすい順序で並びます。

このメソッドは引数を一切取らずに呼び出すことができ、呼び出すとイテレータ内の配列の順序が直接変更されます。特に戻り値もないため、ソート後の結果はイテレータを改めて参照することで確認できます。ファイルリストやバージョン文字列など、数字を含むデータをユーザーが理解しやすい形で表示したい場合に非常に便利です。

Copy
1<?php
2
3/**
4 * RecursiveArrayIterator::natcasesort を使用して配列の要素を自然順（大文字小文字を区別しない）で昇順ソートし、
5 * その後、降順で表示するサンプルコードです。
6 *
7 * RecursiveArrayIterator::natcasesort メソッド自体は降順ソートをサポートしていません。
8 * 降順で要素を扱うためには、ソートされたイテレータの要素を一度配列に変換し、
9 * その配列を array_reverse() で反転させる必要があります。
10 */
11function demonstrateNatcasesortDescending(): void
12{
13    // ソート対象のデータ配列
14    $data = [
15        'file_10.txt',
16        'file_1.txt',
17        'file_2.txt',
18        'FILE_A.txt',
19        'file_b.txt',
20        'FILE_C.TXT',
21        'Zeta.TXT',
22        'alpha.txt',
23    ];
24
25    echo "--- 元の配列 ---\n";
26    foreach ($data as $item) {
27        echo $item . "\n";
28    }
29    echo "\n";
30
31    // RecursiveArrayIterator を作成し、データ配列をラップ
32    // これにより、配列の要素をイテレータとして操作できるようになります。
33    $iterator = new RecursiveArrayIterator($data);
34
35    // natcasesort メソッドを呼び出し、イテレータ内の要素を自然順（大文字小文字を区別しない）で昇順ソートする
36    // このメソッドは、イテレータが保持する要素の順序を直接変更します。
37    $iterator->natcasesort();
38
39    // RecursiveArrayIterator::natcasesort は昇順ソートのみを行うため、
40    // 降順で要素を扱うには、ソートされたイテレータの要素を一時的な配列に抽出し、それを反転させます。
41    $sortedAscendingItems = [];
42    foreach ($iterator as $item) {
43        $sortedAscendingItems[] = $item;
44    }
45
46    // 抽出された昇順配列を降順に反転させる
47    $sortedDescendingItems = array_reverse($sortedAscendingItems);
48
49    echo "--- natcasesort で昇順ソート後、降順に表示 ---\n";
50    foreach ($sortedDescendingItems as $item) {
51        echo $item . "\n";
52    }
53    echo "\n";
54}
55
56// 関数の実行
57demonstrateNatcasesortDescending();

PHPのRecursiveArrayIteratorクラスに属するnatcasesortメソッドは、イテレータが保持する要素を自然順アルゴリズムに基づいてソートする機能を提供します。このメソッドは引数を取らず、戻り値もありません。呼び出すと、イテレータ内部の要素の順序が直接変更されます。

natcasesortは、数字を含む文字列を人間が直感的に理解しやすい順序で並べ替える「自然順ソート」を行います。例えば「file_1.txt」「file_10.txt」「file_2.txt」のような文字列は、「file_1.txt」「file_2.txt」「file_10.txt」の順に並べ替えられます。さらに、大文字と小文字を区別しないソートが特徴で、デフォルトでは昇順にソートされます。

サンプルコードでは、RecursiveArrayIterator::natcasesortを使って配列の要素を自然順かつ大文字小文字を区別せずに昇順でソートしています。しかし、このメソッド自体は降順ソートの機能を持っていません。そのため、降順で要素を表示したい場合は、ソート済みのイテレータから一度要素を抽出し、それを通常の配列に変換します。その後、PHPの標準関数であるarray_reverse()を使ってその配列の順序を反転させることで、結果的に降順表示を実現しています。これは、特定のソートメソッドが直接提供しないソート順を実現する一般的な方法の一つです。