包简介

Allow KoolReport to use twig template engine to render view

README 文档

README

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

Download
Unzip the zip file
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:

In your template, you refer to report object with parameter report
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
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.

Resources

Support

Please use our forum if you need support, by this way other people can benefit as well. If the support request need privacy, you may send email to us at support@koolreport.com.

koolreport/twig 适用场景与选型建议

koolreport/twig 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 1.75k 次下载、GitHub Stars 达 0，最近一次更新时间为 2019 年 06 月 01 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「php」「twig」「template engine」「Data Report」「Reporting Tools」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 koolreport/twig 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 koolreport/twig 我们能提供哪些服务？

定制开发 / 二次开发

基于 koolreport/twig 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 koolreport/twig 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

shoot/shoot 40

Shoot aims to make providing data to your templates more manageable

erelke/twig-spreadsheet-bundle 2

This Symfony bundle integrates PhpSpreadsheet into Symfony using Twig.

nerds-and-company/css-to-inline-styles-twig-extension 3

A Twig extension to insert css as inline styles with a tag

odan/twig-assets 22

Caching and compression for Twig assets (JavaScript and CSS).

yep/tracy-twig-extensions 5

Twig extensions for Tracy Debugger

mediagone/twig-powerpack 4

Provides code-quality helpers to your Twig templates.

koolreport/twig

包简介

关键字：