Skip to content

Allow positioning of additional grid view filters #6552

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

Merged
BurntimeX merged 1 commit into from
Jan 2, 2026
Merged

Allow positioning of additional grid view filters #6552

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
83 changes: 72 additions & 11 deletions wcfsetup/install/files/lib/system/gridView/AbstractGridView.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,15 @@ abstract class AbstractGridView
*/
private array $availableFilters = [];

/**
* @var array<string, array{
* filter: IViewFilter,
* target: ?string,
* insertBefore: bool,
* }>
*/
private array $extraFilters = [];

/**
* Adds a new column to the grid view.
*/
Expand Down Expand Up @@ -683,22 +692,52 @@ protected function fireInitializedEvent(): void
EventHandler::getInstance()->fire($event);
}

/**
* Validates the configuration of this grid view.
*/
protected function validate(): void
private function buildAvailableFilters(): void
{
$columnFilters = [];
$filters = [];
foreach ($this->getColumns() as $column) {
if ($column->getFilter() !== null) {
$columnFilters[$column->getID()] = $column->getFilter();
$filters[] = $column->getFilter();
}
}

$this->availableFilters = [
...$columnFilters,
...$this->availableFilters,
];
foreach ($this->extraFilters as $filterData) {
$filter = $filterData['filter'];

if ($filterData['target'] === null) {
if ($filterData['insertBefore']) {
\array_unshift($filters, $filter);
} else {
$filters[] = $filter;
}
} else {
$index = \array_find_key(
$filters,
static fn($filterObj) => $filterObj->getId() === $filterData['target']
);
if ($index === null) {
throw new \RuntimeException("Cannot find the target '{$filterData['target']}' for filter '{$filter->getId()}'.");
}

if (!$filterData['insertBefore']) {
$index++;
}

\array_splice($filters, $index, 0, [$filter]);
}
}

foreach ($filters as $filter) {
$this->availableFilters[$filter->getId()] = $filter;
}
}

/**
* Validates the configuration of this grid view.
*/
protected function validate(): void
{
$this->buildAvailableFilters();

if ($this->getDefaultSortField() === '') {
throw new \InvalidArgumentException("Undefined default sort field.");
Expand Down Expand Up @@ -863,7 +902,29 @@ protected function applyFilters(): void

public function addAvailableFilter(IViewFilter $filter): void
{
$this->availableFilters[$filter->getId()] = $filter;
$this->extraFilters[$filter->getId()] = [
'filter' => $filter,
'target' => null,
'insertBefore' => false,
];
}

public function addAvailableFilterBefore(IViewFilter $filter, ?string $targetFilterID = null): void
{
$this->extraFilters[$filter->getId()] = [
'filter' => $filter,
'target' => $targetFilterID,
'insertBefore' => true,
];
}

public function addAvailableFilterAfter(IViewFilter $filter, ?string $targetFilterID = null): void
{
$this->extraFilters[$filter->getId()] = [
'filter' => $filter,
'target' => $targetFilterID,
'insertBefore' => false,
];
}

/**
Expand Down
Loading