Skip to content

Commit 906ac27

Browse files
benr77fabpot
benr77
authored and
fabpot
committed
[Notifier] Add Importance level to flash message type
Instead of hard-coding the flash message type, set the flash message type based on the "importance" level of the notification.
1 parent 14b5092 commit 906ac27

8 files changed

+234
-2
lines changed

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
CHANGELOG
22
=========
33

4+
6.1
5+
---
6+
7+
* Use importance level to set flash message type
8+
49
5.4
510
---
611

‎Channel/BrowserChannel.php‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
namespace Symfony\Component\Notifier\Channel;
1313

1414
use Symfony\Component\HttpFoundation\RequestStack;
15+
use Symfony\Component\Notifier\FlashMessage\DefaultFlashMessageImportanceMapper;
16+
use Symfony\Component\Notifier\FlashMessage\FlashMessageImportanceMapperInterface;
1517
use Symfony\Component\Notifier\Notification\Notification;
1618
use Symfony\Component\Notifier\Recipient\RecipientInterface;
1719

@@ -22,9 +24,12 @@ final class BrowserChannel implements ChannelInterface
2224
{
2325
private RequestStack $stack;
2426

25-
public function __construct(RequestStack $stack)
27+
private FlashMessageImportanceMapperInterface $mapper;
28+
29+
public function __construct(RequestStack $stack, FlashMessageImportanceMapperInterface $mapper = new DefaultFlashMessageImportanceMapper())
2630
{
2731
$this->stack = $stack;
32+
$this->mapper = $mapper;
2833
}
2934

3035
public function notify(Notification $notification, RecipientInterface $recipient, string $transportName = null): void
@@ -37,7 +42,7 @@ public function notify(Notification $notification, RecipientInterface $recipient
3742
if ($notification->getEmoji()) {
3843
$message = $notification->getEmoji().' '.$message;
3944
}
40-
$request->getSession()->getFlashBag()->add('notification', $message);
45+
$request->getSession()->getFlashBag()->add($this->mapper->flashMessageTypeFromImportance($notification->getImportance()), $message);
4146
}
4247

4348
public function supports(Notification $notification, RecipientInterface $recipient): bool

‎Exception/FlashMessageMappingException.php‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Notifier\Exception;
13+
14+
/**
15+
* @author Ben Roberts <[email protected]>
16+
*/
17+
class FlashMessageMappingException extends LogicException
18+
{
19+
public function __construct(string $importance, string $mappingClass)
20+
{
21+
$message = sprintf('The "%s" Notifier flash message mapper does not support an importance value of "%s".', $mappingClass, $importance);
22+
23+
parent::__construct($message);
24+
}
25+
}

‎FlashMessage/AbstractFlashMessageImportanceMapper.php‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Notifier\FlashMessage;
13+
14+
use Symfony\Component\Notifier\Exception\FlashMessageMappingException;
15+
16+
/**
17+
* @author Ben Roberts <[email protected]>
18+
*/
19+
abstract class AbstractFlashMessageImportanceMapper
20+
{
21+
public function flashMessageTypeFromImportance(string $importance): string
22+
{
23+
if (!\array_key_exists($importance, static::IMPORTANCE_MAP)) {
24+
throw new FlashMessageMappingException($importance, static::class);
25+
}
26+
27+
return static::IMPORTANCE_MAP[$importance];
28+
}
29+
}

‎FlashMessage/BootstrapFlashMessageImportanceMapper.php‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Notifier\FlashMessage;
13+
14+
use Symfony\Component\Notifier\Notification\Notification;
15+
16+
/**
17+
* @author Ben Roberts <[email protected]>
18+
*/
19+
class BootstrapFlashMessageImportanceMapper extends AbstractFlashMessageImportanceMapper implements FlashMessageImportanceMapperInterface
20+
{
21+
protected const IMPORTANCE_MAP = [
22+
Notification::IMPORTANCE_URGENT => 'danger',
23+
Notification::IMPORTANCE_HIGH => 'warning',
24+
Notification::IMPORTANCE_MEDIUM => 'info',
25+
Notification::IMPORTANCE_LOW => 'success',
26+
];
27+
}

‎FlashMessage/DefaultFlashMessageImportanceMapper.php‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Notifier\FlashMessage;
13+
14+
use Symfony\Component\Notifier\Notification\Notification;
15+
16+
/**
17+
* @author Ben Roberts <[email protected]>
18+
*/
19+
class DefaultFlashMessageImportanceMapper extends AbstractFlashMessageImportanceMapper implements FlashMessageImportanceMapperInterface
20+
{
21+
protected const IMPORTANCE_MAP = [
22+
Notification::IMPORTANCE_URGENT => 'notification',
23+
Notification::IMPORTANCE_HIGH => 'notification',
24+
Notification::IMPORTANCE_MEDIUM => 'notification',
25+
Notification::IMPORTANCE_LOW => 'notification',
26+
];
27+
}

‎FlashMessage/FlashMessageImportanceMapperInterface.php‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Notifier\FlashMessage;
13+
14+
use Symfony\Component\Notifier\Exception\FlashMessageMappingException;
15+
16+
/**
17+
* @author Ben Roberts <[email protected]>
18+
*/
19+
interface FlashMessageImportanceMapperInterface
20+
{
21+
/**
22+
* @throws FlashMessageMappingException
23+
*/
24+
public function flashMessageTypeFromImportance(string $importance): string;
25+
}

‎Tests/Channel/BrowserChannelTest.php‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Notifier\Tests\Channel;
13+
14+
use PHPUnit\Framework\TestCase;
15+
use Symfony\Component\HttpFoundation\Request;
16+
use Symfony\Component\HttpFoundation\RequestStack;
17+
use Symfony\Component\HttpFoundation\Session\Flash\FlashBag;
18+
use Symfony\Component\HttpFoundation\Session\Session;
19+
use Symfony\Component\Notifier\Channel\BrowserChannel;
20+
use Symfony\Component\Notifier\Exception\FlashMessageMappingException;
21+
use Symfony\Component\Notifier\FlashMessage\BootstrapFlashMessageImportanceMapper;
22+
use Symfony\Component\Notifier\FlashMessage\DefaultFlashMessageImportanceMapper;
23+
use Symfony\Component\Notifier\FlashMessage\FlashMessageImportanceMapperInterface;
24+
use Symfony\Component\Notifier\Notification\Notification;
25+
use Symfony\Component\Notifier\Recipient\Recipient;
26+
27+
/**
28+
* @author Ben Roberts <[email protected]>
29+
*/
30+
class BrowserChannelTest extends TestCase
31+
{
32+
/**
33+
* @dataProvider defaultFlashMessageImportanceDataProvider
34+
*/
35+
public function testImportanceLevelIsReflectedInFlashMessageType(
36+
FlashMessageImportanceMapperInterface $mapper,
37+
string $importance,
38+
string $expectedFlashMessageType
39+
) {
40+
$session = $this->createMock(Session::class);
41+
$session->method('getFlashBag')->willReturn(new FlashBag());
42+
$browserChannel = $this->buildBrowserChannel($session, $mapper);
43+
$notification = new Notification();
44+
$notification->importance($importance);
45+
$recipient = new Recipient('[email protected]');
46+
47+
$browserChannel->notify($notification, $recipient);
48+
49+
$this->assertEquals($expectedFlashMessageType, array_key_first($session->getFlashBag()->all()));
50+
}
51+
52+
public function testUnknownImportanceMappingIsReported()
53+
{
54+
$session = $this->createMock(Session::class);
55+
$session->method('getFlashBag')->willReturn(new FlashBag());
56+
$browserChannel = $this->buildBrowserChannel($session, new DefaultFlashMessageImportanceMapper());
57+
$notification = new Notification();
58+
$notification->importance('unknown-importance-string');
59+
$recipient = new Recipient('[email protected]');
60+
61+
$this->expectException(FlashMessageMappingException::class);
62+
63+
$browserChannel->notify($notification, $recipient);
64+
}
65+
66+
public function defaultFlashMessageImportanceDataProvider(): array
67+
{
68+
return [
69+
[new DefaultFlashMessageImportanceMapper(), Notification::IMPORTANCE_URGENT, 'notification'],
70+
[new DefaultFlashMessageImportanceMapper(), Notification::IMPORTANCE_HIGH, 'notification'],
71+
[new DefaultFlashMessageImportanceMapper(), Notification::IMPORTANCE_MEDIUM, 'notification'],
72+
[new DefaultFlashMessageImportanceMapper(), Notification::IMPORTANCE_LOW, 'notification'],
73+
[new BootstrapFlashMessageImportanceMapper(), Notification::IMPORTANCE_URGENT, 'danger'],
74+
[new BootstrapFlashMessageImportanceMapper(), Notification::IMPORTANCE_HIGH, 'warning'],
75+
[new BootstrapFlashMessageImportanceMapper(), Notification::IMPORTANCE_MEDIUM, 'info'],
76+
[new BootstrapFlashMessageImportanceMapper(), Notification::IMPORTANCE_LOW, 'success'],
77+
];
78+
}
79+
80+
private function buildBrowserChannel(Session $session, FlashMessageImportanceMapperInterface $mapper): BrowserChannel
81+
{
82+
$request = $this->createMock(Request::class);
83+
$request->method('getSession')->willReturn($session);
84+
$requestStack = $this->createStub(RequestStack::class);
85+
$requestStack->method('getCurrentRequest')->willReturn($request);
86+
87+
return new BrowserChannel($requestStack, $mapper);
88+
}
89+
}

0 commit comments

Comments
 (0)