https://github.com/slimphp/Slim-Flash

Slim Framework flash messages service provider
https://github.com/slimphp/Slim-Flash

Last synced: 24 days ago
JSON representation

Slim Framework flash messages service provider

• Host: GitHub
• URL: https://github.com/slimphp/Slim-Flash
• Owner: slimphp
• License: mit
• Created: 2015-04-01T18:43:46.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-02-10T09:41:16.000Z (almost 3 years ago)
• Last Synced: 2024-05-18T04:41:12.453Z (7 months ago)
• Language: PHP
• Size: 611 KB
• Stars: 149
• Watchers: 16
• Forks: 36
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-slim - Slim Flash - Slim Framework flash messages service provider. (Miscellaneous)

README

        
# Slim Framework Flash Messages

[![Build Status](https://travis-ci.org/slimphp/Slim-Flash.svg?branch=master)](https://travis-ci.org/slimphp/Slim-Flash)

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

``` bash

$ 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

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

```php

// 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](https://github.com/slimphp/Twig-View), then [slim-twig-flash](https://github.com/kanellov/slim-twig-flash) may be a useful integration package.

## Testing

``` bash

$ phpunit

```

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

## Credits

- [Josh Lockhart](https://github.com/codeguy)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.