Feature/column chooser

[BastianLedererIcinga]

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

[nilmerg]

I can see why you're not satisfied with the usage of SearchSuggestions. To get to a desirable result, a larger change is required. ObjectSuggestions were never designed to be more than a provider for the SearchBar. Now you're borrowing a part of its implementation either by making a protected method public or by copying parts of the code and reduce them to what you need.

I'd suggest to put the logic to retrieve custom variables and model columns for suggestions in a dedicated location that can be used by ObjectSuggestions and SearchSuggestions equally.

namespace Icinga\Module\Icingadb\Data;

/** Not necessarily complete, but I hope you get the idea */
class QueryColumnsProvider implements IteratorAggregate
{
    public function __construct(Query $query, string $searchTerm);
    
    public function setFixedColumns(array $columns);

    public function setCustomVarSources(array $sources);

    /** Basically a copy from `ObjectSuggestions` but without the need for a base implementation */
    protected function matchSuggestion($path, $label, $searchTerm);

    public function getIterator(): Generator;

    /** public because `ObjectSuggestions::fetchValueSuggestions()` need it as well */
    public static function collectFilterColumns(…): Generator;
}

This should serve functionality currently only implemented in ObjectSuggestions to retrieve columns and custom variable names. It should be mostly a drop-in replacement for what ObjectSuggestions::fetchColumnSuggestions() currently does. Though, there is one thing it cannot provide:

addHtml – It's not a html element nor a container. The reason this is required comes from what the SearchSuggestions define as grouping. Though, in case of the column chooser this is required as well I think. QueryColumnsProvider should group by default. i.e. It yields in two levels, first a string key and a generator as value. SearchSuggestions should be able to handle this right now already, ObjectSuggestions need to be adjusted for this.

I hope this is sufficient to get you on track again.

[BastianLedererIcinga]

addHtml – It's not a html element nor a container. The reason this is required comes from what the SearchSuggestions define as grouping. Though, in case of the column chooser this is required as well I think. QueryColumnsProvider should group by default. i.e. It yields in two levels, first a string key and a generator as value. SearchSuggestions should be able to handle this right now already, ObjectSuggestions need to be adjusted for this.

From my understanding SearchSuggestions can't handle grouping the way you suggested.
When no groupingCallback is set the output is not grouped at all, when it is set yield_groups() is used to create the groups, which expects a flat Traversable.

I added a group key to the values yielded by QueryColumnsProvider instead.

[nilmerg]

Didn't look in detail at QueryColumnsProvider and ObjectSuggestions yet.

[nilmerg]

Reduce indentation please

[nilmerg]

Reduce indentation please

[nilmerg]

Please use ipl-i18n's Translation trait instead of the global functions.

[nilmerg]

NOT IN please

[nilmerg]

I noticed that a feature of ObjectSuggestions is missing here: Relation names. (Controlled by shouldShowRelationFor)

We have several duplicate column labels such as Endpoint Name that need further distinction in the suggestions. The search bar's Suggestions have this builtin, the SearchSuggestions on the other hand do not. But as said, they should be dumb, what I'd suggest is to teach them only about that labels might be ipl\Html\Contract\ValidHtml and in that case, they don't render an <input type="button"> but a <button type="button"></button> (That's what Suggestions already do but always.)

So please add support for this, I will create an issue for ip-web, and replicate here the markup the Suggestions use to show relations.