Your IP : 216.73.216.220
<?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\Backend\Backend\ToolbarItems;
use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Backend\Module\MenuModule;
use TYPO3\CMS\Backend\Module\ModuleProvider;
use TYPO3\CMS\Backend\Toolbar\RequestAwareToolbarItemInterface;
use TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface;
use TYPO3\CMS\Backend\View\BackendViewFactory;
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
/**
* Help toolbar item - The question mark icon in toolbar
*/
class HelpToolbarItem implements ToolbarItemInterface, RequestAwareToolbarItemInterface
{
protected ?MenuModule $helpModule = null;
private ServerRequestInterface $request;
public function __construct(
ModuleProvider $moduleProvider,
private readonly BackendViewFactory $backendViewFactory,
) {
$helpModule = $moduleProvider->getModuleForMenu('help', $this->getBackendUser());
if ($helpModule && $helpModule->hasSubModules()) {
$this->helpModule = $helpModule;
}
}
public function setRequest(ServerRequestInterface $request): void
{
$this->request = $request;
}
/**
* Users see this if a module is available
*/
public function checkAccess(): bool
{
return $this->helpModule !== null;
}
/**
* Render help icon
*/
public function getItem(): string
{
$view = $this->backendViewFactory->create($this->request);
return $view->render('ToolbarItems/HelpToolbarItem');
}
/**
* Render drop down
*/
public function getDropDown(): string
{
if ($this->helpModule === null) {
// checkAccess() is called before and prevents call to getDropDown() if there is no help.
throw new \RuntimeException('No HelpModuleMenu found.', 1641993564);
}
$view = $this->backendViewFactory->create($this->request);
$view->assign('modules', $this->helpModule->getSubModules());
return $view->render('ToolbarItems/HelpToolbarItemDropDown');
}
/**
* No additional attributes needed.
*/
public function getAdditionalAttributes(): array
{
return [];
}
/**
* This item has a drop-down
*/
public function hasDropDown(): bool
{
return true;
}
/**
* Position relative to others
*/
public function getIndex(): int
{
return 70;
}
protected function getBackendUser(): BackendUserAuthentication
{
return $GLOBALS['BE_USER'];
}
}