silverstripe/reports

Reports module for SilverStripe CMS

6.0.0-alpha1 2024-11-28 01:31 UTC

Requires

• php: ^8.3
• silverstripe/admin: ^3
• silverstripe/assets: ^3
• silverstripe/cms: ^6
• silverstripe/config: ^3
• silverstripe/framework: ^6
• silverstripe/vendor-plugin: ^2
• silverstripe/versioned: ^3

Requires (Dev)

• phpstan/extension-installer: ^1.3
• phpunit/phpunit: ^11.3
• silverstripe/standards: ^1
• silverstripe/taxonomy: ^4
• squizlabs/php_codesniffer: ^3.7
• symbiote/silverstripe-queuedjobs: ^6

BSD-3-Clause

• SilverStripe
• The SilverStripe Community

• cms
• silverstripe
• reports

README

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.

Links

• License