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

Copy
1<?php
2
3/**
4 * ソート対象となるアイテムを表すクラス。
5 * natsort関数がオブジェクトを文字列として比較できるように、
6 * __toString() マジックメソッドを実装しています。
7 */
8class FileItem
9{
10    public string $filename;
11    public string $path;
12
13    /**
14     * コンストラクタ
15     *
16     * @param string $filename ファイル名
17     * @param string $path ファイルパス
18     */
19    public function __construct(string $filename, string $path)
20    {
21        $this->filename = $filename;
22        $this->path = $path;
23    }
24
25    /**
26     * オブジェクトが文字列として扱われる際に呼び出されます。
27     * natsort関数はこのメソッドの戻り値（ファイル名）を比較に使用します。
28     * PHP 8 では、__toString() が実装されていないオブジェクトを文字列コンテキストで使用すると TypeError が発生します。
29     * このため、natsortでオブジェクトの配列をソートするには、__toString() の実装が必須です。
30     */
31    public function __toString(): string
32    {
33        return $this->filename;
34    }
35}
36
37// FileItemオブジェクトの配列を作成します。
38// ファイル名には数字が含まれ、通常の文字列ソートとは異なる順序でソートされることを期待します。
39$files = [
40    new FileItem("document_v10.txt", "/data/docs/"),
41    new FileItem("document_v1.txt", "/data/docs/"),
42    new FileItem("document_v2.txt", "/data/docs/"),
43    new FileItem("image_10.png", "/data/images/"),
44    new FileItem("image_1.png", "/data/images/"),
45    new FileItem("image_2.png", "/data/images/"),
46];
47
48echo "--- Original Order ---\n";
49foreach ($files as $file) {
50    echo $file->filename . "\n";
51}
52
53// natsort関数を使用して配列を自然順ソートします。
54// FileItemクラスが__toString()を実装しているため、
55// その戻り値（$filenameプロパティの値）を基準に自然順ソートが行われます。
56natsort($files);
57
58echo "\n--- Sorted Order (by natsort on filename) ---\n";
59foreach ($files as $file) {
60    echo $file->filename . "\n";
61}
62

PHPのnatsort関数は、配列の要素を「自然順」でソートするための機能です。通常の文字列比較とは異なり、数字を含む文字列を人間が直感的に理解できる順序（例えば、「v1」「v2」「v10」）で並べ替えることができます。

この関数は、引数としてソートしたい配列をarray &$arrayの形で受け取ります。この引数は「参照渡し」であるため、関数内で配列の内容が直接変更され、ソートされた結果が元の配列に反映されます。関数の戻り値はbool型で、ソート処理が成功した場合はtrueを、失敗した場合はfalseを返します。

特に、オブジェクトの配列をnatsortでソートする際には注意が必要です。natsortは配列内の各オブジェクトを比較するために、そのオブジェクトを文字列として扱おうとします。PHP 8では、オブジェクトが文字列コンテキストで使用される際に、__toString()マジックメソッドの実装が必須です。このメソッドは、オブジェクトがどのように文字列に変換されるかを定義します。

サンプルコードのFileItemクラスは、__toString()メソッドを実装し、自身の$filenameプロパティの値を返すようにしています。これにより、natsort関数はFileItemオブジェクトの配列を受け取った際、各オブジェクトの$filenameプロパティの値を基準にして自然順ソートを実行できます。__toString()が実装されていないオブジェクトの配列をPHP 8でnatsortに渡すと、TypeErrorが発生します。

Copy
1<?php
2
3/**
4 * natsort() 関数のサンプルコード。
5 *
6 * この関数は、配列の値を「自然順アルゴリズム」でソートします。
7 * キーワード「natsort by key」を考慮し、特に連想配列（文字列キーを持つ配列）の場合に、
8 * キーと値の関連が維持されることを示します。
9 *
10 * 注意: natsort() は配列の「値」をソートし、元のキーを並べ替えます。
11 * 数値キーを持つ配列の場合、ソート後にキーは0から始まる連番に再インデックスされます。
12 * 文字列キーを持つ連想配列の場合、キーとその値の関連は維持されます。
13 */
14function demonstrateNatsortBehavior(): void
15{
16    // ファイル名のような文字列を含む連想配列を準備します。
17    // キーは元の識別子、値はソートしたいデータです。
18    $data = [
19        'first_entry'  => 'document10.txt',
20        'second_entry' => 'document2.txt',
21        'third_entry'  => 'document1.txt',
22        'fourth_entry' => 'document20.txt',
23        'fifth_entry'  => 'document_alpha.txt',
24        'sixth_entry'  => 'document_beta.txt',
25    ];
26
27    echo "--- ソート前の配列の状態 ---\n";
28    print_r($data);
29
30    // natsort() を使って配列の値を自然順でソートします。
31    // 関数は配列自体を直接変更し、成功した場合は true、失敗した場合は false を返します。
32    $success = natsort($data);
33
34    if ($success) {
35        echo "\n--- natsort() でソート後の配列の状態 ---\n";
36        echo "  (値は自然順に並べ替えられ、元の文字列キーは維持されます)\n";
37        print_r($data);
38    } else {
39        echo "\n配列のソートに失敗しました。\n";
40    }
41
42    // 参考: 数値キーの配列で natsort() を使うと、キーは再インデックスされます。
43    // 例えば、[0 => 'document10.txt', 1 => 'document2.txt'] が
44    // natsort() 後に [0 => 'document2.txt', 1 => 'document10.txt'] となります。
45}
46
47// 関数を実行して動作を確認します。
48demonstrateNatsortBehavior();
49

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

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

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

