Skip to content

Commit

Permalink
Add different redirect options
Browse files Browse the repository at this point in the history
  • Loading branch information
yhabteab committed Sep 7, 2023
1 parent 72bb31c commit b76413c
Showing 1 changed file with 64 additions and 0 deletions.
64 changes: 64 additions & 0 deletions src/Compat/CompatController.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace ipl\Web\Compat;

use GuzzleHttp\Psr7\ServerRequest;
use Icinga\Application\Version;
use InvalidArgumentException;
use Icinga\Web\Controller;
use ipl\Html\BaseHtmlElement;
Expand Down Expand Up @@ -420,6 +421,69 @@ public function sendExtraUpdates(array $updates)
$this->getResponse()->setHeader('X-Icinga-Extra-Updates', join(',', $extraUpdates));
}

/**
* Close the modal content and refresh the related view
*
* NOTE: When you use this with older Icinga Web versions (< 2.12), you will need to specify a valid redirect url,
* that will produce the same result as using the `__REFRESH__` redirect with the latest Icinga Web version.
*
* This is supposed to be used in combination with a modal view and closes only the modal content,
* and refreshes the modal opener (regardless of whether it is col1 or col2).
*
* @param null|Url|string $url
* @param array<int|string, string> $extraUpdates Provide containers other than the redirect target to be refreshed
* after the redirection. Is just for compatibility reasons and won't be used with latest Icinga Web
* versions. See {@see static::sendExtraUpdates()} how to properly provide extra updates.
*
* @return never
*/
public function closeModalAndRefreshRelatedView($url = null, array $extraUpdates = [])
{
if (version_compare(Version::VERSION, '2.12.0', '<')) {
if (! $url) {
throw new InvalidArgumentException('No redirect url provided');
}

$this->sendExtraUpdates($extraUpdates);

$this->redirectNow($url);
} else {
$this->redirectNow('__REFRESH__');
}
}

/**
* Close the modal content and refresh all the remaining views
*
* NOTE: When you use this with older Icinga Web versions (< 2.12), you will need to specify a valid redirect url,
* that will produce the same result as using the `__REFRESH__` redirect with the latest Icinga Web version.
*
* This is supposed to be used in combination with a modal view and closes only the modal content. It refreshes
* the modal opener (expects to be always col2) and sends extra updates for col1.
*
* @param null|Url|string $url
*
* @return never
*/
public function closeModalAndRefreshRemainingViews($url = null)
{
$this->sendExtraUpdates(['#col1']);

$this->closeModalAndRefreshRelatedView($url);
}

/**
* Redirect using `__CLOSE__`
*
* Change to a single column layout and refresh col1
*
* @return never
*/
public function switchToSingleColumnLayout()
{
$this->redirectNow('__CLOSE__');
}

public function postDispatch()
{
if (empty($this->parts)) {
Expand Down

0 comments on commit b76413c

Please sign in to comment.