‪TYPO3CMS  ‪main
TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem:
TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface TYPO3\CMS\Backend\Toolbar\RequestAwareToolbarItemInterface

Public Member Functions

 __construct (private readonly ModuleProvider $moduleProvider, private readonly BackendViewFactory $backendViewFactory,)
 
 setRequest (ServerRequestInterface $request)
 
 checkAccess ()
 
 getItem ()
 
 getAdditionalAttributes ()
 
 hasDropDown ()
 
 getDropDown ()
 
 getIndex ()
 

Protected Member Functions

 getBackendUser ()
 

Private Attributes

ServerRequestInterface $request
 

Detailed Description

Adds backend live search to the toolbar by adding JavaScript and adding an input search field

Definition at line 30 of file LiveSearchToolbarItem.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::__construct ( private readonly ModuleProvider  $moduleProvider,
private readonly BackendViewFactory  $backendViewFactory 
)

Definition at line 34 of file LiveSearchToolbarItem.php.

Member Function Documentation

◆ checkAccess()

TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::checkAccess ( )

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.

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 48 of file LiveSearchToolbarItem.php.

References TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem\getBackendUser().

◆ getAdditionalAttributes()

TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::getAdditionalAttributes ( )

This item needs additional attributes.

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 65 of file LiveSearchToolbarItem.php.

◆ getBackendUser()

TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::getBackendUser ( )
protected

◆ getDropDown()

TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::getDropDown ( )

No drop-down here.

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 81 of file LiveSearchToolbarItem.php.

◆ getIndex()

TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::getIndex ( )

Position relative to others, live search should be very right.

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 89 of file LiveSearchToolbarItem.php.

◆ getItem()

TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::getItem ( )

Render search field.

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 56 of file LiveSearchToolbarItem.php.

◆ hasDropDown()

TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::hasDropDown ( )

This item has no drop-down.

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 73 of file LiveSearchToolbarItem.php.

◆ setRequest()

TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::setRequest ( ServerRequestInterface  $request)

Member Data Documentation

◆ $request

ServerRequestInterface TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::$request
private