Download the PHP package superbig/craft-reports without Composer

On this page you can find all versions of the php package superbig/craft-reports. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package craft-reports

Reports for Craft CMS 5

Write data reports in Twig and deliver them via email, CSV export, or queue jobs.

Requirements

Installation

Then install the plugin from the Craft Control Panel or run:

Quick Start

  1. Go to Reports in the CP sidebar
  2. Click New and give your report a name and handle
  3. Write your report in Twig using the result variable:

  4. Click Run to see the output, or Export to download as CSV

Configuration

Create a config/reports.php file to override defaults:

Option Type Default Description
enableScheduler bool true Enable the report scheduler
helpers array [] Custom helper functions available in report templates
pluginName string 'Reports' Override the plugin name in the CP

Writing Reports

Report templates receive two variables:

ReportResult API

Method Description
result.setHeader(array) Set column headers
result.append(array) Add a row (or array of rows)
result.setFilename(string) Set the CSV export filename
result.setContent(array) Replace all rows
result.getHeader() Get current headers
result.getContent() Get all rows

Example: Commerce Orders

Report Targets

Report targets deliver report results to external channels. Currently supported:

Setting Up an Email Target

  1. Go to Reports → Report Targets
  2. Click New, select Email as the target type
  3. Configure recipients and email body template
  4. Connect one or more reports to the target

The email body template has access to reports (connected reports) and target (the target model):

Console Commands

Run report targets from the CLI — useful for cron jobs or long-running reports:

Permissions

Permission Description
Run Reports View and run reports
Manage Reports Create, edit, and delete reports
Manage Export Targets Create, edit, and manage report targets

Breaking Changes (v3.0.0)


Brought to you by Superbig


All versions of craft-reports with dependencies

PHP Build Version
Package Version
Requires craftcms/cms Version ^3.0.0
league/csv Version ^8.1|^9.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package superbig/craft-reports contains the following files

Loading the files please wait ...