mirror of
https://github.com/silverstripe/silverstripe-reports
synced 2024-10-22 11:05:53 +02:00
375c31904f
Opted not to return the result from `getCount()` directly since the PHPDoc says this returns an int (even though it technically already returns a string if the report isn't set up correctly...)
36 lines
1.4 KiB
Markdown
36 lines
1.4 KiB
Markdown
# Reports
|
|
|
|
[](https://travis-ci.com/silverstripe/silverstripe-reports)
|
|
[](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
|
|
|
|
## Introduction
|
|
|
|
This module contains the API's for building Reports that are displayed in the
|
|
SilverStripe backend. This module replaces the built-in reports API from earlier
|
|
versions of SilverStripe (2.4 and 3.0).
|
|
|
|
## Requirements
|
|
|
|
* SilverStripe 4.0
|
|
|
|
## 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.
|
|
|
|
```yml
|
|
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.
|
|
|
|
## Links ##
|
|
|
|
* [License](./LICENSE)
|