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 plugin for Craft CMS 3.x

Write reports with Twig.

Requirements

This plugin requires Craft CMS 3.0.0 or later.

Installation

To install the plugin, follow these instructions.

  1. Open your terminal and go to your Craft project:

    cd /path/to/project
  2. Then tell Composer to load the plugin:

    composer require superbig/craft-reports
  3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Reports.

Reports Overview

Reports for Craft CMS and Craft Commerce makes it possible to write reports in Twig via a simple, fluent API.

It also makes it possible to setup report targets like email and (soon) Slack.

This way you can send reports directly to your target channels, either on demands or (soon) on a schedule.

Configuring Reports

You can override the options with a config file called reports.php:

Using Reports

You may use includes both for the Report Content and Settings fields.

The content Twig will be passed the following variables:

Report Example

To generate a list of users that has logged in the last 30 days:

Report Target Example

Report targets makes it possible to send the result of a report to target channels.

For now, email is supported, with Slack and more coming soon.

Example email body:

Note that you have access to both the reports attached to the target and the target itself.

Running report targets through Craft's console command

You can run any report targets through the console with the following command

The command can also receive the target's ID.

This way of running report targets is particularly useful if you want to run it from a cron job, or you have bigger reports that require more memory or runs longer than a normal web request can handle.

Reports Roadmap

Some things to do, and ideas for potential features:

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 ....