LiveSearchToolbarItem

class \TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem

Implements
ToolbarItemInterface, RequestAwareToolbarItemInterface

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

Table of Contents

Interfaces

ToolbarItemInterface
Interface for classes which extend the backend by adding items to the top toolbar
RequestAwareToolbarItemInterface
Interface for toolbar items that need the ServerRequestInterface Request.

Methods

__construct()  : mixed
checkAccess()  : bool
Checks whether the user has access to this toolbar item.
getAdditionalAttributes()  : array
This item needs additional attributes.
getDropDown()  : string
No drop-down here.
getIndex()  : int
Position relative to others, live search should be very right.
getItem()  : string
Render search field.
hasDropDown()  : bool
This item has no drop-down.
setRequest()  : void
getBackendUser()  : BackendUserAuthentication

Methods

checkAccess()

Checks whether the user has access to this toolbar item.

public checkAccess() : bool

Live search depends on the records module and only available when that module is allowed.

Return values

bool —

TRUE if user has access, FALSE if not

getAdditionalAttributes()

This item needs additional attributes.

public getAdditionalAttributes() : array

Return values

array —

List item HTML attributes

getDropDown()

No drop-down here.

public getDropDown() : string

Return values

string —

Drop down HTML

getIndex()

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

public getIndex() : int

Return values

int —

0 .. 100

getItem()

Render search field.

public getItem() : string

Return values

string —

Toolbar item HTML

hasDropDown()

This item has no drop-down.

public hasDropDown() : bool

Return values

bool

setRequest()

public setRequest(ServerRequestInterface $request) : void

Parameters

$request : ServerRequestInterface
On this page