Reporter
β‘οΈ
Features
-
π Reports are processed with Query Batching, making exports run quickly and without exhausting your memory limit -
π§ Inspired by Element API, create reports with a simple and familiar structure -
π¦ Reports stored using Asset volumes so you can host reports locally or on a cloud-based service like Amazon S3
π¦
Installing
Install Reporter one of two ways:
- Install via Craft's Plugin Store
- Run
composer require trendyminds/craft-reporterand enable the plugin from "Settings > Plugins"
π
Setup
To setup reports, create a reporter.php file in config/. Below is an example config file.
Example Config
'Reports', // The asset volume handle where your reports should be saved // NOTE: Your reports are publicly accessible if your volume has "Assets in this volume have public URLs" enabled 'volume' => 'uploads', // An optional folder path if you would like to nest the reports in a specific directory 'folder' => 'resources/reports', // An array of reports to produce 'reports' => [ 'pages' => function () { return [ 'name' => 'All Pages', 'description' => 'A simple export of all the pages on the site.', 'elementType' => Entry::class, 'criteria' => [ 'section' => 'pages' ], 'transformer' => function (Entry $entry) { return [ "id" => $entry->id, "title" => $entry->title, "url" => $entry->url, ]; } ]; }, 'allImages' => function () { return [ 'name' => 'Uploaded Images', 'description' => 'A list of all images uploaded into Craft', 'elementType' => Asset::class, 'criteria' => [ 'kind' => 'image' ], 'transformer' => function (Asset $asset) { return [ "id" => $asset->id, "title" => $asset->title, "filename" => $asset->filename, ]; } ]; }, ] ];">
use craft\elements\Entry;
use craft\elements\Asset;
return [
// The name to use throughout the control panel (defaults to "Reporter")
'displayName' => 'Reports',
// The asset volume handle where your reports should be saved
// NOTE: Your reports are publicly accessible if your volume has "Assets in this volume have public URLs" enabled
'volume' => 'uploads',
// An optional folder path if you would like to nest the reports in a specific directory
'folder' => 'resources/reports',
// An array of reports to produce
'reports' => [
'pages' => function () {
return [
'name' => 'All Pages',
'description' => 'A simple export of all the pages on the site.',
'elementType' => Entry::class,
'criteria' => [
'section' => 'pages'
],
'transformer' => function (Entry $entry) {
return [
"id" => $entry->id,
"title" => $entry->title,
"url" => $entry->url,
];
}
];
},
'allImages' => function () {
return [
'name' => 'Uploaded Images',
'description' => 'A list of all images uploaded into Craft',
'elementType' => Asset::class,
'criteria' => [
'kind' => 'image'
],
'transformer' => function (Asset $asset) {
return [
"id" => $asset->id,
"title" => $asset->title,
"filename" => $asset->filename,
];
}
];
},
]
];
π€
Contributing
If you would like to contribute to Reporter we tried to make it as easy as possible:
- Clone the repo
- Run
npm ito install the Node dependencies - Run
npm startto begin the watch task - Make your changes
- Run
npm run buildto compile and minify the CSS and JS - Submit a PR!
4 Feb 2, 2022
4 Sep 2, 2022
17 Sep 12, 2022
30 Mar 14, 2022
1 Nov 20, 2021
6 Nov 24, 2022
570 Dec 27, 2022
6 Apr 6, 2022
135 Dec 9, 2022
51 Dec 5, 2022
2.9k Jan 1, 2023
5 Dec 20, 2022
12 Nov 23, 2021
8 Nov 12, 2022
6 Mar 30, 2022
1.1k Dec 22, 2022
21 Aug 29, 2022
129 Dec 13, 2022
8 Nov 30, 2022
18 Dec 6, 2022
2 Jul 10, 2016
3 Oct 21, 2022
2 Jan 3, 2023
5 Nov 23, 2022
7 Apr 13, 2022