GridFieldAddExistingSearchButton
class GridFieldAddExistingSearchButton extends AbstractGridFieldComponent 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.
Traits
A class that can be instantiated or replaced via DI
Properties
| protected | $title | |||
| protected | $fragment | |||
| protected | $searchList |
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
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
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
__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.
array
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