You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Steve Boyd bd74939c14
Merge pull request #154 from creative-commoners/pulls/4/rescue-master-psr12
4 weeks ago
.github/workflows MNT Standardise modules 2 months ago
.tx Reorganise i18n keys 5 years ago
_config New style travis tests 5 years ago
code Use Injector to instantiate new base report instances 1 month ago
javascript Remove custom reportAdmin css overrides 6 years ago
lang Update translations 1 year ago
templates/SilverStripe/Reports/Includes FIX Apply missing class to report header. 4 years ago
tests ENH Fix phpcs violations 1 month ago
.editorconfig Update editorconfig 5 years ago
.gitattributes Feature Set .gitattributes to ignore docs and tests folder, and some source asset files which are not needed 5 years ago
.gitignore MINOR: gitignore of mac .DS_Store files 11 years ago
.upgrade.yml Add extra upgrade rules 5 years ago
CONTRIBUTING.md Create CONTRIBUTING.md 6 years ago
LICENSE FIX: Rename license file to match module standard. 6 years ago
README.md Merge branch '4.10' into 4.11 2 months ago
code-of-conduct.md Added standard code of conduct 7 years ago
composer.json ENH Prefer dependency injection for GridFieldComponents. (#147) 7 months ago
phpcs.xml.dist MNT Update phpcs ruleset to use PSR-12 as a base 1 month ago
phpunit.xml.dist MNT Standardise modules 2 months ago

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.