Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
### Fixed
- Remove a grid filter from the state when its value is cleared instead of keeping the previous value

## [0.8.3] - 25 October 2026
### Fixed
Expand Down
3 changes: 2 additions & 1 deletion Grid/Action/FilterAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,12 @@ public function execute(GridRepository $gridRepository, array $value): void
}

$gridFilter = $gridFilters[$filterName];
$state = $this->stateManager->get($gridRepository->getNamespace());
if ($gridFilter->isEmpty($filterValue)) {
$state->removeFilter($filterName);
continue;
}

$state = $this->stateManager->get($gridRepository->getNamespace());
$state->setFilter(
$filterName,
$filterValue,
Expand Down
2 changes: 1 addition & 1 deletion Grid/Filter/Filter.php
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,6 @@ public function isEmpty(mixed $value): bool
return true;
}

return $value === null;
return $value === null || $value === '' || $value === [];
}
}
13 changes: 13 additions & 0 deletions Grid/State.php
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,19 @@ public function setFilter(string $name, mixed $value, ?string $conditionType = '
$this->saveBookmarkData(['filters' => ['applied' => [$name => $value]]]);
}

public function removeFilter(string $name): void
{
$filters = $this->getFilters();
if (!isset($filters[$name])) {
return;
}

unset($filters[$name]);

$this->setFilters($filters);
$this->saveBookmarkData(['filters' => ['applied' => [$name => null]]]);
}

/**
* @param mixed[] $filters
*
Expand Down
55 changes: 55 additions & 0 deletions Test/Unit/Grid/Action/FilterActionTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<?php declare(strict_types=1);

namespace Loki\AdminComponents\Test\Unit\Grid\Action;

use Loki\AdminComponents\Component\Grid\GridRepository;
use Loki\AdminComponents\Component\Grid\GridViewModel;
use Loki\AdminComponents\Grid\Action\FilterAction;
use Loki\AdminComponents\Grid\Filter\Filter;
use Loki\AdminComponents\Grid\State;
use Loki\AdminComponents\Grid\StateManager;
use Loki\Components\Component\Component;
use PHPUnit\Framework\TestCase;

class FilterActionTest extends TestCase
{
public function testClearedFilterIsRemovedFromState(): void
{
$state = $this->createMock(State::class);
$state->expects($this->once())->method('removeFilter')->with('status');
$state->expects($this->never())->method('setFilter');

$this->execute($state, ['status' => '']);
}

public function testFilledFilterIsStored(): void
{
$state = $this->createMock(State::class);
$state->expects($this->never())->method('removeFilter');
$state->expects($this->once())->method('setFilter')->with('status', '0', 'eq');

$this->execute($state, ['status' => '0']);
}

private function execute(State $state, array $filters): void
{
$filter = $this->createMock(Filter::class);
$filter->method('isEmpty')->willReturnCallback(fn(mixed $value): bool => $value === '');
$filter->method('getConditionType')->willReturn('eq');

$viewModel = $this->createMock(GridViewModel::class);
$viewModel->method('getGridFilters')->willReturn(['status' => $filter]);

$component = $this->createMock(Component::class);
$component->method('getViewModel')->willReturn($viewModel);

$repository = $this->createMock(GridRepository::class);
$repository->method('getComponent')->willReturn($component);
$repository->method('getNamespace')->willReturn('ns');

$stateManager = $this->createMock(StateManager::class);
$stateManager->method('get')->willReturn($state);

(new FilterAction($stateManager))->execute($repository, ['filters' => $filters]);
}
}
57 changes: 57 additions & 0 deletions Test/Unit/Grid/Filter/FilterTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<?php declare(strict_types=1);

namespace Loki\AdminComponents\Test\Unit\Grid\Filter;

use Loki\AdminComponents\Form\Field\FieldFactory;
use Loki\AdminComponents\Grid\Filter\Filter;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
use Magento\Framework\View\LayoutInterface;

class FilterTest extends TestCase
{
#[DataProvider('emptyValues')]
public function testIsEmptyForEmptyValues(string $conditionType, mixed $value): void
{
$this->assertTrue($this->getFilter($conditionType)->isEmpty($value));
}

public static function emptyValues(): array
{
return [
'null' => ['eq', null],
'empty string' => ['eq', ''],
'empty array' => ['in', []],
'empty from_to' => ['from_to', ['from' => '', 'to' => '']],
];
}

#[DataProvider('nonEmptyValues')]
public function testIsEmptyForRealValues(string $conditionType, mixed $value): void
{
$this->assertFalse($this->getFilter($conditionType)->isEmpty($value));
}

public static function nonEmptyValues(): array
{
return [
'string zero' => ['eq', '0'],
'int zero' => ['eq', 0],
'text' => ['like', 'foo'],
'selection' => ['in', ['1', '2']],
'selection with zero' => ['in', ['0']],
'from only' => ['from_to', ['from' => '5', 'to' => '']],
];
}

private function getFilter(string $conditionType): Filter
{
return new Filter(
$this->createMock(LayoutInterface::class),
$this->createMock(FieldFactory::class),
'Label',
'code',
$conditionType,
);
}
}
Loading