BarChartWidget.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Dashboard\Widgets;
 
use Psr\Http\Message\ServerRequestInterface;
use ‪TYPO3\CMS\Backend\View\BackendViewFactory;
use ‪TYPO3\CMS\Core\Page\JavaScriptModuleInstruction;
 
class ‪BarChartWidget implements ‪WidgetInterface, ‪RequestAwareWidgetInterface, ‪EventDataInterface, ‪AdditionalCssInterface, ‪JavaScriptInterface
{
    private ServerRequestInterface ‪$request;
 
    public function ‪__construct(
        private readonly ‪WidgetConfigurationInterface $configuration,
        private readonly ‪ChartDataProviderInterface $dataProvider,
        private readonly ‪BackendViewFactory $backendViewFactory,
        private readonly ?‪ButtonProviderInterface $buttonProvider = null,
        private readonly array $options = [],
    ) {}
 
    public function ‪setRequest(ServerRequestInterface ‪$request): void
    {
        $this->request = ‪$request;
    }
 
    public function ‪renderWidgetContent(): string
    {
        $view = $this->backendViewFactory->create($this->request);
        $view->assignMultiple([
            'button' => $this->buttonProvider,
            'options' => $this->options,
            'configuration' => $this->configuration,
        ]);
        return $view->render('Widget/ChartWidget');
    }
 
    public function ‪getEventData(): array
    {
        return [
            'graphConfig' => [
                'type' => 'bar',
                'options' => [
                    'maintainAspectRatio' => false,
                    'plugins' => [
                        'legend' => [
                            'display' => false,
                        ],
                    ],
                    'scales' => [
                        'y' => [
                            'ticks' => [
                                'beginAtZero' => true,
                            ],
                        ],
                        'x' => [
                            'ticks' => [
                                'maxTicksLimit' => 15,
                            ],
                        ],
                    ],
                ],
                'data' => $this->dataProvider->getChartData(),
            ],
        ];
    }
 
    public function ‪getCssFiles(): array
    {
        return [];
    }
 
    public function ‪getJavaScriptModuleInstructions(): array
    {
        return [
            ‪JavaScriptModuleInstruction::create('@typo3/dashboard/contrib/chartjs.js'),
            ‪JavaScriptModuleInstruction::create('@typo3/dashboard/chart-initializer.js'),
        ];
    }
 
    public function ‪getOptions(): array
    {
        return $this->options;
    }
}