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

Copy
1<?php
2
3/**
4 * 多次元配列内のすべての数値要素を再帰的に合計します。
5 * array_sum 関数は単一配列にのみ適用されるため、
6 * 多次元配列全体を合計するにはこのような再帰的なアプローチが必要です。
7 *
8 * @param array $array 合計する多次元配列。
9 * @return int|float 配列内のすべての数値要素の合計。
10 */
11function sumMultidimensionalArray(array $array): int|float
12{
13    $totalSum = 0;
14
15    foreach ($array as $value) {
16        if (is_array($value)) {
17            // 要素が配列の場合、再帰的に関数を呼び出し、その内容を合計に加算します。
18            $totalSum += sumMultidimensionalArray($value);
19        } elseif (is_numeric($value)) {
20            // 要素が数値（整数または浮動小数点数）の場合、合計に加算します。
21            $totalSum += $value;
22        }
23        // 非数値、非配列の値（例：文字列、null、真偽値）は無視されます。
24        // これは、array_sum が非数値を暗黙的に（可能な場合は0として）処理するのと同様です。
25    }
26
27    return $totalSum;
28}
29
30// --- 使用例 ---
31
32$myMultidimensionalArray = [
33    1,
34    [2, 3],
35    4,
36    [5, [6, 7]],
37    '無視される文字列', // is_numeric()によって無視されます
38    null,               // is_numeric()によって無視されます
39    [8, 'ここも無視']   // 内部の文字列も無視されます
40];
41
42// 多次元配列の合計を計算
43$totalSum = sumMultidimensionalArray($myMultidimensionalArray);
44
45// この例では、1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 = 36 が期待されます。
46// var_dump($totalSum); // 必要に応じて結果を確認するためにコメントを外してください
47
48// 別の例
49$anotherMultidimensionalArray = [
50    [10.5, 20],
51    [30, [40, 50]],
52    ['a', 'b', 60] // 'a', 'b' は無視され、60は合計されます
53];
54
55$anotherTotal = sumMultidimensionalArray($anotherMultidimensionalArray);
56// この例では、10.5 + 20 + 30 + 40 + 50 + 60 = 210.5 が期待されます。
57// var_dump($anotherTotal); // 必要に応じて結果を確認するためにコメントを外してください

PHPの標準関数であるarray_sumは、与えられた配列内のすべての数値の合計を計算しますが、この関数は一次元配列にのみ適用されます。配列の中にさらに配列が含まれる多次元配列の場合、array_sumだけでは内側の配列の数値を合計することはできません。

この課題を解決するため、サンプルコードではsumMultidimensionalArrayという関数を定義しています。この関数は、引数として受け取った$array内のすべての数値要素を再帰的に合計することを目的としています。関数内部では、まず$totalSumをゼロで初期化し、配列の各要素を順に調べていきます。

もし要素が別の配列であれば、is_array($value)の条件が真となり、この関数自身をその内側の配列に対して再度呼び出します。これにより、配列の深さに関わらずすべての階層をたどって数値を探すことができます。これが「再帰」と呼ばれる処理です。要素が数値である場合（is_numeric($value)）、その値を$totalSumに加算します。文字列やnullなど、数値でも配列でもない要素は自動的に無視され、合計には含まれません。

このようにして、sumMultidimensionalArray関数は多次元配列の深部にある数値も適切に合計し、最終的な結果をint型またはfloat型で戻り値として返します。システム開発において、複雑なデータ構造から特定の数値を集計する際に非常に役立つアプローチです。

Copy
1<?php
2
3/**
4 * 指定された条件に基づいて配列の要素を合計します。
5 *
6 * この関数は、まずarray_filterを使用して元の配列から条件を満たす要素を抽出し、
7 * その後、array_sumを使用して抽出された要素の合計を計算します。
8 *
9 * @param array<int|float> $array 数値を含む配列。
10 * @param callable $condition 各要素に適用する条件を定義するクロージャ（匿名関数）。
11 *                          クロージャは要素を引数として受け取り、trueまたはfalseを返します。
12 * @return int|float 条件を満たした要素の合計。配列が空の場合や条件を満たす要素がない場合は0が返されます。
13 */
14function arraySumWithCondition(array $array, callable $condition): int|float
15{
16    // array_filterを使って、指定された条件に合致する要素のみを抽出します。
17    // クロージャ$conditionが各要素に対して実行され、trueを返した要素のみが残ります。
18    $filteredArray = array_filter($array, $condition);
19
20    // 抽出された配列の合計を array_sum で計算して返します。
21    // array_sumは、配列が空の場合や数値以外の要素がある場合は0を返します。
22    return array_sum($filteredArray);
23}
24
25// --- 使用例 ---
26
27// 数値のサンプル配列を準備します。
28$numbers = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12];
29
30echo "元の配列: " . implode(', ', $numbers) . PHP_EOL;
31
32// 例1: 偶数のみを合計する条件
33// クロージャは、要素が2で割り切れる（偶数である）場合にtrueを返します。
34$sumOfEvenNumbers = arraySumWithCondition($numbers, function (int $number): bool {
35    return $number % 2 === 0;
36});
37echo "偶数の合計: " . $sumOfEvenNumbers . PHP_EOL; // 期待される出力: 2 + 4 + 6 + 8 + 10 + 12 = 42
38
39// 例2: 5より大きい数値のみを合計する条件
40// クロージャは、要素が5より大きい場合にtrueを返します。
41$sumGreaterThanFive = arraySumWithCondition($numbers, function (int $number): bool {
42    return $number > 5;
43});
44echo "5より大きい数値の合計: " . $sumGreaterThanFive . PHP_EOL; // 期待される出力: 6 + 7 + 8 + 9 + 10 + 11 + 12 = 63
45
46// 例3: 10未満の奇数のみを合計する条件
47// 複数の条件を論理演算子 (&&, ||) で組み合わせることも可能です。
48$sumOddLessThanTen = arraySumWithCondition($numbers, function (int $number): bool {
49    return ($number % 2 !== 0) && ($number < 10);
50});
51echo "10未満の奇数の合計: " . $sumOddLessThanTen . PHP_EOL; // 期待される出力: 1 + 3 + 5 + 7 + 9 = 25
52

このサンプルコードは、PHPの配列から特定の条件に合致する要素のみを抽出し、その合計を計算するカスタム関数arraySumWithConditionの利用方法を示しています。この関数は、指定された数値配列と条件を定義するクロージャ（匿名関数）を引数として受け取り、条件を満たす要素の合計を返します。

arraySumWithCondition関数は内部で二つのPHP標準関数を使用しています。まずarray_filter関数は、配列の各要素に$conditionで指定されたクロージャを適用し、クロージャがtrueを返した要素のみを新しい配列として抽出します。次に、抽出された要素の合計を計算するためにarray_sum関数が使われます。array_sumは配列内のすべての数値要素の合計を返す関数です。

引数$arrayには合計対象の数値を含む配列を渡します。引数$conditionには、配列の各要素に対して実行される関数（クロージャ）を指定します。このクロージャは要素を引数として受け取り、その要素を合計に含めるべきであればtrueを、含めないべきであればfalseを返すように実装します。戻り値は、条件を満たした要素の合計値で、整数（int）または浮動小数点数（float）となります。条件を満たす要素が一つもない場合は0が返されます。

使用例では、偶数の合計、5より大きい数値の合計、10未満の奇数の合計といった具体的な条件設定を通じて、arraySumWithCondition関数が柔軟に利用できることが示されています。これにより、配列操作において特定の条件に基づいた集計処理を簡単に行うことが可能です。