GridFieldAddExistingSearchButton
class GridFieldAddExistingSearchButton implements GridField_HTMLProvider, GridField_URLHandler (View source)
A modal search dialog which uses search context to search for and add existing records to a grid field.
Properties
| protected | $title | |||
| protected | $fragment | |||
| protected | $searchList |
Methods
Returns a map where the keys are fragment names and the values are pieces of HTML to add to these fragments.
Return URLs to be handled by this grid field, in an array the same form as $url_handlers.
Details
__construct(string $fragment = 'buttons-before-left')
No description
string
getTitle()
No description
GridFieldAddExistingSearchButton
setTitle(string $title)
No description
string
getFragment()
No description
GridFieldAddExistingSearchButton
setFragment(string $fragment)
No description
GridFieldAddExistingSearchButton
setSearchList(SS_List $list)
Sets a custom list to use to provide the searchable items.
SS_List|null
getSearchList()
No description
array
getHTMLFragments($grid)
Returns a map where the keys are fragment names and the values are pieces of HTML to add to these fragments.
Here are 4 built-in fragments: 'header', 'footer', 'before', and 'after', but components may also specify fragments of their own.
To specify a new fragment, specify a new fragment by including the text "$DefineFragment(fragmentname)" in the HTML that you return.
Fragment names should only contain alphanumerics, -, and _.
If you attempt to return HTML for a fragment that doesn't exist, an exception will be thrown when the GridField is rendered.
getURLHandlers($grid)
Return URLs to be handled by this grid field, in an array the same form as $url_handlers.
Handler methods will be called on the component, rather than the GridField.
handleSearch($grid, $request)
No description