mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
Compare commits
3 Commits
e984d45f37
...
a1db11575e
Author | SHA1 | Date | |
---|---|---|---|
|
a1db11575e | ||
|
ebbd6427b2 | ||
|
9581025e6c |
@ -49,6 +49,8 @@ class GridFieldFilterHeader extends AbstractGridFieldComponent implements GridFi
|
|||||||
*/
|
*/
|
||||||
protected ?string $searchField = null;
|
protected ?string $searchField = null;
|
||||||
|
|
||||||
|
private string $placeHolderText = '';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* @inheritDoc
|
||||||
*/
|
*/
|
||||||
@ -245,6 +247,24 @@ class GridFieldFilterHeader extends AbstractGridFieldComponent implements GridFi
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the text to be used as a placeholder in the search field.
|
||||||
|
* If blank, the placeholder will be generated based on the class held in the GridField.
|
||||||
|
*/
|
||||||
|
public function getPlaceHolderText(): string
|
||||||
|
{
|
||||||
|
return $this->placeHolderText;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the text to be used as a placeholder in the search field.
|
||||||
|
* If blank, this text will be generated based on the class held in the GridField.
|
||||||
|
*/
|
||||||
|
public function setPlaceHolderText(string $placeHolderText): static
|
||||||
|
{
|
||||||
|
$this->placeHolderText = $placeHolderText;
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Generate a search context based on the model class of the of the GridField
|
* Generate a search context based on the model class of the of the GridField
|
||||||
@ -318,7 +338,7 @@ class GridFieldFilterHeader extends AbstractGridFieldComponent implements GridFi
|
|||||||
$schema = [
|
$schema = [
|
||||||
'formSchemaUrl' => $schemaUrl,
|
'formSchemaUrl' => $schemaUrl,
|
||||||
'name' => $searchField,
|
'name' => $searchField,
|
||||||
'placeholder' => _t(__CLASS__ . '.Search', 'Search "{name}"', ['name' => $this->getTitle($gridField, $inst)]),
|
'placeholder' => $this->getPlaceHolder($inst),
|
||||||
'filters' => $filters ?: new \stdClass, // stdClass maps to empty json object '{}'
|
'filters' => $filters ?: new \stdClass, // stdClass maps to empty json object '{}'
|
||||||
'gridfield' => $gridField->getName(),
|
'gridfield' => $gridField->getName(),
|
||||||
'searchAction' => $searchAction->getAttribute('name'),
|
'searchAction' => $searchAction->getAttribute('name'),
|
||||||
@ -330,19 +350,6 @@ class GridFieldFilterHeader extends AbstractGridFieldComponent implements GridFi
|
|||||||
return json_encode($schema);
|
return json_encode($schema);
|
||||||
}
|
}
|
||||||
|
|
||||||
private function getTitle(GridField $gridField, object $inst): string
|
|
||||||
{
|
|
||||||
if ($gridField->Title) {
|
|
||||||
return $gridField->Title;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (ClassInfo::hasMethod($inst, 'i18n_plural_name')) {
|
|
||||||
return $inst->i18n_plural_name();
|
|
||||||
}
|
|
||||||
|
|
||||||
return ClassInfo::shortName($inst);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the search form for the component
|
* Returns the search form for the component
|
||||||
*
|
*
|
||||||
@ -386,7 +393,7 @@ class GridFieldFilterHeader extends AbstractGridFieldComponent implements GridFi
|
|||||||
$field->addExtraClass('stacked no-change-track');
|
$field->addExtraClass('stacked no-change-track');
|
||||||
}
|
}
|
||||||
|
|
||||||
$name = $this->getTitle($gridField, singleton($gridField->getModelClass()));
|
$name = $this->getTitle(singleton($gridField->getModelClass()));
|
||||||
|
|
||||||
$this->searchForm = $form = new Form(
|
$this->searchForm = $form = new Form(
|
||||||
$gridField,
|
$gridField,
|
||||||
@ -456,4 +463,32 @@ class GridFieldFilterHeader extends AbstractGridFieldComponent implements GridFi
|
|||||||
)
|
)
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the text that will be used as a placeholder in the search field.
|
||||||
|
*
|
||||||
|
* @param object $obj An instance of the class that will be searched against.
|
||||||
|
* If getPlaceHolderText is empty, this object will be used to build the placeholder
|
||||||
|
* e.g. 'Search "My Data Object"'
|
||||||
|
*/
|
||||||
|
private function getPlaceHolder(object $obj): string
|
||||||
|
{
|
||||||
|
$placeholder = $this->getPlaceHolderText();
|
||||||
|
if (!empty($placeholder)) {
|
||||||
|
return $placeholder;
|
||||||
|
}
|
||||||
|
if ($obj) {
|
||||||
|
return _t(__CLASS__ . '.Search', 'Search "{name}"', ['name' => $this->getTitle($obj)]);
|
||||||
|
}
|
||||||
|
return _t(__CLASS__ . '.Search_Default', 'Search');
|
||||||
|
}
|
||||||
|
|
||||||
|
private function getTitle(object $inst): string
|
||||||
|
{
|
||||||
|
if (ClassInfo::hasMethod($inst, 'i18n_plural_name')) {
|
||||||
|
return $inst->i18n_plural_name();
|
||||||
|
}
|
||||||
|
|
||||||
|
return ClassInfo::shortName($inst);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -678,9 +678,13 @@ class ViewableData implements IteratorAggregate
|
|||||||
* access to itself.
|
* access to itself.
|
||||||
*
|
*
|
||||||
* @return ViewableData
|
* @return ViewableData
|
||||||
|
* @deprecated 5.3.0 Will be replaced with special handling in templates.
|
||||||
*/
|
*/
|
||||||
public function Me()
|
public function Me()
|
||||||
{
|
{
|
||||||
|
Deprecation::withNoReplacement(
|
||||||
|
fn () => Deprecation::notice('5.3.0', 'Will be replaced with special handling in templates.')
|
||||||
|
);
|
||||||
return $this;
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -3,6 +3,7 @@
|
|||||||
namespace SilverStripe\Forms\Tests\GridField;
|
namespace SilverStripe\Forms\Tests\GridField;
|
||||||
|
|
||||||
use LogicException;
|
use LogicException;
|
||||||
|
use ReflectionMethod;
|
||||||
use SilverStripe\Control\HTTPRequest;
|
use SilverStripe\Control\HTTPRequest;
|
||||||
use SilverStripe\Core\Config\Config;
|
use SilverStripe\Core\Config\Config;
|
||||||
use SilverStripe\Dev\SapphireTest;
|
use SilverStripe\Dev\SapphireTest;
|
||||||
@ -118,6 +119,29 @@ class GridFieldFilterHeaderTest extends SapphireTest
|
|||||||
$this->assertEquals('testfield', $searchSchema->gridfield);
|
$this->assertEquals('testfield', $searchSchema->gridfield);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Tests the private method that returns the placeholder for the search field
|
||||||
|
*/
|
||||||
|
public function testGetPlaceHolder()
|
||||||
|
{
|
||||||
|
$gridField = new GridField('test');
|
||||||
|
$filterHeader = new GridFieldFilterHeader();
|
||||||
|
$reflectionGetPlaceHolder = new ReflectionMethod($filterHeader, 'getPlaceHolder');
|
||||||
|
$reflectionGetPlaceHolder->setAccessible(true);
|
||||||
|
|
||||||
|
// No explicit placeholder or model i18n_plural_name method
|
||||||
|
$this->assertSame('Search "ArrayData"', $reflectionGetPlaceHolder->invoke($filterHeader, new ArrayData()));
|
||||||
|
|
||||||
|
// No explicit placeholder, but model has i18n_plural_name method
|
||||||
|
$model = new DataObject();
|
||||||
|
$this->assertSame('Search "' . $model->i18n_plural_name() . '"', $reflectionGetPlaceHolder->invoke($filterHeader, $model));
|
||||||
|
|
||||||
|
// Explicit placeholder is set, which overrides both of the above cases
|
||||||
|
$filterHeader->setPlaceHolderText('This is the text');
|
||||||
|
$this->assertSame('This is the text', $reflectionGetPlaceHolder->invoke($filterHeader, $model));
|
||||||
|
$this->assertSame('This is the text', $reflectionGetPlaceHolder->invoke($filterHeader, new ArrayData()));
|
||||||
|
}
|
||||||
|
|
||||||
public function testHandleActionReset()
|
public function testHandleActionReset()
|
||||||
{
|
{
|
||||||
// Init Grid state with some pre-existing filters
|
// Init Grid state with some pre-existing filters
|
||||||
|
Loading…
Reference in New Issue
Block a user