feat(reporting): fresh reporting implementation

2026-09-03 05:41:07 +00:00 · 2026-08-21 10:51:26 +02:00
parent 923a383ec5
commit cbd739db0f
9 changed files with 1018 additions and 0 deletions
@@ -0,0 +1,142 @@
+<?php
+
+namespace App\Domains\Reporting\Http\Controllers;
+
+use App\Domains\Accounts\Models\Company;
+use App\Domains\Accounts\Models\CompanySetting;
+use App\Domains\Contacts\Models\Customer;
+use App\Domains\Money\Models\Currency;
+use App\Platform\Http\Controller;
+use App\Platform\Pdf\Facades\Pdf;
+use App\Platform\Pdf\Rendering\PdfPageSetup;
+use App\Platform\Pdf\Rendering\PdfTemplateUtils;
+use Carbon\Carbon;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\App;
+use Silber\Bouncer\BouncerFacade;
+
+/**
+ * Turnover of a period broken down by the customer it came from.
+ *
+ * A customer earns a block on the page by having at least one document dated
+ * inside the window; the block lists those documents and what they came to in
+ * the company's own currency, and the page total is the sum of the blocks.
+ * Credit notes count as documents here, so a reversal both keeps its customer
+ * on the page and drags the figures down with it.
+ */
+class CustomerSalesReportController extends Controller
+{
+    /**
+     * Render the report for the company the hash names.
+     *
+     * @param  string  $hash
+     */
+    public function __invoke(Request $request, $hash)
+    {
+        $company = $this->reportedCompany($hash);
+
+        App::setLocale(CompanySetting::getSetting('language', $company->id));
+
+        $window = $request->only(['from_date', 'to_date']);
+
+        $opened = Carbon::createFromFormat('Y-m-d', $request->from_date);
+        $closed = Carbon::createFromFormat('Y-m-d', $request->to_date);
+
+        $customers = Customer::query()
+            ->with(['invoices' => fn ($documents) => $documents->whereBetween(
+                'invoice_date',
+                [$opened->format('Y-m-d'), $closed->format('Y-m-d')]
+            )])
+            ->where('company_id', $company->id)
+            ->applyInvoiceFilters($window)
+            ->get();
+
+        $grandTotal = 0;
+
+        $customers->each(function (Customer $customer) use (&$grandTotal): void {
+            $earned = $customer->invoices->sum('base_total');
+
+            $customer->totalAmount = $earned;
+            $grandTotal += $earned;
+        });
+
+        view()->share([
+            'customers' => $customers,
+            'totalAmount' => $grandTotal,
+        ] + $this->pageChrome($request, $company));
+
+        return $this->emit($request, 'sales-customers');
+    }
+
+    /**
+     * The company named by the hash, once the caller has been let through.
+     *
+     * Nothing upstream tells Bouncer which company to weigh abilities against:
+     * these links carry no company header, and the report ability is stored
+     * per company, so the unscoped check matched nothing and every report
+     * answered 403. Pointing the scope at the company in the URL settles that
+     * without widening access, because the policy still asks for membership.
+     * The hash is an address, not a credential.
+     *
+     * @param  string  $hash
+     */
+    private function reportedCompany($hash): Company
+    {
+        $company = Company::query()->where('unique_hash', $hash)->firstOrFail();
+
+        BouncerFacade::scope()->to($company->id);
+
+        $this->authorize('view report', $company);
+
+        return $company;
+    }
+
+    /**
+     * What every report prints around its figures: the company and its logo,
+     * the window in the company's own date format, and the currency the
+     * amounts are stated in.
+     *
+     * @return array<string, mixed>
+     */
+    private function pageChrome(Request $request, Company $company): array
+    {
+        $pattern = CompanySetting::getSetting('carbon_date_format', $company->id);
+        $opened = Carbon::createFromFormat('Y-m-d', $request->from_date)->translatedFormat($pattern);
+        $closed = Carbon::createFromFormat('Y-m-d', $request->to_date)->translatedFormat($pattern);
+        $currencyId = CompanySetting::getSetting('currency', $company->id);
+        $currency = Currency::findOrFail($currencyId);
+
+        return [
+            'company' => $company,
+            'logo' => $company->logo_path,
+            'from_date' => $opened,
+            'to_date' => $closed,
+            'currency' => $currency,
+        ];
+    }
+
+    /**
+     * Hand the rendered report over in whichever of the three shapes the query
+     * string asks for.
+     *
+     * Reports have no template chooser, so an override is a file of the same
+     * name dropped into storage/app/templates/pdf/reports/, which the resolver
+     * prefers over the built-in one.
+     *
+     * The document is built before the preview branch is taken and not after:
+     * a preview costs a full render it never uses, which is wasteful but is
+     * also what the templates have always been exercised through.
+     */
+    private function emit(Request $request, string $design)
+    {
+        $design = PdfTemplateUtils::resolveView('reports', $design);
+
+        $document = Pdf::loadView($design, [], PdfPageSetup::forReports());
+
+        if ($request->exists('preview')) {
+            return view($design);
+        }
+
+        return $request->exists('download') ? $document->download() : $document->stream();
+    }
+}