Dashboard.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;
 
use Psr\Container\ContainerInterface;
use Psr\Http\Message\ServerRequestInterface;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface;
 
class ‪Dashboard
{
    protected ‪$widgets = [];
 
    protected ‪$widgetOptions = [];
 
    public function ‪__construct(
        protected readonly string ‪$identifier,
        protected readonly string $title,
        protected readonly array $widgetConfig,
        protected readonly ‪WidgetRegistry $widgetRegistry,
        protected readonly ContainerInterface $container
    ) {}
 
    public function ‪getIdentifier(): string
    {
        return ‪$this->identifier;
    }
 
    public function ‪getTitle(): string
    {
        return $this->‪getLanguageService()->sL($this->title) ?: $this->title;
    }
 
    public function ‪getWidgetConfig(): array
    {
        return $this->widgetConfig;
    }
 
    public function ‪getWidgets(): array
    {
        return ‪$this->widgets;
    }
 
    public function ‪initializeWidgets(ServerRequestInterface $request): void
    {
        $availableWidgets = $this->widgetRegistry->getAvailableWidgets();
        foreach ($this->widgetConfig as $hash => $widgetConfig) {
            $widgetConfigIdentifier = $widgetConfig['identifier'] ?? '';
            if ($widgetConfigIdentifier !== '' && array_key_exists($widgetConfigIdentifier, $availableWidgets)) {
                $this->widgets[$hash] = $availableWidgets[$widgetConfigIdentifier];
 
                $widgetObject = $this->widgetRegistry->getAvailableWidget($request, $widgetConfigIdentifier);
                $this->widgetOptions[$hash] = $widgetObject->getOptions();
            }
        }
    }
 
    protected function ‪getLanguageService(): ‪LanguageService
    {
        return ‪$GLOBALS['LANG'];
    }
 
    public function ‪getWidgetOptions(): array
    {
        return ‪$this->widgetOptions;
    }
}