LiveSearchToolbarItem implements ToolbarItemInterface

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

Methods

__construct()  : mixed
Loads the needed JavaScript file, ands includes it to the page renderer
checkAccess()  : bool
Checks whether the user has access to this toolbar item, only allowed when the list module is available.
getAdditionalAttributes()  : array<string|int, mixed>
This item needs to 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
getFluidTemplateObject()  : StandaloneView
Returns a new standalone view, shorthand function
getPageRenderer()  : PageRenderer
Returns current PageRenderer

Methods

__construct()

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

public __construct() : mixed

checkAccess()

Checks whether the user has access to this toolbar item, only allowed when the list module is available.

public checkAccess() : bool

Live search is heavily dependent on the list module and only available when that module is.

Return values
bool —

TRUE if user has access, FALSE if not

getAdditionalAttributes()

This item needs to additional attributes

public getAdditionalAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDropDown()

No drop down here

public getDropDown() : string
Return values
string

getIndex()

Position relative to others, live search should be very right

public getIndex() : int
Return values
int

getItem()

Render search field

public getItem() : string
Return values
string —

Live search form HTML

hasDropDown()

This item has no drop down

public hasDropDown() : bool
Return values
bool

getFluidTemplateObject()

Returns a new standalone view, shorthand function

protected getFluidTemplateObject(string $filename) : StandaloneView
Parameters
$filename : string

Which templateFile should be used.

Return values
StandaloneView 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results