Copy
1<?php
2
3/**
4 * PHPのnatsort関数を使った多次元配列内の自然順ソートのデモンストレーション。
5 *
6 * natsortは配列の値を「自然順」（natural order）でソートします。
7 * これは、文字列を数字として扱い、「file1.txt」「file2.txt」「file10.txt」のように
8 * 人間が認識する順序でソートするアルゴリズムです。通常の辞書順ソートでは、
9 * 「file1.txt」「file10.txt」「file2.txt」となってしまいます。
10 *
11 * この関数は、多次元配列内の各サブ配列にnatsortを適用する方法を示します。
12 */
13function demonstrateNatsortWithMultidimensionalArray(): void
14{
15    // ソート対象となる多次元配列の例
16    $fileGroups = [
17        'category_A' => [
18            'item10.txt',
19            'item2.txt',
20            'item1.txt',
21            'document_2.pdf',
22            'document_10.pdf',
23            'document_1.pdf',
24        ],
25        'category_B' => [
26            'log_b_1.log',
27            'log_b_10.log',
28            'log_b_2.log',
29        ],
30        'category_C' => [
31            'report_Z.csv',
32            'report_A.csv',
33            'data_10.json',
34            'data_2.json',
35            'data_1.json',
36        ],
37    ];
38
39    echo "--- ソート前の配列の状態 ---\n";
40    print_r($fileGroups);
41
42    // メイン配列を反復処理し、各サブ配列にnatsortを適用します。
43    // `&$group` の '&' は、ループ内で $group に加えた変更が元の $fileGroups 配列に直接反映されることを意味します。
44    foreach ($fileGroups as $key => &$group) {
45        echo "\n'{$key}' カテゴリのサブ配列を自然順でソート中...\n";
46        // natsortは配列をその場で（インプレースで）ソートし、成功した場合にtrueを返します。
47        $success = natsort($group); 
48        if ($success) {
49            echo "'{$key}' は正常にソートされました。\n";
50        } else {
51            echo "'{$key}' のソートに失敗しました。\n";
52        }
53    }
54    // 参照を使ったループの後は、意図しない挙動を防ぐために参照を解除することが推奨されます。
55    unset($group); 
56
57    echo "\n--- natsort適用後の配列の状態 ---\n";
58    print_r($fileGroups);
59
60    echo "\n--- natsortの単一配列への適用例（比較用） ---\n";
61    $simpleArray = ['photo10.jpg', 'photo2.jpg', 'photo1.jpg'];
62    echo "ソート前の単一配列: ";
63    print_r($simpleArray);
64    natsort($simpleArray); // natsortは元の配列を自然順で並べ替えます
65    echo "ソート後の単一配列: ";
66    print_r($simpleArray);
67}
68
69// 上記の関数を実行し、natsortのデモンストレーションを開始します。
70demonstrateNatsortWithMultidimensionalArray();
71

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)で参照を解除することが推奨されます。

Copy
1<?php
2
3/**
4 * natsort関数とarray_reverse関数を組み合わせて、
5 * 配列を自然順にソートし、さらにそれを逆順にするサンプルコードです。
6 * 自然順ソートは、人間がファイル名を並べるように「item10」を「item2」の後に配置します。
7 */
8
9// ソートの対象となる文字列の配列を準備します。
10// 通常のアルファベット順ソートでは「item10.txt」が「item2.txt」の前に来てしまいます。
11$files = [
12    "item2.txt",
13    "item10.txt",
14    "item1.txt",
15    "item20.txt",
16    "item3.txt",
17];
18
19echo "--- ソート前の配列 ---" . PHP_EOL;
20print_r($files);
21
22// natsort() 関数を使用して、配列を自然順でソートします。
23// この関数は配列を参照渡しで受け取るため、元の $files 配列が直接変更されます。
24// 戻り値はソートが成功したかどうかを示す真偽値 (bool) です。
25$isSorted = natsort($files);
26
27if ($isSorted) {
28    echo PHP_EOL . "--- 自然順ソート後の配列 ---" . PHP_EOL;
29    print_r($files);
30
31    // キーワード「reverse」に対応するため、自然順ソートされた配列を逆順にします。
32    // array_reverse() の第二引数に true を指定することで、元のキーを保持したまま逆順にします。
33    // natsort() はインデックス（数値キー）を保持するため、この例では true を指定しなくても
34    // 結果は同じですが、連想配列の場合など汎用性を考えると true を指定するのが安全です。
35    $reversedFiles = array_reverse($files, true);
36
37    echo PHP_EOL . "--- 自然順ソート後、さらに逆順にした配列 ---" . PHP_EOL;
38    print_r($reversedFiles);
39} else {
40    echo PHP_EOL . "ソート処理に失敗しました。" . PHP_EOL;
41}

このコードは、PHPのnatsort関数とarray_reverse関数を組み合わせ、配列を自然順にソートし、その結果を逆順にする方法を示しています。

natsort関数は、ファイル名などの文字列を含む配列を、人間が期待する「自然な順序」（例えば「item1」「item2」「item10」のように数字の桁数を考慮した順序）でソートします。通常のアルファベット順ソートでは「item10」が「item2」より前に来てしまう場合があるため、この関数は特にファイル名リストなどのソートに役立ちます。引数にはソート対象の配列を参照渡しで受け取るため、関数が実行されると元の配列自体が直接ソートされた状態に変更されます。戻り値は、ソート処理が成功したか失敗したかを示すtrueまたはfalseの**真偽値（bool）**です。

サンプルコードでは、まずソート前の配列を表示し、次にnatsortで自然順にソートします。ソート成功後、キーワード「reverse」に対応するためにarray_reverse関数を使って、そのソート結果を逆順にします。array_reverseの第二引数にtrueを指定することで、元の数値キーを保持したまま要素の並びを逆転させています。これにより、自然順ソートされた配列を、望み通りの逆順で表示することが可能になります。