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

Copy
1<?php
2
3/**
4 * ArrayObject::natsort() メソッドの使用例。
5 *
6 * このスクリプトは、ArrayObject クラスの natsort メソッドを使って、
7 * 自然順アルゴリズムで要素をソートする方法を示します。
8 * natsort は "natural order" ソートの略で、数字部分を数値として比較するため、
9 * 'item2.txt' の次に 'item10.txt' が来るようにソートされます。
10 *
11 * キーワード「multidimensional array」に関して:
12 * ArrayObject::natsort() は、ArrayObject 自体の最上位の要素をソートします。
13 * そのため、多次元配列を直接ソートする用途には適していません。
14 * もし多次元配列の特定のキーや値を基準にソートしたい場合は、
15 * usort() や uasort() のようなカスタムソート関数をコールバックとして使用するか、
16 * ソートしたい列を抽出し、それを ArrayObject に格納して natsort() を適用するなどの
17 * 工夫が必要です。
18 *
19 * この例では、ファイル名のような文字列の配列を ArrayObject に格納し、
20 * natsort() を適用する基本的な使い方を示します。
21 */
22
23// 自然順ソートで効果がわかりやすいように、数字を含む文字列の配列を準備
24$data = [
25    'item10.txt',
26    'item2.txt',
27    'item1.txt',
28    'item20.txt',
29    'item_a.txt',
30    'item_b.txt',
31];
32
33// 配列を ArrayObject のインスタンスでラップ
34$arrayObject = new ArrayObject($data);
35
36echo "--- ソート前 (Original Order) ---\n";
37foreach ($arrayObject as $key => $value) {
38    echo sprintf("Key: %d, Value: %s\n", $key, $value);
39}
40echo "\n";
41
42// ArrayObject の要素を自然順ソートする
43// natsort() は成功した場合 true、失敗した場合 false を返します。
44$isSorted = $arrayObject->natsort();
45
46if ($isSorted) {
47    echo "--- ソート後 (Natural Order) ---\n";
48    foreach ($arrayObject as $key => $value) {
49        echo sprintf("Key: %d, Value: %s\n", $key, $value);
50    }
51} else {
52    echo "ソート操作に失敗しました。\n";
53}
54
55?>

PHP 8のArrayObject::natsort()メソッドは、ArrayObjectインスタンスが保持する要素を「自然順」でソートするためのメソッドです。自然順ソートとは、文字列中の数字部分を数値として比較するソート方式で、例えば「item10.txt」と「item2.txt」があった場合、一般的な辞書順ソートとは異なり、「item2.txt」の次に「item10.txt」が来るように並べ替えます。

このサンプルコードでは、複数のファイル名のような文字列を含む配列をArrayObjectとして初期化し、natsort()メソッドを呼び出してソートしています。ソート前とソート後のArrayObjectの内容を出力することで、自然順ソートがどのように作用するかを確認できます。

natsort()メソッドは引数を取らずに呼び出します。実行結果として、ソートが成功した場合はtrueを、失敗した場合はfalseをbool型で返します。

このメソッドはArrayObjectの直接の要素のみをソートします。そのため、キーワードである「多次元配列 (multidimensional array)」の内部にある要素をソートする用途には直接適していません。多次元配列内の特定のキーや値を基準にソートしたい場合は、他のカスタムソート関数を検討する必要があります。