8000 feature #21819 [Twig Bridge] A simpler way to retrieve flash messages… · symfony/symfony@db8d87d · GitHub
[go: up one dir, main page]
Skip to content

Commit db8d87d

Browse files
fabpotfabpot
committed
feature #21819 [Twig Bridge] A simpler way to retrieve flash messages (javiereguiluz)
This PR was squashed before being merged into the 3.3-dev branch (closes #21819). Discussion ---------- [Twig Bridge] A simpler way to retrieve flash messages | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Getting flash messages in templates is more complex than it could be. Main problems: 1. It's too low level: you need to get the "flash bag" (and first, learn what a "flash bag" is) and then you need to call the internal method: `all()`, `get()`, etc. 2. You need to be careful because the session will start automatically when you ask for flashes (even if there are no flashes). You can prevent this with the `{% if app.session is not null and app.session.started %}` code, but it's boring to always use that. So, I propose to add a new `app.flashes` helper that works as follows. --- ## Get all the flash messages ### Before ```twig {% if app.session is not null and app.session.started %} {% for label, messages in app.session.flashbag.all %} {% for message in messages %} <div class="alert alert-{{ label }}"> {{ message }} </div> {% endfor %} {% endfor %} {% endif %} ``` ### After ```twig {% for label, messages in app.flashes %} {% for message in messages %} <div class="alert alert-{{ label }}"> {{ message }} </div> {% endfor %} {% endfor %} ``` --- ## Get only the flashes of type `notice` ```twig {% if app.session is not null and app.session.started %} {% for message in app.session.flashbag.get('notice') %} <div class="alert alert-notice"> {{ message }} </div> {% endfor %} {% endif %} ``` ### After ```twig {% for message in app.flashes('notice') %} <div class="alert alert-notice"> {{ message }} </div> {% endfor %} ``` --- As an added bonus, you can get any number of flash messages because the method allows to pass an array of flash types: ```twig {% for label, messages in app.flashes(['warning', 'error']) %} {% for message in messages %} <div class="alert alert-{{ label }}"> {{ message }} </div> {% endfor %} {% endfor %} ``` Commits ------- 5a56b23 [Twig Bridge] A simpler way to retrieve flash messages
2 parents 3de0d9b + 5a56b23 commit db8d87d

File tree

2 files changed

+109
-0
lines changed

2 files changed

+109
-0
lines changed

‎src/Symfony/Bridge/Twig/AppVariable.php

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,4 +145,35 @@ public function getDebug()
145145

146146
return $this->debug;
147147
}
148+
149+
/**
150+
* Returns some or all the existing flash messages:
151+
* * getFlashes() returns all the flash messages
152+
* * getFlashes('notice') returns a simple array with flash messages of that type
153+
* * getFlashes(array('notice', 'error')) returns a nested array of type => messages.
154+
*
155+
* @return array
156+
*/
157+
public function getFlashes($types = null)
158+
{
159+
// needed to avoid starting the session automatically when looking for flash messages
160+
try {
161+
$session = $this->getSession();
162+
if (null === $session || !$session->isStarted()) {
163+
return array();
164+
}
165+
} catch (\RuntimeException $e) {
166+
return array();
167+
}
168+
169+
if (null === $types || '' === $types || array() === $types) {
170+
return $session->getFlashBag()->all();
171+
}
172+
173+
if (is_string($types)) {
174+
return $session->getFlashBag()->get($types);
175+
}
176+
177+
return array_intersect_key($session->getFlashBag()->all(), array_flip($types));
178+
}
148179
}

‎src/Symfony/Bridge/Twig/Tests/AppVariableTest.php

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
use PHPUnit\Framework\TestCase;
66
use Symfony\Bridge\Twig\AppVariable;
77
use Symfony\Component\HttpFoundation\Request;
8+
use Symfony\Component\HttpFoundation\Session\Flash\FlashBag;
89
use Symfony\Component\HttpFoundation\Session\Session;
910

