outcloud/php-array-sum-callable

Calculates sum of elements of array given by callback function

1.0.1 2017-11-14 10:24 UTC

This package is not auto-updated.

Last update: 2024-05-12 02:35:43 UTC


README

Sums array of objects/numbets via callable function

Example usage:

Let's assume we have any object of any class with some numeric value inside. We have an array of that objects, and we have to calculate a sum of those numeric values.

Let's this be our class

class Num{
    private $value;
    
    public function __construct(int $number){
        $this->value = $number;
    }
    public function getValue(){
        return $this->value;
    }
}

we have array of items of 'Num' class

$items = [
    new Num(1),
    new Num(2),
    new Num(3),
];

Let's use array_sum_callable to calculate sum of that numbers

array_sum_callable($items, function($item){
    return $item->getValue();
});

Result will of course be: 6

Return Values

Returns the sum of values as an integer or float; 0 if the array is empty.

Installation

via Composer:

composer require outcloud/php-array-sum-callable

function will be registered in global namespace.