Feature/column chooser by BastianLedererIcinga · Pull Request #1333 · Icinga/icingadb-web

BastianLedererIcinga · 2026-02-13T15:15:16Z

Add a new form to choose the displayed columns in hosts and services view.

resolves: #82
fixes #850

requires: Icinga/ipl-web#277 for the TabularViewModeSwitcher icon
requires: Icinga/ipl-web#357 to display error messages for invalid columns

Add a new form that supports adding and removing dispalyed columns in tabular viewmode.

Add TabularViewModeSwitcher as a subclass of ViewModeSwitcher and remove tabular view as option of the ViewModeSwitcher.

Adjust HostsController and ServicesController to use the new ColumnChooser form and the TabularViewModeSwitcher. The Controller class is adjusted to work with the TabularViewModeSwitcher The HostGroupsController and ServiceGroupsController are adjusted, to ensure they use with the GridViewModeSwitcher.

Add a button to the StateItemTable to open the ColumnChooser form.

Exclude regular columns by using fixed columns and expand Objectsuggestions to exclude a given set of customvars.

nilmerg · 2026-03-03T08:54:00Z

library/Icingadb/Web/Controller.php

-        } else {
-            $viewModeSwitcher = new ViewModeSwitcher();
-        }
+        $viewModeSwitcher = $this->getViewModeSwitcherInstance();


Not liking the idea of having a controller to override a method to customize the switcher. Introduce a parameter instead. The advantage is, it's immediately visible at the call site which switcher is used, without having to trace up the class hierarchy. It also means one controller could use different switchers for different actions if ever needed.

If you worry about type-safety, you can still facilitate static analysis using phpstan by using the type class-string<ViewModeSwitcher> in the phpdoc string.

nilmerg · 2026-03-03T09:04:07Z

