ikkez / f3-flash
Add simple Flash Messages and Flash Keys to PHP Fat-Free Framework
Installs: 16 913
Dependents: 6
Suggesters: 0
Security: 0
Stars: 19
Watchers: 3
Forks: 2
Open Issues: 2
This package is auto-updated.
Last update: 2024-10-13 17:18:52 UTC
README
This is a little plugin to add simple Flash Messages and Flash Keys for PHP Fat-Free-Framework, version 3.x
Installation
-
Method 1: use composer composer require ikkez/f3-flash
-
Method 2: copy the
flash.php
file into your F3lib/
directory or another directory that is known to the AUTOLOADER
Usage
To add a message (or multiple) that should only be displayed once in your template on the next request, just do:
\Flash::instance()->addMessage('You did that wrong.', 'danger'); // or \Flash::instance()->addMessage('It worked!', 'success');
And to display that in your templates do:
<!-- bootstrap style--> <F3:repeat group="{{ \Flash::instance()->getMessages() }}" value="{{ @msg }}"> <div class="alert alert-{{ @msg.status }} alert-dismissable"> <button type="button" class="close" data-dismiss="alert" aria-hidden="true">×</button> {{ @msg.text | esc }} </div> </F3:repeat>
That's it.
If you need, you could also add simple keys:
$flash = \Flash::instance() $f3->set('FLASH', $flash); $flash->setKey('highlight','bg-success'); // with value $flash->setKey('show-hint'); // without returns just TRUE $flash->setKey('error','Catastrophic error occured! ');
for use cases like:
<div class="box {{ @FLASH->getKey('highlight') }}"> <F3:check if="{{ @FLASH->getKey('show-hint') }}"> <p>It's new !!!</p> </F3:check> ... </div>
<F3:check if="{{ @@FLASH && @FLASH->hasKey('error') }}"> <p>{{ @FLASH->getKey('error') }}</p> </F3:check>
License
You are allowed to use this plugin under the terms of the GNU General Public License version 3 or later.
Copyright (C) 2017 Christian Knuth [ikkez]