1011
class AppVariableTest extends TestCase
@@ -157,6 +158,62 @@ public function testGetSessionWithRequestStackNotSet()
157158
$this->appVariable->getSession();
158159
}
159160

161+
public function testGetFlashesWithNoRequest()
162+
{
163+
$this->setRequestStack(null);
164+
165+
$this->assertEquals(array(), $this->appVariable->getFlashes());
166+
}
167+
168+
public function testGetFlashesWithNoSessionStarted()
169+
{
170+
$request = $this->getMockBuilder('Symfony\Component\HttpFoundation\Request')->getMock();
171+
$request->method('getSession')->willReturn(new Session());
172+
173+
$this->setRequestStack($request);
174+
175+
$this->assertEquals(array(), $this->appVariable->getFlashes());
176+
}
177+
178+
public function testGetFlashes()
179+
{
180+
$flashMessages = $this->setFlashMessages();
181+
$this->assertEquals($flashMessages, $this->appVariable->getFlashes(null));
182+
183+
$flashMessages = $this->setFlashMessages();
184+
$this->assertEquals($flashMessages, $this->appVariable->getFlashes(''));
185+
186+
$flashMessages = $this->setFlashMessages();
187+
$this->assertEquals($flashMessages, $this->appVariable->getFlashes(array()));
188+
189+
$flashMessages = $this->setFlashMessages();
190+
$this->assertEquals(array(), $this->appVariable->getFlashes('this-does-not-exist'));
191+
192+
$flashMessages = $this->setFlashMessages();
193+
$this->assertEquals(array(), $this->appVariable->getFlashes(array('this-does-not-exist')));
194+
195+
$flashMessages = $this->setFlashMessages();
196+
$this->assertEquals($flashMessages['notice'], $this->appVariable->getFlashes('notice'));
197+
198+
$flashMessages = $this->setFlashMessages();
199+
$this->assertEquals(
200+
array('notice' => $flashMessages['notice']),
201+
$this->appVariable->getFlashes(array('notice'))
202+
);
203+
204+
$flashMessages = $this->setFlashMessages();
205+
$this->assertEquals(
206+
array('notice' => $flashMessages['notice']),
207+
$this->appVariable->getFlashes(array('notice', 'this-does-not-exist'))
208+
);
209+
210+
$flashMessages = $this->setFlashMessages();
211+
$this->assertEquals(
212+
array('notice' => $flashMessages['notice'], 'error' => $flashMessages['error']),
213+
$this->appVariable->getFlashes(array('notice', 'error'))
214+
);
215+
}
216+
160217
protected function setRequestStack($request)
161218
{
162219
$requestStackMock = $this->getMockBuilder('Symfony\Component\HttpFoundation\RequestStack')->getMock();
@@ -175,4 +232,25 @@ protected function setTokenStorage($user)
175232

176233
$token->method('getUser')->willReturn($user);
177234
}
235+
236+
private function setFlashMessages()
237+
{
238+
$flashMessages = array(
239+
'notice' => array('Notice #1 message'),
240+
'warning' => array('Warning #1 message'),
241+
'error' => array('Error #1 message', 'Error #2 message'),
242+
);
243+
$flashBag = new FlashBag();
244+
$flashBag->initialize($flashMessages);
245+
246+
$session = $this->getMockBuilder('Symfony\Component\HttpFoundation\Session\Session')->getMock();
247+
$session->method('isStarted')->willReturn(true);
248+
$session->method('getFlashBag')->willReturn($flashBag);
249+
250+
$request = $this->getMockBuilder('Symfony\Component\HttpFoundation\Request')->getMock();
251+
$request->method('getSession')->willReturn($session);
252+
$this->setRequestStack($request);
253+
254+
return $flashMessages;
255+
}
178256
}

0 commit comments

Comments
 (0)
0