TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem:

Public Member Functions
	__construct ()
bool	checkAccess ()
string	getItem ()
array	getAdditionalAttributes ()
bool	hasDropDown ()
string	getDropDown ()
int	getIndex ()

Protected Member Functions
PageRenderer	getPageRenderer ()
StandaloneView	getFluidTemplateObject (string $filename)

Detailed Description

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

Definition at line 27 of file LiveSearchToolbarItem.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::__construct

(

)

Loads the needed JavaScript file, ands includes it to the page renderer

Definition at line 32 of file LiveSearchToolbarItem.php.

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

Member Function Documentation

checkAccess()

bool TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::checkAccess

(

)

Checks whether the user has access to this toolbar item, only allowed when the list module is available. Live search is heavily dependent on the list module and only available when that module is.

Returns

‪bool TRUE if user has access, FALSE if not

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 44 of file LiveSearchToolbarItem.php.

getAdditionalAttributes()

array TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::getAdditionalAttributes

(

)

This item needs to additional attributes

Returns

‪array

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 66 of file LiveSearchToolbarItem.php.

getDropDown()

string TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::getDropDown

(

)

No drop down here

Returns

‪string

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 86 of file LiveSearchToolbarItem.php.

getFluidTemplateObject()

StandaloneView TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::getFluidTemplateObject ( string  $filename )

protected

Returns a new standalone view, shorthand function

Parameters

string

$filename

‪Which templateFile should be used.

Returns

‪StandaloneView

Definition at line 117 of file LiveSearchToolbarItem.php.

Referenced by TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem\getItem().

getIndex()

int TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::getIndex

(

)

Position relative to others, live search should be very right

Returns

‪int

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 96 of file LiveSearchToolbarItem.php.

getItem()

string TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::getItem

(

)

Render search field

Returns

‪string Live search form HTML

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 56 of file LiveSearchToolbarItem.php.

References TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem\getFluidTemplateObject(), and TYPO3\CMS\Extbase\Mvc\View\ViewInterface\render().

getPageRenderer()

PageRenderer TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::getPageRenderer ( )

protected

Returns current PageRenderer

Returns

‪PageRenderer

Definition at line 106 of file LiveSearchToolbarItem.php.

Referenced by TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem\__construct().

hasDropDown()

bool TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem::hasDropDown

(

)

This item has no drop down

Returns

‪bool

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 76 of file LiveSearchToolbarItem.php.