eidsonator/semantic-reports-bundle

A Symfony2+ Bundle for displaying reports from any data source, including SQL and MongoDB

Semantic-ui Reports Bundle

Now works with Symfony2.x and Symfony3.x, _(*1)

A Symfony bundle for managing and displaying nice looking, exportable reports from any data source, including SQL and MongoDB., _(*2)

Major features include:, _(*3)

• 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)
• Add graphs and charts with the Google Data Visualization API
• Supports multiple database environments (e.g. Production, Staging, and Dev)
• Fully extendable and customizable

Installation & Documentation

Installation & Documentation can be found in /Resources/doc/, _(*4)

Reporting an issue or a feature request

Issues and feature requests can be submitted to the Github issue tracker., _(*5)

Basic Introduction

Reports are organized and grouped in directories. Each report is it's own file., _(*6)

A report consists of headers containing meta-data (e.g. name and description) and the actual report (SQL queries, javascript, or PHP code)., _(*7)

All reports return rows of data which are then displayed in a sortable/searchable HTML table., _(*8)

Reports can be exported to a number of formats including CSV, XLS, JSON, and XML., _(*9)

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

Example Reports

Here's an example SQL report:, _(*11)

-- Products That Cost At Least $X
-- VARIABLE: {"name": "min_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., _(*12)

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

Here's a MongoDB report:, _(*14)

// List of All Foods
// MONGODATABASE: MyDatabase
// VARIABLE: {
//   "name": "include_inactive", 
//   "display": "Include Inactive?", 
//   "type": "select",
//   "options": ["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., _(*15)

The MONGODATABASE header, if specified, will populate the 'db' variable., _(*16)

Here's a PHP Report:, _(*17)

 100 || $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., _(*18)

The INCLUDE header includes another report within the running one. Below is example content of /stripe.php:, _(*19)