outcloud/php-array-avg-callable

Calculates average of elements of array given by callable function

php_array_avg_callable

Calculates average value from array of objects/numbets via callable function, _(*1)

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 average of those numeric values., _(*2)

Let's this be our class, _(*3)

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, _(*4)

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

Let's use array_avg_callable to calculate avg of that numbers, _(*5)

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

Result will of course be: 2, _(*6)

Return Values

Returns the avg of values as an integer or float; an exception will be thrown if array is empty, _(*7)

Installation

via Composer:, _(*8)

composer require outcloud/php-array-avg-callable

function will be registered in global namespace., _(*9)