【PHP8.x】array_count_values関数の使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 多次元配列に含まれるすべての値の出現回数を数えます。
7 *
8 * array_count_values() は1次元配列しか直接処理できません。
9 * この関数は、多次元配列をまず1次元配列に平坦化（フラット化）してから、
10 * array_count_values() を適用することで、多次元配列内の値の出現回数を数えます。
11 *
12 * @param array $multidimensionalArray 値を数える対象の多次元配列
13 * @return array 各値の出現回数を格納した連想配列
14 */
15function count_values_recursively(array $multidimensionalArray): array
16{
17    // 平坦化された値を格納するための配列を初期化します。
18    $flattenedArray = [];
19
20    // array_walk_recursive() を使い、多次元配列の全ての末端要素に対して処理を行います。
21    // クロージャー（無名関数）を使い、各値を $flattenedArray に追加します。
22    array_walk_recursive(
23        $multidimensionalArray,
24        function ($value) use (&$flattenedArray) {
25            $flattenedArray[] = $value;
26        }
27    );
28
29    // 平坦化された1次元配列を array_count_values() に渡して、値の出現回数を返します。
30    return array_count_values($flattenedArray);
31}
32
33// サンプルとして、各店舗のフルーツの販売データを多次元配列で定義します。
34$salesData = [
35    'tokyo_store' => ['apple', 'orange', 'apple'],
36    'osaka_store' => ['grape', 'orange', 'orange'],
37    'fukuoka_store' => ['apple', 'grape', 'banana'],
38];
39
40// 関数を実行して、全店舗で販売されたフルーツの合計数を計算します。
41$totalFruitCounts = count_values_recursively($salesData);
42
43// 結果を出力します。
44print_r($totalFruitCounts);
45
46/*
47 * 実行結果:
48 *
49 * Array
50 * (
51 *     [apple] => 3
52 *     [orange] => 3
53 *     [grape] => 2
54 *     [banana] => 1
55 * )
56 */
57

PHPの array_count_values 関数は、配列に含まれる各値の出現回数を数えるための便利な関数です。この関数は引数として配列を受け取り、値とその出現回数をペアにした新しい連想配列を返します。ただし、array_count_values は1次元の配列しか直接処理できないという制約があります。

このサンプルコードは、その制約を回避し、多次元配列に含まれるすべての値の出現回数を数える方法を示しています。そのために、count_values_recursively という独自の関数を定義しています。この関数は、まず array_walk_recursive 関数を利用して、引数で受け取った多次元配列を1次元の配列に変換（平坦化）します。array_walk_recursive は、多次元配列の階層をたどり、末端の要素一つひとつに対して指定した処理を実行します。ここでは、見つかった値をすべて新しい配列に格納しています。

その後、平坦化してできた1次元配列を array_count_values 関数に渡すことで、最終的に多次元配列全体での値の出現回数を集計しています。サンプルでは、店舗ごとのフルーツ販売データが格納された多次元配列から、全店舗を合算したフルーツごとの総販売数を算出しています。

Copy
1<?php
2
3// ユーザー名（キー）と好きな果物（値）を格納した連想配列を準備します。
4$userFavoriteFruits = [
5    'Taro' => 'apple',
6    'Jiro' => 'banana',
7    'Hanako' => 'apple',
8    'Yoshiko' => 'orange',
9    'Saburo' => 'banana',
10    'Goro' => 'apple',
11];
12
13// array_count_values() は、連想配列の「値」の出現回数を集計します。
14// この例では、キー（ユーザー名）は無視され、値（果物名）がカウントされます。
15$fruitCounts = array_count_values($userFavoriteFruits);
16
17// 結果を出力します。
18// 元の配列の値であった果物名がキーとなり、その出現回数が値となる新しい連想配列が返されます。
19print_r($fruitCounts);
20
21/*
22--- 実行結果 ---
23Array
24(
25    [apple] => 3
26    [banana] => 2
27    [orange] => 1
28)
29*/

PHPの array_count_values() 関数は、配列内に各値が何回出現するかを集計するための関数です。

この関数は、引数として集計したい配列を一つ受け取ります。サンプルコードでは、ユーザー名をキー、好きな果物を値とする連想配列 $userFavoriteFruits を引数に渡しています。連想配列を引数にした場合、array_count_values() はキーを無視し、値のみを集計の対象とします。そのため、この例では 'Taro' や 'Jiro' といったユーザー名ではなく、'apple' や 'banana' といった果物名の出現回数がカウントされます。

関数の処理が完了すると、結果を格納した新しい連想配列が戻り値として返されます。この新しい連想配列では、元の配列で値だった要素（この例では果物名）がキーとなり、その出現回数が新しい値となります。サンプルコードの実行結果を見ると、'apple' は3回出現したため ['apple'] => 3 となり、'banana' は2回、'orange' は1回出現したことがわかります。このように、データ内の各要素の頻度を簡単に集計したい場合に非常に便利な関数です。