Report Builder Docs

Appearance

Configuration ​

Published config file: config/report-builder.php

Available options ​

  • route_prefix
    • route prefix used only if you expose package routes in your app layer
  • web_middleware
    • middleware stack for web routes (app integration choice)
  • api_middleware
    • middleware stack for API routes (app integration choice)
  • default_per_page
    • default preview pagination size
  • max_per_page
    • maximum preview pagination size
  • preview_limit
    • hard cap for preview rows in one execution
  • max_chart_points
    • optional cap for chart-oriented payloads in host app integrations
  • default_cache_ttl_seconds
    • default cache TTL for host-level caching strategies
  • max_export_rows_sync
    • recommended max rows for synchronous exports
  • exports_disk
    • storage disk used by host-level export delivery pipelines
  • exports_queue
    • queue name used by host-level async export jobs
  • enable_dashboards
    • feature flag for dashboard-oriented integrations
  • enable_excel
    • feature flag for XLSX export workflows
  • enable_pdf
    • feature flag for PDF export workflows
  • report_sources
    • list of ReportSource classes loaded through package config

Current practical impact ​

For engine usage today, the most important keys are:

  • default_per_page
  • max_per_page
  • preview_limit
  • max_export_rows_sync
  • enable_excel

Example ​

php
return [
    'default_per_page' => 25,
    'max_per_page' => 100,
    'preview_limit' => 100,
    'max_export_rows_sync' => 5000,
    'enable_excel' => false,

    // Optional, only if you expose package routes from your app layer.
    'route_prefix' => 'report-builder',
    'api_middleware' => ['api'],

    // Optional ReportSource classes loaded from config.
    'report_sources' => [
        // App\ReportSources\OrdersSource::class,
    ],
];