Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NEW: Allow search field customisation #9341

Merged
merged 1 commit into from
Aug 1, 2022
Merged

NEW: Allow search field customisation #9341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions src/Forms/GridField/GridFieldFilterHeader.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,12 @@ class GridFieldFilterHeader extends AbstractGridFieldComponent implements GridFi
*/
protected $updateSearchFormCallback = null;

/**
* The name of the default search field
* @var string|null
*/
protected ?string $searchField = null;

/**
* @inheritDoc
*/
Expand Down Expand Up @@ -125,6 +131,17 @@ public function getThrowExceptionOnBadDataType()
return $this->throwExceptionOnBadDataType;
}

public function getSearchField(): ?string
{
return $this->searchField;
}

public function setSearchField(string $field): self
{
$this->searchField = $field;
return $this;
}

/**
* Check that this dataList is of the right data type.
* Returns false if it's a bad data type, and if appropriate, throws an exception.
Expand Down Expand Up @@ -281,7 +298,7 @@ public function getSearchContext(GridField $gridField)
public function getSearchFieldSchema(GridField $gridField)
{
$schemaUrl = Controller::join_links($gridField->Link(), 'schema/SearchForm');

$inst = singleton($gridField->getModelClass());
$context = $this->getSearchContext($gridField);
$params = $gridField->getRequest()->postVar('filter') ?: [];
if (array_key_exists($gridField->getName(), $params ?? [])) {
Expand All @@ -292,10 +309,13 @@ public function getSearchFieldSchema(GridField $gridField)
}
$context->setSearchParams($params);

$searchField = $context->getSearchFields()->first();
$searchField = $searchField && property_exists($searchField, 'name') ? $searchField->name : null;
$searchField = $this->getSearchField() ?: $inst->config()->get('general_search_field');
if (!$searchField) {
$searchField = $context->getSearchFields()->first();
$searchField = $searchField && property_exists($searchField, 'name') ? $searchField->name : null;
}

$name = $gridField->Title ?: singleton($gridField->getModelClass())->i18n_plural_name();
$name = $gridField->Title ?: $inst->i18n_plural_name();

// Prefix "Search__" onto the filters for the React component
$filters = $context->getSearchParams();
Expand Down
17 changes: 17 additions & 0 deletions tests/php/Forms/GridField/GridFieldFilterHeaderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace SilverStripe\Forms\Tests\GridField;

use SilverStripe\Control\HTTPRequest;
use SilverStripe\Core\Config\Config;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\Form;
Expand Down Expand Up @@ -156,4 +157,20 @@ public function testGetSearchForm()
$this->assertEquals('no-change-track', $field->extraClasses['no-change-track']);
}
}

public function testCustomSearchField()
{
$searchSchema = json_decode($this->component->getSearchFieldSchema($this->gridField));
$this->assertEquals('Name', $searchSchema->name);

Config::modify()->set(Team::class, 'general_search_field', 'CustomSearch');
$searchSchema = json_decode($this->component->getSearchFieldSchema($this->gridField));
$this->assertEquals('CustomSearch', $searchSchema->name);

$this->component->setSearchField('ReallyCustomSearch');
$searchSchema = json_decode($this->component->getSearchFieldSchema($this->gridField));
$this->assertEquals('ReallyCustomSearch', $searchSchema->name);

$this->assertEquals('ReallyCustomSearch', $this->component->getSearchField());
}
}