【PHP8.x】SORT_FLAG_CASE定数の使い方

Copy
1<?php
2
3/**
4 * PHPの配列ソート機能と、SORT_FLAG_CASE定数の使用例を示します。
5 *
6 * SORT_FLAG_CASEは、文字列をソートする際に大文字小文字を区別しないように
7 * SORT_STRINGまたはSORT_NATURALと組み合わせて使用する定数です。
8 * このコードでは、SORT_REGULARを使った通常のソートと、
9 * SORT_STRING | SORT_FLAG_CASEを使った大文字小文字を区別しないソートの違いを比較します。
10 */
11function demonstrateSortingWithFlags(): void
12{
13    // ソート対象の文字列配列を定義します。
14    // 大文字と小文字が混在していることで、大文字小文字の区別の違いがわかります。
15    $words = ['apple', 'Banana', 'cherry', 'Date', 'elderberry', 'Fig'];
16
17    echo "--- 元の配列 ---\n";
18    print_r($words);
19
20    // 1. SORT_REGULAR を使用したソート
21    // SORT_REGULAR は型変換を行わず、通常の比較を行います。
22    // 文字列の場合、ASCII値に基づいて大文字小文字を区別してソートされます。
23    // ASCII値では大文字が小文字より小さいと判断されるため、大文字で始まる単語が先にソートされます。
24    $wordsRegular = $words; // 元の配列をコピーして、オリジナルの変更を防ぐ
25    sort($wordsRegular, SORT_REGULAR);
26    echo "\n--- SORT_REGULAR でソート (大文字小文字を区別) ---\n";
27    print_r($wordsRegular);
28    // 出力例: Array ( [0] => Banana [1] => Date [2] => Fig [3] => apple [4] => cherry [5] => elderberry )
29
30    // 2. SORT_STRING と SORT_FLAG_CASE を使用したソート
31    // SORT_STRING は項目を文字列として比較します。
32    // SORT_FLAG_CASE (大文字小文字を区別しないフラグ) を組み合わせることで、
33    // 文字列の大文字小文字を無視してアルファベット順にソートできます。
34    // PHPマニュアル: "SORT_FLAG_CASEを使用するには、SORT_STRING または SORT_NATURAL と組み合わせる必要があります。"
35    $wordsCaseInsensitive = $words; // 元の配列をコピー
36    sort($wordsCaseInsensitive, SORT_STRING | SORT_FLAG_CASE);
37    echo "\n--- SORT_STRING | SORT_FLAG_CASE でソート (大文字小文字を区別しない) ---\n";
38    print_r($wordsCaseInsensitive);
39    // 出力例: Array ( [0] => apple [1] => Banana [2] => cherry [3] => Date [4] => elderberry [5] => Fig )
40}
41
42// 関数の実行
43demonstrateSortingWithFlags();

PHPのSORT_FLAG_CASEは、配列内の文字列をソートする際に、大文字と小文字の区別を無視するための特別な定数です。この定数自体はソートの比較方法を指定するフラグとして機能するため、引数を取ることも、特定の値を戻り値として返すこともありません。

通常、PHPのsort()関数などで文字列をソートすると、大文字のアルファベットは小文字のアルファベットよりもASCII値が小さく扱われるため、大文字で始まる単語が先に並びます。しかし、SORT_FLAG_CASEをSORT_STRINGまたはSORT_NATURAL定数と組み合わせて使用することで、文字列の大文字小文字を区別せず、純粋なアルファベット順でソートすることが可能になります。

サンプルコードでは、この違いを明確に示しています。SORT_REGULARのみでソートした場合、例えば「Banana」が大文字の「B」で始まるため「apple」よりも前に並びます。一方、SORT_STRING | SORT_FLAG_CASEを組み合わせてソートすると、「apple」「Banana」「cherry」のように、大文字小文字を無視してアルファベット順に並べ替えられ、より自然な順序でデータが整理されます。これにより、ユーザーは文字列データを意図した通りにソートし、表示することができます。

Copy
1<?php
2
3/**
4 * 文字列の配列を降順でソートします。
5 * ソート時には大文字・小文字を区別しません。
6 *
7 * @param array $strings ソート対象の文字列配列
8 * @return array ソートされた文字列配列
9 */
10function sortStringsCaseInsInsensitiveDesc(array $strings): array
11{
12    // 元の配列を変更しないよう、複製を作成します。
13    $sortedStrings = $strings;
14
15    // sort() 関数を使用して配列をソートします。
16    // SORT_DESC: 降順でソートします。
17    // SORT_STRING: 要素を文字列として比較します。
18    // SORT_FLAG_CASE: 大文字・小文字を区別せずに比較します。
19    // これらのフラグはビットOR演算子 `|` で組み合わせて指定します。
20    sort($sortedStrings, SORT_DESC | SORT_STRING | SORT_FLAG_CASE);
21
22    return $sortedStrings;
23}
24
25// 実行例
26$data = [
27    'Apple',
28    'banana',
29    'Cherry',
30    'date',
31    'apple', // 'Apple' と同じ並びになることを期待
32    'Banana', // 'banana' と同じ並びになることを期待
33    'Fig',
34    'grape',
35];
36
37echo "ソート前の配列:\n";
38print_r($data);
39
40$sortedData = sortStringsCaseInsInsensitiveDesc($data);
41
42echo "\n降順（大文字・小文字区別なし）ソート後の配列:\n";
43print_r($sortedData);
44

このPHPサンプルコードは、文字列の配列を大文字・小文字を区別せずに降順でソートする方法を示しています。sortStringsCaseInsInsensitiveDesc関数は、ソート対象となる文字列配列（$strings）を引数として受け取り、ソート済みの新しい配列を返します。元の配列は変更されません。

関数内部では、PHPの組み込み関数であるsort()を利用しています。sort()は配列の要素を並び替えるために使われますが、その挙動は第2引数に指定する「フラグ」によって制御されます。ここでは複数のフラグを|（ビットOR演算子）で組み合わせて指定しています。

SORT_DESCは要素を降順（大きいものから小さいものへ）で並べ替えることを指示します。SORT_STRINGは要素を文字列として比較するように指定します。そして、SORT_FLAG_CASEは、ソートを行う際に大文字と小文字を区別しないように指定する定数です。これにより、「Apple」と「apple」のように大文字・小文字が異なるだけの文字列が同じものとして扱われ、期待通りの順序で並べ替えられます。

実行例では、混合された文字列配列がこれらの設定に基づいてソートされ、大文字・小文字を無視した降順の結果が出力される様子を確認できます。この機能は、データの一貫性が求められる場面で特に有用です。