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

Copy
1<?php
2
3/**
4 * ArrayIterator::natcasesort() メソッドの使用例
5 *
6 * この関数は、ArrayIterator オブジェクトが保持する配列を、
7 * 自然順アルゴリズム（人間にとって自然な順序）かつ
8 * 大文字・小文字を区別せずにソートする方法を示します。
9 * ファイル名やバージョン番号のソートに特に有用です。
10 */
11function demonstrateArrayIteratorNatcasesort(): void
12{
13    // ソート対象となる配列を準備します。
14    // 自然順ソートと大文字・小文字を区別しないソートの特性が分かるように、
15    // 数字や大文字・小文字の異なる文字列を含めます。
16    $data = [
17        'IMG10.png',
18        'img2.png',
19        'img1.png',
20        'IMG01.png',
21        'file_alpha.txt',
22        'File_Beta.txt',
23    ];
24
25    // ArrayIterator のインスタンスを作成し、配列を渡します。
26    // ArrayIterator は配列をオブジェクトとして扱い、様々なイテレータ操作やソートメソッドを提供します。
27    $iterator = new ArrayIterator($data);
28
29    echo "--- ソート前の配列 ---" . PHP_EOL;
30    // ソート前のイテレータの内容を出力します。
31    // foreach ループで ArrayIterator を直接反復処理できます。
32    foreach ($iterator as $key => $value) {
33        echo sprintf("キー: %s, 値: %s%s", $key, $value, PHP_EOL);
34    }
35    echo PHP_EOL;
36
37    // natcasesort() メソッドを呼び出します。
38    // これはイテレータ内部の配列を、自然順かつ大文字・小文字を区別しないアルゴリズムで直接ソートします。
39    // 戻り値は常に true ですが、通常は確認する必要はありません。
40    $iterator->natcasesort();
41
42    echo "--- ソート後の配列 (natcasesort) ---" . PHP_EOL;
43    // ソート後のイテレータの内容を出力します。
44    // 出力順序が自然順（例: img1, img2, IMG10）かつ大文字・小文字を区別しない（例: file_alpha, File_Beta）
45    // になっていることを確認してください。
46    foreach ($iterator as $key => $value) {
47        echo sprintf("キー: %s, 値: %s%s", $key, $value, PHP_EOL);
48    }
49    echo PHP_EOL;
50}
51
52// 上記のデモンストレーション関数を実行します。
53demonstrateArrayIteratorNatcasesort();
54
55?>

PHPのArrayIterator::natcasesort()メソッドは、ArrayIteratorオブジェクトに格納された配列を、人間にとって自然な順序（自然順）で、かつ大文字・小文字を区別せずにソートするための機能です。ファイル名やバージョン番号のような、数字を含む文字列を正しく並べ替えたい場合に特に役立ちます。例えば、「img1.png」と「img10.png」では、通常の文字列ソートでは「img10.png」が先にきますが、自然順ソートでは「img1.png」が先に並べ替えられます。

このサンプルコードでは、まず自然順ソートと大文字・小文字を区別しないソートの特性がわかるような文字列を含む配列を用意しています。次に、その配列をArrayIteratorのコンストラクタに渡してインスタンスを作成し、ソート前の内容を出力しています。

その後、$iteratorインスタンスのnatcasesort()メソッドを呼び出します。このメソッドは引数を必要とせず、呼び出すだけでArrayIterator内部の配列を直接ソートします。ソート処理が成功すると戻り値として常にtrueが返されますが、通常はこの戻り値を確認する必要はありません。

ソート処理の完了後、再度配列の内容を出力することで、自然順かつ大文字・小文字を区別しないソートが適用された結果を確認できます。これにより、「img1.png」の次に「img2.png」が来て、「IMG10.png」はその後に位置し、「file_alpha.txt」と「File_Beta.txt」のように大文字・小文字が異なる文字列も期待通りに並べ替えられていることがわかります。

Copy
1<?php
2
3/**
4 * ArrayIterator::natcasesort を使用して、配列の要素を自然順アルゴリズムで
5 * 大文字小文字を区別せずに昇順ソートし、その結果を降順にするサンプルコードです。
6 *
7 * ArrayIterator::natcasesort メソッド自体は常に昇順でソートを行います。
8 * 降順にするには、ソート後に結果を反転させる必要があります。
9 */
10
11// ソート対象のデータ（ファイル名などを想定）
12$data = [
13    'img1.png',
14    'img10.png',
15    'img2.png',
16    'IMG.png',
17    'image.png',
18    'img01.png',
19    'img002.png',
20];
21
22// ArrayIterator オブジェクトを作成し、データを設定します。
23// ArrayIterator は配列のようにイテレート可能なオブジェクトで、ソートメソッドを持ちます。
24$iterator = new ArrayIterator($data);
25
26// ArrayIterator::natcasesort() を呼び出して、大文字小文字を区別しない自然順ソート（昇順）を実行します。
27// このメソッドは、内部の配列を直接変更します。
28// 戻り値は常に true です。
29$iterator->natcasesort();
30
31echo "--- 昇順ソートの結果 ---\n";
32// ソートされた要素を順に出力します。
33foreach ($iterator as $value) {
34    echo $value . "\n";
35}
36
37echo "\n--- 降順ソートの結果 (昇順ソート後に逆順) ---\n";
38// natcasesort は昇順ソートのみを行うため、降順にするにはソート後に結果を反転させます。
39// 1. ArrayIterator からソート済みの配列のコピーを取得します。
40$sortedArray = $iterator->getArrayCopy();
41// 2. 取得した配列を逆順にします。
42$descendingArray = array_reverse($sortedArray);
43
44// 降順ソートされた要素を出力します。
45foreach ($descendingArray as $value) {
46    echo $value . "\n";
47}

PHPのArrayIterator::natcasesortメソッドは、ArrayIteratorオブジェクトが持つ配列の要素を、自然順アルゴリズムで並べ替えるための機能です。このソートは、大文字と小文字を区別せずに行われるため、「img1.png」と「IMG.png」のような文字列も適切に扱われます。特にファイル名やバージョン番号のような、数字を含む文字列を直感的な順序で並べたい場合に便利です。

このメソッドは引数を取りません。呼び出すと、ArrayIteratorオブジェクトが内部に保持している配列の要素が直接変更され、常に昇順でソートされます。メソッドの戻り値は常にtrueですが、通常は戻り値を確認せずソート後の配列を利用します。

サンプルコードでは、まずファイル名を模した文字列の配列をArrayIteratorオブジェクトに設定しています。ArrayIteratorは、配列をイテレート可能なオブジェクトとして扱い、ソートなどの便利なメソッドを提供します。

$iterator->natcasesort()を実行することで、配列の要素は自然順かつ大文字小文字を区別しない昇順で並び替えられます。例えば「img1.png」と「img10.png」は「img1.png」「img2.png」「img10.png」の順にソートされます。

natcasesortは昇順ソートしか行いませんので、降順にしたい場合は追加の処理が必要です。サンプルコードでは、昇順にソートされたArrayIteratorからgetArrayCopy()メソッドを使って配列のコピーを取得し、その配列をarray_reverse()関数で反転させています。これにより、自然順でソートされた結果を降順で表示することが可能になります。