watson/aggregate

Extend Laravel's query builder with additional relation aggregates.

5.3.0 2025-02-16 23:57 UTC

Requires

• php: ^8.1
• illuminate/database: ^10.0|^11.0|^12.0

Requires (Dev)

• mockery/mockery: ^1.4.4
• orchestra/testbench: ^8.0|^9.0|^10.0
• phpunit/phpunit: ^9.5.10|^10.5|^11.5.3

MIT

• Dwight Watson

• laravel
• eloquent
• aggregations

README

Laravel Eloquent allows you to query the count of a relationship using withCount. Aggregate extends Eloquent by adding withSum, withAvg, withMin and withMax.

This is based off the work in laravel/framework#25319 - thanks to Mohammad Sharif Ahrari (@spyp).

Installation

You can install the package via Composer:

composer require watson/aggregate

Usage

The additional methods will be added by Laravel's autodiscovery feature. You can then use them the same way you already use withCount. See the Laravel documentation for more on how this works.

$orders = Order::withSum('products', 'quantity')->get();

$orders->each(function ($order) {
    $order->products_sum;
});

You can also select multiple aggregates in a single query, as well as alias them.

$orders = Order::withCount('products')->withSum('products as products_price', 'price')->get();

$orders->each(function ($order) {
    $order->products_count;

    $order->products_price;
});

$orders = Order::withCount('products')->withMax('products', 'price')->get();

$orders->each(function ($order) {
    $order->products_count;

    $order->products_max;
});

Testing

vendor/bin/phpunit