Laravel Report

Import Laravel Reporting into any Laravel 6+ application using this package.

Installation

Install Laravel Report with composer.

php composer require mblsolutions/report

Copy the package config to your local config.

php artisan vendor:publish --tag=report-config

Copy the package database migrations.

php artisan vendor:publish --tag=report-migrations

Laravel Report comes with its own database migrations, once the package has been installed run the migrations.

php artisan migrate

Usage

Once the package has been required into your project you can configure which parts of the package you would like to use.

Routes

To enable the package json api routes in your application add the following to your routes file.

Report::routes();

Manage routes

To configure custom middleware/guards around report management/creation only routes.

Report::manageRoutes();

View Routes

To configure custom middleware/guards around report view only routes.

Report::viewRoutes();

Export Routes

To configure custom middleware/guards around report export result only routes.

Report::exportRoutes();

Applying Custom Middleware/Gates

To apply middleware to the routes, wrap the routes in middleware groups.

Route::middleware(['admin'])->group(function () {
    Report::manageRoutes();
});

Route::middleware(['user'])->group(function () {
    Report::viewRoutes();
});

Route::middleware(['web'])->group(function () {
    Report::exportRoutes();
});

To apply gates to the routes, wrap the routes in middleware groups.

Route::middleware(['can:manage-reports'])->group(function () {
    Report::manageRoutes();
});

Route::middleware(['can:view-reports'])->group(function () {
    Report::viewRoutes();
});

Report Select Parameter Models

To enable select options when creating/rendering reports, you must add the available model types to be reported on in the report.php config file. Any models added to this array will be available when creating new report fields.

Models added to the array should implement the \MBLSolutions\Report\Interfaces\PopulatesReportOption interface

Please Note: We recommend that large record sets are not used as select types, due to usability/browser performance issues.

[
    'models' => [
        \App\User::class,
        \App\Order::class
    ]
]

Scheduled Reporting

To enable scheduled reporting add the following line into the schedule method of the \App\Console\Kernel file of your laravel application.

$schedule->command(\MBLSolutions\Report\Console\Commands\DispatchScheduledReportsCommand::class)->hourly();

Report JSON API

The following endpoints are available to you once the routes have been added:

View Routes (synchronous)

Method	URI	Name
GET	/api/report	report.index
GET	/api/report/{report}	report.show
POST	/api/report/{report}	report.render
POST	/report/{report}/export	report.export
GET	/api/report/connection	report.connection.list
GET	/api/report/middleware	report.middleware.list
GET	/api/report/data/type	report.data.type.list
GET	/api/report/model	report.model.list

Queued View Routes (asynchronous)

Method	URI	Name
GET	/api/report/queue	report.queue.index
GET	/api/report/queue/pending	report.queue.pending.index
POST	/api/report/queue/{report}	report.queue.render
GET	/api/report/queue/job/{job}	report.queue.job
GET	/api/report/queue/result/{job}	report.queue.result
GET	/api/report/queue/export/{job}	report.queue.export

Scheduled Report Routes

Method	URI	Name
GET	/report/schedule/frequency	report.schedule.frequencies
GET	/report/schedule	report.schedule.index
POST	/report/schedule	report.schedule.create
GET	/report/schedule{schedule}	report.schedule.show
PATCH	/report/schedule/{schedule}	report.schedule.create
DELETE	/report/schedule/{schedule}	report.schedule.destroy

Export Routes

Method	URI	Name
GET	/report/{report}/export	report.export

Manage Routes

Method	URI	Name
GET	/api/report/manage	report.manage.index
POST	/api/report/manage	report.manage.store
POST	/api/report/test	report.manage.test
GET	/api/report/manage/{report}	report.manage.show
PATCH	/api/report/manage/{report}	report.manage.update
DELETE	/api/report/manage/{report}	report.manage.destroy
DELETE	/api/report/manage/settings	report.manage.settings

Report Events

Events are fired at critical points during report creation/completion

Event	Description	Data	Namespace
ReportCreated	A new report was created.	Report $report	MBLSolutions\Report\Events\ReportCreated
ReportUpdated	A report was updated.	Report $report	MBLSolutions\Report\Events\ReportUpdated
ReportDestroyed	A report was deleted.	Report $report	MBLSolutions\Report\Events\ReportDestroyed
ReportRendered	A report was rendered.	Report $report	MBLSolutions\Report\Events\ReportRendered
ReportExported	A report was exported.	Report $report	MBLSolutions\Report\Events\ReportExported
ReportRenderStarted	A queued report job to render was started.	Report $report, ReportJob $job	MBLSolutions\Report\Events\ReportRenderStarted
ReportChunkComplete	A queued report job chunk was completed.	Report $report, ReportJob $job	MBLSolutions\Report\Events\ReportChunkComplete
ReportRenderComplete	A queued report job render was completed.	Report $report, ReportJob $job	MBLSolutions\Report\Events\ReportRenderComplete
ScheduledReportDispatched	A scheduled report was run.	ScheduledReport $schedule	MBLSolutions\Report\Events\ReportRenderComplete