| Current Path : /var/www/surf/TYPO3/vendor/typo3/cms-backend/Classes/Backend/ToolbarItems/ |
| Current File : /var/www/surf/TYPO3/vendor/typo3/cms-backend/Classes/Backend/ToolbarItems/LiveSearchToolbarItem.php |
<?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\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;
/**
* Adds backend live search to the toolbar by adding JavaScript and adding an input search field
*/
class LiveSearchToolbarItem implements ToolbarItemInterface, RequestAwareToolbarItemInterface
{
private ServerRequestInterface $request;
public function __construct(
private readonly ModuleProvider $moduleProvider,
private readonly BackendViewFactory $backendViewFactory,
) {}
public function setRequest(ServerRequestInterface $request): void
{
$this->request = $request;
}
/**
* Checks whether the user has access to this toolbar item.
* Live search depends on the list module and only available when that module is allowed.
*/
public function checkAccess(): bool
{
return $this->moduleProvider->accessGranted('web_list', $this->getBackendUser());
}
/**
* Render search field.
*/
public function getItem(): string
{
$view = $this->backendViewFactory->create($this->request);
return $view->render('ToolbarItems/LiveSearchToolbarItem');
}
/**
* This item needs additional attributes.
*/
public function getAdditionalAttributes(): array
{
return ['class' => 't3js-toolbar-item-search'];
}
/**
* This item has no drop-down.
*/
public function hasDropDown(): bool
{
return false;
}
/**
* No drop-down here.
*/
public function getDropDown(): string
{
return '';
}
/**
* Position relative to others, live search should be very right.
*/
public function getIndex(): int
{
return 80;
}
protected function getBackendUser(): BackendUserAuthentication
{
return $GLOBALS['BE_USER'];
}
}