Groups & aggregates

$r->group('category', function ($category): void {
    $category->header(view: 'category-head');
    $category->footer(view: 'category-foot');
    $category->aggSum('price', as: 'category_total');

    // Second level: a group inside a group.
    $category->group('supplier', function ($supplier): void {
        $supplier->header(view: 'supplier-head');
        $supplier->aggSum('price', as: 'supplier_total');
    });
});

// Composite key: one group per category + currency combination.
$r->group(['category', 'currency'], function ($group): void {
    $group->header(view: 'group-head');
});

<?php

declare(strict_types=1);

namespace App\Reports\PriceList;

use App\Reports\Layout\CompanyLayout;
use Guggach\Reports\Definition\ReportBuilder;
use Guggach\Reports\Filters\FilterBuilder;
use Guggach\Reports\Report as BaseReport;
use Guggach\Reports\Sources\ReportSource;

final class Report extends BaseReport
{
    public function key(): string
    {
        return 'price_list';
    }

    public function name(): string
    {
        return 'Preisliste';
    }

    public function layout(): string
    {
        return CompanyLayout::class;
    }

    public function source(): ReportSource
    {
        return new Source;
    }

    /**
     * Demonstrate the fluent control description: operator listbox for the
     * number, multiselect for the enum and a searchable dual-list for the
     * relation (id/FK) field.
     */
    public function filterControls(): array
    {
        return FilterBuilder::for($this->source())
            ->field('price')->operators(['=', '>=', '<=', 'between', 'in'])
            ->field('category')->multiselect()
            ->field('supplier')->picker(valueField: 'id', labelField: 'label')
            ->build();
    }

    public function define(ReportBuilder $r): void
    {
        // Module-relative view names resolve to app/Reports/PriceList/views/*.
        // Report start/end run once per report; the grid header introduces the
        // table and the detail band renders one row per record.
        $r->reportStart(view: 'report-start');
        $r->gridHeader(view: 'grid-head');
        $r->detail(view: 'row');
        $r->reportEnd(view: 'report-end');

        // Grouped by category (data is sorted by category) with a subtotal.
        $r->group('category', function ($g): void {
            $g->header(view: 'category-head');
            $g->footer(view: 'category-foot');
            $g->aggSum('price', as: 'category_total');
        });
    }
}

<tr>
    <td colspan="3" style="padding-top:10px; font-weight:700; border-bottom:1px solid #0f766e; color:#0f766e">
        {{ $ctx->currentGroup()['key'] }}
    </td>
</tr>

<tr style="font-weight:600; background:#f3f4f6">
    <td colspan="2">Summe {{ $ctx->currentGroup()['key'] }}</td>
    <td style="text-align:right">{{ number_format((float) $ctx->aggregates['category_total'], 2, '.', "'") }}</td>
</tr>

use Guggach\Reports\Aggregates\Avg;
use Guggach\Reports\Aggregates\Count;
use Guggach\Reports\Aggregates\Max;
use Guggach\Reports\Aggregates\Sum;

public function define(ReportBuilder $r): void
{
    // ...

    // Report-wide: available in the report end band (and cumulatively
    // while the detail rows are rendered).
    $r->aggregate('grand_total', Sum::class, field: 'price');
    $r->aggregate('average_price', Avg::class, field: 'price');
    $r->aggregate('position_count', Count::class);
    $r->aggregate('highest_price', Max::class, field: 'price');

    $r->group('category', function ($g): void {
        // Group-wide: available in the group footer.
        $g->aggSum('price', as: 'category_total');
        $g->aggregate(['type' => 'count', 'field' => 'sku', 'as' => 'category_count']);
    });
}

{{-- Group footer: group + report aggregates --}}
<tr>
    <td colspan="2">Summe {{ $ctx->currentGroup()['key'] }}</td>
    <td style="text-align:right">
        {{ $ctx->currency($ctx->aggregates['category_total']) }}
    </td>
</tr>

{{-- Report end: report aggregates --}}
<p>{{ $ctx->total }} Positionen,
   Gesamt {{ $ctx->currency($ctx->aggregates['grand_total']) }}</p>

$r->group('category', function ($g): void {
    $g->header(view: 'category-head');
    $g->footer(view: 'category-foot');
});

// Group-scoped aggregate declared on the report builder.
// Equivalent to $g->aggSum('amount', as: 'category_total').
$r->aggregate(
    'category_total',
    Sum::class,
    field: 'amount',
    scope: 'group:1',
);

// Report-scoped aggregate.
$r->aggregate('grand_total', Sum::class, field: 'amount', scope: 'report');

use App\Reports\GroupEnrichment\CategoryInfo;

$r->group('category', function ($g): void {
    $g->header(view: 'category-head');
    $g->footer(view: 'category-foot');
    $g->enrichWith(CategoryInfo::class);
});

use App\Models\DemoCategory;
use Guggach\Reports\Sources\EloquentSource;
use Guggach\Reports\Sources\ReportField;
use Guggach\Reports\Sources\ReportSource;

final class CategoryInfo extends ReportSource
{
    public function records(): iterable
    {
        return (new EloquentSource(
            DemoCategory::class,
            [new ReportField('category', 'Kategorie', type: 'enum')],
        ))
            ->withFilters($this->filters() ?? [])
            ->withLocale($this->locale())
            ->records();
    }
}

@php($info = $ctx->groupData())

<div class="group-head">
    <strong>{{ $info?->name ?? $ctx->currentGroup()['key'] }}</strong>
    <span>Ziel {{ $ctx->currency($info->target) }}</span>
</div>