Filtering in Silverstripe GridFieldAddExistingAutocompleter - silverstripe

Question

Is it possible to add a filter to GridFieldAddExistingAutocompleter similar setFilterFunction on TreeDropdownField?
TreeDropdownField::create(
"LinkID",
"Link to",
"SiteTree"
)->setFilterFunction(create_function( '$obj', 'return $obj->isPublished();' ));
This would give a list of SiteTree objects that return true when isPublished is called.
Is there a way to filter the GridField autocompleter in a similar way?
In the following code $this->Pages() is a has_many relationship for Page. The result will just list all of the Page objects in the autocomplete dropdown.
GridField::create(
'Pages',
'Pages belonging to group',
$this->Pages(),
$config = GridFieldConfig::create()->addComponents(
new GridFieldButtonRow('toolbar-header-right'),
new GridFieldToolbarHeader(),
new GridFieldSortableHeader(),
new GridFieldFilterHeader(),
new GridFieldDataColumns(),
new GridFieldDeleteAction(true),
new GridFieldDetailForm(),
new GridFieldAddExistingAutocompleter('toolbar-header-right')
)
)
Is there a way it can be filtered?
Note: I want to filter by some other checks not just isPublished, I'm checking if the page's parent ID is the same as another relationship's ID

Answer 1

there is a method called setSearchList() on GridFieldAddExistingAutocompleter with which you can set the list to be searched.
however, I am not sure if that is fully implemented, but you should try the following:
// lets assume you want all Pages that have no parent (root pages)
$listToBeSearched = Page::get()->filter('ParentID', 0);
$autoCompleteField = new GridFieldAddExistingAutocompleter('toolbar-header-right');
$autoCompleteField->setSearchList($listToBeSearched);
$config = GridFieldConfig::create()->addComponents(
new GridFieldButtonRow('toolbar-header-right'),
new GridFieldToolbarHeader(),
new GridFieldSortableHeader(),
new GridFieldFilterHeader(),
new GridFieldDataColumns(),
new GridFieldDeleteAction(true),
new GridFieldDetailForm(),
$autoCompleteField
);
if you wish to filter by a function like in your question, then use filterByCallback() to filter the list:
// because GridFieldAddExistingAutocompleter only supports DataList at the moment
// and filterByCallback() returns an ArrayList, we have to use a workaround
// (which obviously yields a performance loss)
$arrayList = Page::get()->filterByCallback(function($obj) { return $obj->isPublished(); });
// now that we have a list of pages that we want to search,
// lets take the IDs of this list and create a DataList that filters for this IDs:
$listToBeSearched = Page::get()->filter('ID', $arrayList->column('ID'));