library/Icingadb/Web/Controller.php

        if (! $columnsDef) {
            if ($viewMode === 'tabular') {
-                $this->httpBadRequest('Missing parameter "columns"');
+                $columnsDef = $this->getDefaultColumns();


The same as for getViewModeSwitcherInstance applies here. Use a parameter instead.

Also, name, state.output is only a viable default in two cases, cases which override it at the moment anyway. So I think this can be mandatory parameter. (With no default)

nilmerg · 2026-03-03T09:53:51Z

library/Icingadb/Widget/ItemTable/StateItemTable.php

+                Url::fromPath("icingadb/{$this->getControllerPath()}/columnControl")->setParam(
+                    'columns',
+                    implode(',', array_keys($this->columns))
+                )


getControllerPath introduces an unnecessary hard-coded dependency of e.g. HostItemTable <-> HostsController. An easy change avoids this: Add a new setter setColumnChooserUrl(Url $url): static

If the setter is not called, no column chooser opener appears.

nilmerg · 2026-03-03T09:56:37Z

library/Icingadb/Widget/ItemTable/StateItemTable.php

            $headerRow->addHtml($headerCell);
        }

+        if ($headerCell !== null) {


$headerCell cannot be null, unless you initialize it before the loop, which I'd recommend anyway. (Albeit that this can't actually happen, but then why did you check for null to begin with?)

OR

Check if $this->columns isn't empty. May be even simpler.

nilmerg · 2026-03-03T10:03:38Z

application/controllers/ServicesController.php

+            (new ColumnChooser(Url::fromPath('icingadb/services/complete'), Service::on($this->getDb())->getResolver()))
+                ->setAction((string) Url::fromRequest())
+                ->on(ColumnChooser::ON_SENT, function (ColumnChooser $form) {
+                    if ($form->hasBeenSubmitted()) {
+                        $url = Url::fromPath('icingadb/services');
+                        $url->setParam('columns', $form->getValue('columns', ''));
+                        $this->redirectNow($url);
+                    } else {
+                        foreach ($form->getPartUpdates() as $update) {
+                            if (! is_array($update)) {
+                                $update = [$update];
+                            }
+
+                            $this->addPart(...$update);
+                        }
+                    }
+                })->handleRequest($this->getServerRequest())


This should be the job of Controller::createColumnControl. There's already a related comment at the end of it.

nilmerg · 2026-03-03T10:08:23Z

library/Icingadb/Web/Control/ColumnChooser.php

+            ->setReadOnly()
+            ->setOrdered()
+            ->setSuggestionUrl($this->suggestionUrl)
+            ->setValue($this->getColumns($this->getRequest()))


Huh. A widget like this should not have to access the request during assemble. Once createColumnControl initializes this widget, it knows the columns anyway so getColumns($req) should be gone then.

nilmerg · 2026-03-03T10:13:14Z

library/Icingadb/Web/Control/ColumnChooser.php

+                if ($label !== null) {
+                    $term->setLabel($label);
+                }
+            } catch (\Exception) {


Catch InvalidRelationException here

nilmerg · 2026-03-03T10:14:52Z

library/Icingadb/Web/Control/SearchBar/ObjectSuggestions.php

    protected $customVarSources;

-    /** @var ?array<string, string> */
+    /** @var ?array<string, mixed> */


What's the reason for this?

nilmerg · 2026-03-03T10:18:26Z

library/Icingadb/Web/Control/SearchBar/ObjectSuggestions.php

    protected ?array $fixedColumns = null;

+    /** @var array Names of excluded custom variables as {model}.vars.{flatname} */
+    protected array $excludedCustomVars = [];


Please tell me how I'd notice that this is required and for what. I can't imagine this right now and why custom variables are special in that regard. The TermInput already excludes already entered terms in the suggestion list.

As discussed I tried using SearchSuggestions instead, but I can't say I'm satisfied with the result. So I'd be happy for any advice on how to improve them.

…lass` Use the parameter to customize the type of ViewModeSwitcher used

Add a parameter for default columns to be used if no columns are set in the URL

Use `SearchSuggestions` in `HostsController` and `ServicesController`

Use the setter to set the url for the ColumnChooser

It was previously hard coded...

Ensure `GridViewModeSwitcher::class` is passed

cla-bot bot added the cla/signed CLA is signed by all contributors of a PR label Feb 13, 2026

BastianLedererIcinga force-pushed the feature/column-chooser branch 4 times, most recently from 8453195 to 3c998e0 Compare February 26, 2026 14:49

BastianLedererIcinga added 5 commits March 2, 2026 13:17

Add ColumnChooser form

130edca

Add a new form that supports adding and removing dispalyed columns in tabular viewmode.

Add TabularViewModeSwitcher

1782213

Add TabularViewModeSwitcher as a subclass of ViewModeSwitcher and remove tabular view as option of the ViewModeSwitcher.

Adjust StateItemtable and its subclasses

6ddda8b

Add a button to the StateItemTable to open the ColumnChooser form.

Exclude already selected columns from suggestions

2786e1d

Exclude regular columns by using fixed columns and expand Objectsuggestions to exclude a given set of customvars.

BastianLedererIcinga force-pushed the feature/column-chooser branch from 3c998e0 to 2786e1d Compare March 2, 2026 12:18

nilmerg requested changes Mar 3, 2026

View reviewed changes

nilmerg mentioned this pull request Mar 6, 2026

Controller: Handle columns param correctly #852

Closed

nilmerg linked an issue Mar 6, 2026 that may be closed by this pull request

List views with tabular view mode and empty columns are broken #850

Open

BastianLedererIcinga added 6 commits March 11, 2026 09:26

Controller::createViewModeSwitcher(): Add param `$viewModeSwitcherC…

4d2cd6c

…lass` Use the parameter to customize the type of ViewModeSwitcher used

Controller::createColumnControl(): Use parameter for default columns

cb6c90a

Add a parameter for default columns to be used if no columns are set in the URL

Use SearchSuggestions for ColumnChooser

fd668eb

Use `SearchSuggestions` in `HostsController` and `ServicesController`

Add ServiceItemTable::setColumnChooserUrl()

c29c37d

Use the setter to set the url for the ColumnChooser

Move creation of the ColumnChooser Form to createColumnControl()

c8063b5

ColumnChooser: catch InvalidRelationException

7b6c2a9

BastianLedererIcinga requested a review from nilmerg March 11, 2026 10:37

BastianLedererIcinga added 2 commits March 13, 2026 15:41

Fix the $redirectUrl in Controller::createColumnControl()

88b7026

It was previously hard coded...

Adjust usages of CreateColumnControl with GridViewModeSwitcher

1c95d57

Ensure `GridViewModeSwitcher::class` is passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/column chooser#1333

Feature/column chooser#1333
BastianLedererIcinga wants to merge 13 commits intomainfrom
feature/column-chooser

BastianLedererIcinga commented Feb 13, 2026 •

edited

Loading

Uh oh!

nilmerg Mar 3, 2026

Uh oh!

nilmerg Mar 3, 2026

Uh oh!

nilmerg Mar 3, 2026

Uh oh!

nilmerg Mar 3, 2026

Uh oh!

nilmerg Mar 3, 2026

Uh oh!

nilmerg Mar 3, 2026

Uh oh!

nilmerg Mar 3, 2026

Uh oh!

nilmerg Mar 3, 2026

Uh oh!

nilmerg Mar 3, 2026

Uh oh!

BastianLedererIcinga Mar 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

BastianLedererIcinga commented Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

BastianLedererIcinga commented Feb 13, 2026 •

edited

Loading