slim / flash
Slim Framework Flash message service provider
Installs: 1 707 539
Dependents: 126
Suggesters: 1
Security: 0
Stars: 150
Watchers: 16
Forks: 36
Open Issues: 0
Requires
- php: >=5.5.0
Requires (Dev)
- phpunit/phpunit: ^4.0
This package is auto-updated.
Last update: 2024-10-05 23:30:14 UTC
README
This repository contains a Slim Framework Flash messages service provider. This enables you to define transient messages that persist only from the current request to the next request.
Install
Via Composer
$ composer require slim/flash
Requires Slim 3.0.0 or newer.
Usage
Slim 4
This example assumes that you have php-di/php-di
installed.
<?php use DI\ContainerBuilder; use Slim\Factory\AppFactory; use Slim\Flash\Messages; use Slim\Routing\RouteContext; require_once __DIR__ . '/../vendor/autoload.php'; $containerBuilder = new ContainerBuilder(); // Add container definition for the flash component $containerBuilder->addDefinitions( [ 'flash' => function () { $storage = []; return new Messages($storage); } ] ); AppFactory::setContainer($containerBuilder->build()); $app = AppFactory::create(); // Add session start middleware $app->add( function ($request, $next) { // Start PHP session if (session_status() !== PHP_SESSION_ACTIVE) { session_start(); } // Change flash message storage $this->get('flash')->__construct($_SESSION); return $next->handle($request); } ); $app->addErrorMiddleware(true, true, true); // Add routes $app->get( '/', function ($request, $response) { // Set flash message for next request $this->get('flash')->addMessage('Test', 'This is a message'); // Redirect $url = RouteContext::fromRequest($request)->getRouteParser()->urlFor('bar'); return $response->withStatus(302)->withHeader('Location', $url); } ); $app->get( '/bar', function ($request, $response) { $flash = $this->get('flash'); // Get flash messages from previous request $messages = $flash->getMessages(); print_r($messages); // Get the first message from a specific key $test = $flash->getFirstMessage('Test'); print_r($test); return $response; } )->setName('bar'); $app->run();
Slim 3
// Start PHP session session_start(); $app = new \Slim\App(); // Fetch DI Container $container = $app->getContainer(); // Register provider $container['flash'] = function () { return new \Slim\Flash\Messages(); }; $app->get('/foo', function ($req, $res, $args) { // Set flash message for next request $this->flash->addMessage('Test', 'This is a message'); // Redirect return $res->withStatus(302)->withHeader('Location', '/bar'); }); $app->get('/bar', function ($req, $res, $args) { // Get flash messages from previous request $messages = $this->flash->getMessages(); print_r($messages); // Get the first message from a specific key $test = $this->flash->getFirstMessage('Test'); print_r($test); }); $app->run();
Please note that a message could be a string, object or array. Please check what your storage can handle.
Using with Twig-View
If you use Twig-View, then slim-twig-flash may be a useful integration package.
Testing
$ phpunit
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email security@slimframework.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.