tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-06-28 23:49:26 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #8420 from open-sausages/pulls/4/searching-for-api

Browse Source 
Add extension points for ModelAdmin search API
This commit is contained in:
Maxime Rainville 2018-10-03 16:57:05 +13:00 committed by GitHub
commit f4c217f8a1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 76 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

89
src/Forms/GridField/GridFieldFilterHeader.php
View File

@ -38,11 +38,33 @@ class GridFieldFilterHeader implements GridField_URLHandler, GridField_HTMLProvi
* Indicates that this component should revert to displaying it's legacy
* table header style rather than the react driven search box
*
* @deprecated 5.0
* @deprecated 4.3.0:5.0.0 Will be removed in 5.0
* @var bool
*/
public $useLegacyFilterHeader = false;
/**
* @var \SilverStripe\ORM\Search\SearchContext
*/
protected $searchContext = null;
/**
* @var Form
*/
protected $searchForm = null;
/**
* @var callable
* @deprecated 4.3.0:5.0.0 Will be removed in 5.0
*/
protected $updateSearchContextCallback = null;
/**
* @var callable
* @deprecated 4.3.0:5.0.0 Will be removed in 5.0
*/
protected $updateSearchFormCallback = null;
/**
* @inheritDoc
*/
@ -55,10 +77,17 @@ class GridFieldFilterHeader implements GridField_URLHandler, GridField_HTMLProvi
/**
* @param bool $useLegacy
* @param callable|null $updateSearchContext This will be removed in 5.0
* @param callable|null $updateSearchForm This will be removed in 5.0
*/
public function __construct($useLegacy = false)
{
public function __construct(
$useLegacy = false,
callable $updateSearchContext = null,
callable $updateSearchForm = null
) {
$this->useLegacyFilterHeader = $useLegacy;
$this->updateSearchContextCallback = $updateSearchContext;
$this->updateSearchFormCallback = $updateSearchForm;
}
/**
@ -208,9 +237,15 @@ class GridFieldFilterHeader implements GridField_URLHandler, GridField_HTMLProvi
*/
public function getSearchContext(GridField $gridField)
{
$context = singleton($gridField->getModelClass())->getDefaultSearchContext();
if (!$this->searchContext) {
$this->searchContext = singleton($gridField->getModelClass())->getDefaultSearchContext();
return $context;
if ($this->updateSearchContextCallback) {
call_user_func($this->updateSearchContextCallback, $this->searchContext);
}
}
return $this->searchContext;
}
/**
@ -228,6 +263,9 @@ class GridFieldFilterHeader implements GridField_URLHandler, GridField_HTMLProvi
if (array_key_exists($gridField->getName(), $params)) {
$params = $params[$gridField->getName()];
}
if ($context->getSearchParams()) {
$params = array_merge($context->getSearchParams(), $params);
}
$context->setSearchParams($params);
$searchField = $context->getSearchFields()->first();
@ -257,19 +295,22 @@ class GridFieldFilterHeader implements GridField_URLHandler, GridField_HTMLProvi
}
/**
* Returns the search form schema for the component
* Returns the search form for the component
*
* @param GridField $gridfield
* @return HTTPResponse
* @param GridField $gridField
* @return Form|null
*/
public function getSearchFormSchema(GridField $gridField)
public function getSearchForm(GridField $gridField)
{
$searchContext = $this->getSearchContext($gridField);
$searchFields = $searchContext->getSearchFields();
// If there are no filterable fields, return a 400 response
if ($searchFields->count() === 0) {
return new HTTPResponse(_t(__CLASS__ . '.SearchFormFaliure', 'No search form could be generated'), 400);
return null;
}
if ($this->searchForm) {
return $this->searchForm;
}
// Append a prefix to search field names to prevent conflicts with other fields in the search form
@ -296,7 +337,7 @@ class GridFieldFilterHeader implements GridField_URLHandler, GridField_HTMLProvi
$field->addExtraClass('stacked');
}
$form = new Form(
$this->searchForm = $form = new Form(
$gridField,
"SearchForm",
$searchFields,
@ -307,7 +348,29 @@ class GridFieldFilterHeader implements GridField_URLHandler, GridField_HTMLProvi
$form->setFormAction($gridField->Link());
$form->addExtraClass('cms-search-form form--no-dividers');
$form->disableSecurityToken(); // This form is not tied to session so we disable this
$form->loadDataFrom($gridField->getRequest()->getVars());
$form->loadDataFrom($searchContext->getSearchParams());
if ($this->updateSearchFormCallback) {
call_user_func($this->updateSearchFormCallback, $form);
}
return $this->searchForm;
}
/**
* Returns the search form schema for the component
*
* @param GridField $gridfield
* @return HTTPResponse
*/
public function getSearchFormSchema(GridField $gridField)
{
$form = $this->getSearchForm($gridField);
// If there are no filterable fields, return a 400 response
if (!$form) {
return new HTTPResponse(_t(__CLASS__ . '.SearchFormFaliure', 'No search form could be generated'), 400);
}
$parts = $gridField->getRequest()->getHeader(LeftAndMain::SCHEMA_HEADER);
$schemaID = $gridField->getRequest()->getURL();