mirror of
https://github.com/silverstripe/silverstripe-reports
synced 2024-10-22 11:05:53 +02:00
| _config | ||
| .github/workflows | ||
| .tx | ||
| code | ||
| javascript | ||
| lang | ||
| templates/SilverStripe/Reports/Includes | ||
| tests | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| code-of-conduct.md | ||
| composer.json | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| phpcs.xml.dist | ||
| phpstan.neon.dist | ||
| phpunit.xml.dist | ||
| README.md | ||
Reports
Installation
composer require silverstripe/reports
Introduction
This module contains the API's for building Reports that are displayed in the Silverstripe backend.
Troubleshooting
The reports section will not show up in the CMS if:
- There are no reports to show
- The logged in user does not have permission to view any reports
For large datasets, the reports section may take a long time to load, since each report is getting a count of the items it contains to display next to the title.
To mitigate this issue, there is a cap on the number of items that will be counted per report. This is set at 10,000 items by default, but can be configured using the limit_count_in_overview configuration variable. Setting this to null will result in showing the actual count regardless of how many items there are.
SilverStripe\Reports\Report:
limit_count_in_overview: 500
Note that some reports may have overridden the getCount method, and for those reports this may not apply.