Go to file
Steve Boyd eacecdbb56 Merge branch '4.10' into 4.11 2022-08-02 18:38:08 +12:00
.github/workflows MNT Standardise modules 2022-08-01 15:36:42 +12:00
.tx Reorganise i18n keys 2017-05-08 17:56:43 +12:00
_config New style travis tests 2017-06-26 21:45:56 +12:00
code ENH PHP 8.1 compatibility 2022-04-13 17:39:46 +12:00
javascript Remove custom reportAdmin css overrides 2016-09-15 18:23:43 +12:00
lang Update translations 2021-05-17 10:53:21 +12:00
templates/SilverStripe/Reports/Includes FIX Apply missing class to report header. 2018-07-27 17:06:38 +12:00
tests ENH Add configuration to cap report counts for large datasets. (#139) 2022-01-31 17:20:11 +13:00
.editorconfig Update editorconfig 2017-10-12 12:57:05 +13:00
.gitattributes Feature Set .gitattributes to ignore docs and tests folder, and some source asset files which are not needed 2017-12-13 12:32:55 +13:00
.gitignore MINOR: gitignore of mac .DS_Store files 2011-09-28 11:44:30 +13:00
.upgrade.yml Add extra upgrade rules 2017-07-03 14:32:26 +12:00
CONTRIBUTING.md Create CONTRIBUTING.md 2016-05-30 14:37:53 +12:00
LICENSE FIX: Rename license file to match module standard. 2017-03-29 12:58:41 +13:00
README.md Merge branch '4.10' into 4.11 2022-08-02 18:38:08 +12:00
code-of-conduct.md Added standard code of conduct 2015-12-16 11:07:23 +13:00
composer.json ENH Prefer dependency injection for GridFieldComponents. (#147) 2022-03-04 10:13:45 +13:00
phpcs.xml.dist MNT Update how phpcs is called 2020-11-06 17:11:09 +13:00
phpunit.xml.dist MNT Standardise modules 2022-08-01 15:36:42 +12:00

README.md

Reports

CI Silverstripe supported module

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.

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.