Go to file
github-actions 76a70ee9d6 Merge branch '4' into 5.1 2024-02-09 11:04:21 +00:00
.github/workflows MNT Run module-standardiser 2023-08-29 15:15:42 +12:00
.tx ENH Update translations 2023-03-06 18:20:21 +13:00
_config New style travis tests 2017-06-26 21:45:56 +12:00
code MNT Remove legacy upgrader config 2023-01-20 16:55:24 +13:00
javascript FIX broken URL builder when using MultiSelectFields as parameters 2023-09-21 13:21:46 +12:00
lang TLN Update translations (#176) 2024-02-08 13:29:26 +13:00
templates/SilverStripe/Reports/Includes FIX Apply missing class to report header. 2018-07-27 17:06:38 +12:00
tests MNT Don't expect trailing slash in tests 2023-01-13 13:08:13 +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
CONTRIBUTING.md Create CONTRIBUTING.md 2016-05-30 14:37:53 +12:00
LICENSE MNT Run module-standardiser 2023-08-29 15:15:42 +12:00
README.md DOC Update README.md for CMS 5 2023-04-19 17:56:52 +12:00
code-of-conduct.md Added standard code of conduct 2015-12-16 11:07:23 +13:00
composer.json MNT Run module-standardiser 2023-08-29 15:15:42 +12:00
phpcs.xml.dist MNT Update phpcs ruleset to use PSR-12 as a base 2022-08-26 13:48:51 +12:00
phpunit.xml.dist MNT Standardise modules 2022-08-01 15:36:42 +12:00

README.md

Reports

CI Silverstripe supported module

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.