Skip to main content

Table Renderer

To transform the query result into a table or a pivot table, you can use the TableRenderer service.

Rendering a Pivot Table or Regular Table​

The render() method will return a pivot table in HTML string that you can use in your view. If the query does not have a hierarchical ordering, then it is not possible to render to a pivot table. Instead, render will fall back to a regular table.

There are also the renderPivotTable() and renderTable() methods, which allow you to explicitly render the result to a pivot table or regular table, respectively, without autodetection done by render().

use Rekalogika\Analytics\Contracts\SummaryManager;
use Rekalogika\Analytics\Frontend\Exception\AnalyticsFrontendException;
use Rekalogika\Analytics\Frontend\Html\TableRenderer;
use Symfony\Contracts\Translation\TranslatorInterface;

/** @var SummaryManager $summaryManager */
/** @var TableRenderer $tableRenderer */
/** @var TranslatorInterface $translator */

$result = $summaryManager
    ->createQuery()
    // ...
    ->getResult();

// renderPivotTable() returns a pivot table (or throws an exception if it cannot)
$table = $tableRenderer->renderPivotTable(
    result: $result,
    pivotedDimensions: ['@values']
);

// renderTable() returns a regular table
$table = $tableRenderer->renderTable(
    result: $result,
);

// render() autodetects whether to render a pivot table or a regular table
$table = $tableRenderer->render(
    result: $result,
    pivotedDimensions: ['@values']
);

The pivotedDimensions parameter is an array of dimension names that you want to pivot into columns. @values is a special dimension value that represents the measures of the query.

Exception Handling​

By default, any error message will be rendered in the resulting HTML. If you want to handle exceptions yourself, you can add the argument throwException: true to the render(), renderPivotTable(), or renderTable() methods.

The rendering methods may throw an AnalyticsFrontendException if the rendering fails. AnalyticsFrontendException is guaranteed to have a user-friendly, translatable error message that can be safely displayed to the user. Other exceptions are not guaranteed to have a user-friendly message, and should not be displayed to the user directly.

Changing the Theme​

By default, these methods will use a plain table output. To have a themed table, you can change the default theme in the configuration:

config/packages/rekalogika_analytics.yaml
rekalogika_analytics:
    table_theme: "@RekalogikaAnalyticsFrontend/bootstrap_5_renderer.html.twig"

Alternatively, the methods above also accept the theme parameter, which allows you to specify a different theme for the table:

use Rekalogika\Analytics\Frontend\Html\TableRenderer;

/** @var TableRenderer $tableRenderer */

$table = $tableRenderer->render(
    result: $result,
    theme: '@RekalogikaAnalyticsFrontend/bootstrap_5_renderer.html.twig'
);

Creating a Custom Theme​

You can create a custom theme by extending the RekalogikaAnalyticsFrontend/renderer.html.twig file. Read bootstrap_5_renderer.html.twig for an example of how to do this.