---
title: "MySQL Report API"
manual: "MySQL Report"
version: "main"
source: "Developer/API/Index.rst"
rendered: "2026-10-10T23:42:57+00:00"
---

# MySQL Report API {#api}

Since `mysqlreport` 2.0.0 there is an API to add your
own panels/infoboxes to the backend module.

The infoboxes are rendered using the `f:be.infobox` ViewHelper of TYPO3.

## Infobox Registry {#api-infobox-registry}

If you want to extend pages of `mysqlreport` with further infoboxes, you must
add configuration to the `Services.yaml` of your extension.

Example content of `Services.yaml`:

```yaml
services:
  ...
  YourVendor\YourExtKey\InfoBox\Information\ConnectionInfoBox:
    tags:
      - name: 'mysqlreport.infobox.[pageIdentifier]'
        priority: 60
```

Each infobox in the backend module is represented by its own PHP class.
Please attach the tag name for the page you want to modify to each of your
infobox classes. With `priority` you can change the loading order of the
infoboxes on a specific page.

Currently, the following tags are available:

-   mysqlreport.infobox.status
-   mysqlreport.infobox.innodb
-   mysqlreport.infobox.misc
-   mysqlreport.infobox.query_cache
-   mysqlreport.infobox.table_cache
-   mysqlreport.infobox.thread_cache

## Your own Infobox {#api-your-own-infobox}

Create a new PHP class implementing the `InfoBoxInterface` or extending the
`AbstractInfoBox` class of `mysqlreport`:

```php
<?php

declare(strict_types=1);

namespace StefanFroemken\Mysqlreport\InfoBox\Overview;

use StefanFroemken\Mysqlreport\InfoBox\AbstractInfoBox;
use StefanFroemken\Mysqlreport\Menu\Page;

class AbortedConnectsInfoBox extends AbstractInfoBox
{
    protected $pageIdentifier = 'overview';

    protected $title = 'Aborted Connects';

    public function renderBody(Page $page): string
    {
        if (!isset($page->getStatusValues()['Aborted_connects'])) {
            $this->shouldBeRendered = false;
            return '';
        }

        $content = [];
        $content[] = 'You have %d aborted connects.';

        return sprintf(
            implode(' ', $content),
            $page->getStatusValues()['Aborted_connects']
        );
    }
}
```

Set the `pageIdentifier` to show your infobox on the right view
in the backend module.

Set a `title`. It will be used as the title in the infobox.

The content of the infobox is rendered in the `renderBody` method. Via
the `$page` argument you have access to all status and variable values of
your MySQL/MariaDB server.

> [!TIP]
> **Hint**
>
> Do not add HTML tags into your content within `renderBody` method. The
> content will be passed through `htmlspecialchars`. Please submit a Pull
> Request to extend the API or use your own template (see below).

## Highlight Infobox {#api-highlight-infobox}

The `AbstractInfoBox` class comes with a `setState` method which allows values
from `TYPO3CMSCoreTypeContextualFeedbackSeverity`.

-   -2 or ContextualFeedbackSeverity::NOTICE
-   -1 or ContextualFeedbackSeverity::INFO
-   0 or ContextualFeedbackSeverity::OK
-   1 or ContextualFeedbackSeverity::WARNING
-   2 or ContextualFeedbackSeverity::ERROR

## Unordered List {#api-unordered-list}

Sometimes it is useful to show some values of your server as a list.
The list will be shown at the bottom of the infobox.

```php
// Results in <ul><li>Value is OK</li></ul>
$this->addUnorderedListEntry('Value is OK');

// Results in <ul><li><strong>Aborted connects:</strong> 25</li></ul>
$this->addUnorderedListEntry(
    $page->getStatusValues()['Aborted_connects'],
    'Aborted connects'
);
```

## Disable Infobox {#api-disable-infobox}

If a server variable is not available for a server, it may help to hide the
infobox in the backend module.

Use `$this->shouldBeRendered = false;` in `renderBody` of your class.

## Use own Template {#api-use-own-template}

By default `mysqlreport` uses the template from:

[`EXT:mysqlreport/Resources/Private/Templates/InfoBox/Default.html`](https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ExtensionArchitecture/FileStructure/Resources/Private/Index.html#file-extension-resources-private-templates-controllername-actionname-fluid-html)

Use `template` property to define your own template for rendering of your
infobox:

```php
protected $template = 'EXT:[your_ext_key]/Resources/Private/Templates/InfoBox/MyBetterTemplate.html';
```