pratechnic / php-reports

A PHP framework for displaying reports from any data source, including SQL and MongoDB

Php Reports

A light weight, extendable, PHP reporting framework for managing and displaying nice looking, exportable reports from any data source, including SQL and MongoDB

Major features include:

• Display a report from any data source that can output tabular data (SQL, MongoDB, PHP, etc.)
• Output reports in HTML, XML, CSV, JSON, or your own custom format
• Add customizable parameters to a report (e.g. start date and end date)
• Support for graphs and charts with the Google Data Visualization API
• Easily switch between database environments (e.g. Production, Staging, and Dev)
• Fully extendable and customizable

Introduction

Reports are organized and grouped in directories. Each report is it's own file.

A report consists of headers containing meta-data (e.g. name, description, column formatting, etc.) and the actual report (SQL statements, MongoDB js file, PHP code, etc.).

All reports return rows of data which are then outputted in the specified format (HTML, CSV, etc.).

The Php Reports framework ties together all these different report types, output formats, and meta-data into a consistent interface.

Example Reports

Here's an example of a SQL report:

-- My Report
-- This lists all the products that cost
-- more than a given price.
-- VARIABLE: min_price, Minimum Price

SELECT Name, Price FROM Products WHERE Price > "{{min_price}}"

The set of SQL comments at the top are the report headers.

The first row is always the report name. After that comes a description. Following that are any parameters or options.

The VARIABLE header tells the report framework to prompt the user before running the report. Once a value is provided, it will be passed into the report body ("{{min_price}}" in this example).

Here's a MongoDB report:

// My Other Report
// Lists all food products in a MongoDB collection
// MONGODATABASE: MyDatabase
// VARIABLE: include_inactive, Include Inactive?, yes|no

var query = {'type': 'food'};

if(include_inactive == 'no') {
    query.status = 'active';
}

var result = db.Products.find(query);

printjson(result);

As you can see, the structure is very similar. MongoDB reports use javascript style comments for the headers, but everything else remains the same.

The MONGODATABASE header, if specified, will populate the 'db' variable.

All VARIABLE headers are defined as variables in javascript before the report is run.

Here's a PHP Report:

<?php
//My Third Report
//This connects to the Stripe Payments api and shows a list of charges
//INCLUDE: /stripe.php
//VARIABLE: count, Number of Charges

if($count > 100 || $count < 1) throw new Exception("Count must be between 1 and 100");

$charges = Stripe_Charge::all(array("count" => $count));

$rows = array();
foreach($charges as $charge) {
    $rows[] = array(
        'Charge Id'=>$charge->id,
        'Amount'=>number_format($charge->amount/100,2),
        'Date'=>date('Y-m-d',$charge->created)
    );
}

echo json_encode($rows);
?>

Again, the header format is very similar.

The INCLUDE header includes another report within the running one. Below is example content of /stripe.php:

<?php
//Stripe PHP Included Report
//You can have headers here too; even nested INCLUDE headers!
//Some headers will even bubble up to the parent, such as the VARIABLE header

//include the Stripe API client
require_once('lib/Stripe/Stripe.php');

//set the Stripe api key
Stripe::setApiKey("123456");
?>

Hopefully, you can begin to see the power of the Php Report Framework.

For full documentation, see the wiki.