Twig

Overview #

Starting from version 4.0.0, KoolReport supports other template engines rather than just its own template view file. Twig is one of the popular template engines that KoolReport supports.

Installation #

By downloading .zip file #

  1. Download
  2. Unzip the zip file
  3. Copy the folder twig into koolreport folder so that look like below
koolreport
├── core
├── twig

By composer #

composer require koolreport/twig

Get started #

Step 1: Add the twig service to your report

class Report extends \koolreport\KoolReport
{
    use \koolreport\clients\Bootstrap;

    use \koolreport\twig\Engine;
    protected function twigInit()
    {
        $loader = new \Twig\Loader\FilesystemLoader(dirname(__FILE__).'/views');
        $twig = new \Twig\Environment($loader);
        return $twig;
    }
    ...
}

Step 2: Create the view report.html inside views folder like below:

<html>
<head>
    <title>Welcome to Twig</title>
</head>
<body>
    <h1>Welcome to Twig</h1>
    {{ 
        widget('koolreport.widgets.koolphp.Table',{
            dataSource:report.dataStore("data"),
        }) 
    }}
</body>
</html>

Step 3: You can run your report with following line of code

$report = new Report;
$report->run()->render("report.html");

Congrat, Now you can use Twig to design your report.

Some notes: #

  1. In your template, you refer to report object with parameter report
  2. When use function widget() to generate koolreport's widget, you should change the backslash \ in the class name to dot ".", for example, you change: \koolreport\widgets\koolphp\Table to koolreport.widgets.koolphp.Table
  3. You can reference to any datastore with report.dataStore("name_of_datastore")

Limitation #

There are some limitation due to the fact that Twig does not allow PHP to run within. This limits some of capability of KoolReport's widget such as defining anonymous function. For example, there is no way to define custom function to format value in Table widget like this.

Table::create(array(
    ...
    "columns"=>array(
        "id"=>array(
            "formatValue"=>function($value)
            {
                return "<a href='$value'>View</a>";
            }
        )
    )
))

Simply it is not able to transform above php code to json definition in twig.