Add different redirect options

[yhabteab]

TODO

• Currently, there is now way to determine whether the modal opener is col1 or col2 Define X-Icinga-Modal-Opener request header icingaweb2#5105
• If the modal opener is col1 it won't be refreshed when redirecting using __CLOSE__

Test commit:Icinga/icingaweb2-module-reporting#194

[yhabteab]

TODO

• Sending extra updates for the col2 container shouldn't open a new one if it isn't already there (has to be fixed in Icinga Web 2.).

[nilmerg]

With Icinga/icingaweb2#5108 it's now possible to refresh only the column that would also be affected by any other redirect such as __CLOSE__. (i.e. for modals, the opener)

Please rely on that for closeCurrentAndRefreshRelatedView. Though, rename it to closeModalAndRefreshRelatedView. I'd also suggest to add a second optional parameter which allows to define which column should be refreshed by an extra update in case of a legacy Web version.

Then, for the case where #col1 and #col2 should be refreshed, please add a new method. As name I'd suggest closeModalAndRefreshRemainingViews and assume that the modal is always shown in #col2 so you can issue a __REFRESH__ and an extra update for #col1. This is the only known case where refreshing both columns is required, so I think it's sufficient this way.

[yhabteab]

GitHub actions fail with function never exit execution or throw exception.

[nilmerg]

Then we'll add the same doc return type to ActionController::redirectNow()

[yhabteab]

Requires Icinga/icingaweb2#5110

[nilmerg]

One last thing: The url shouldn't be optional, should it? Any module not passing it, only supports Icinga Web v2.12, which isn't released yet anyway. I don't think anyone developing a module will only support the latest major, and support for 2.11.x won't end soon enough.