Slim Flash Messages Download - Slim Flash Messages Code source Télécharger

Slim Flash Messages

Cette bibliothèque vous permet d'utiliser des messages temporaires dans votre projet mince. Il est facilement intégré au système de modèle de brindilles, via une extension qui fournit des fonctions à saisir et à utiliser dans le modèle. Il ne se limite pas à la création de chaînes de messages simples, mais permet également d'utiliser d'autres types de données tels que des tableaux.

Installer

composer require williamsampaio/slim-flash-messages

Exemples d'utilisation (Slim 4)

 // app/dependencies.php

//...
use SlimFlashMessages  Flash ;
use SlimFlashMessages  FlashProviderInterface ;

return function ( ContainerBuilder $ containerBuilder ) {
    $ containerBuilder -> addDefinitions ([
        //...
        FlashProviderInterface::class => function () {
            return Flash:: getInstance ();
        },
    ]);
};

 // app/middleware.php

//...
// use SlimFlashMessagesFlashMiddleware;
use SlimFlashMessages  FlashTwigExtension ;

return function ( App $ app ) {
    //...
    // Optional if you are working with dependency injection,
    // using the middleware is only useful if you need to obtain the Flash instance from request.
    // $app->add(FlashMiddleware::createFromContainer($app));

    // With Twig
    $ twig = Twig:: create ( __DIR__ . ' /../templates ' , [ ' cache ' => false ]);
    $ twig -> addExtension (FlashTwigExtension:: createFromContainer ( $ app ));
    $ app -> add (TwigMiddleware:: create ( $ app , $ twig ));
};

 // Your controller

//...
use Slim  Views  Twig ;
// use SlimFlashMessagesFlashProvider;
use SlimFlashMessages  FlashProviderInterface ;

class YourController
{
    private $ flash ;
    private $ view ;

    public function __construct ( FlashProviderInterface $ flash , Twig $ view )
    {
        $ this -> flash = $ flash ;
        $ this -> view = $ view ;
    }

    public function index ( ServerRequestInterface $ request , ResponseInterface $ response )
    {
        // If you are working with middleware instead of dependency injection it will be this way.
        // $flash = FlashProvider::fromRequest($request);

        $ this -> flash -> add ( ' messages ' , ' Hello! ' );

        return $ this -> view -> render ( $ response , ' template.twig ' );
    }

    //...
}

 {# template.twig #}
{% for msg in flash( ' messages ' ) %}
    {{ msg }}
{% endfor %}

Le plus simple possible

L'intégration des brindilles n'est pas obligatoire, comme vous pouvez le voir dans cet exemple, où l'accent est mis sur la démonstration de l'API du fournisseur de messagerie.

 <?php

use Psr  Http  Message  ResponseInterface as Response ;
use Psr  Http  Message  ServerRequestInterface as Request ;
use Slim  Factory  AppFactory ;
use SlimFlashMessages  Flash ;
use SlimFlashMessages  FlashMiddleware ;
use SlimFlashMessages  FlashProvider ;

require __DIR__ . ' /../vendor/autoload.php ' ;

// Important! if the storage is not passed to the constructor,
// $_SESSION will be used
$ flash = Flash:: getInstance ();

// Create App
$ app = AppFactory:: create ();
$ app -> setBasePath ( ' /example1 ' );  // Optional

// Add FlashMiddleware
$ app -> add ( new FlashMiddleware ( $ flash ));

$ app -> addErrorMiddleware ( true , true , true );

$ app -> get ( ' / ' , function ( Request $ request , Response $ response , $ args ) {
    // Get FlashProvider from request
    // FlashMiddleware previously took care of adding the FlashProvider to the request
    $ flash = FlashProvider:: fromRequest ( $ request );

    // Clear all stored values
    $ flash -> clearAll ();

    // The 'add' method allows you to add a flash message or data (as an array, if you prefer!)
    $ flash -> add ( ' simple ' , ' Hello World! 1 ' );

    $ flash -> add ( ' messages ' , [
        ' status ' => ' success ' ,
        ' text ' => ' 1. PHP is the best! '
    ]);

    echo ' <pre> ' ;

    var_dump ( $ flash -> getAll ());

    // Checks if the key is defined in the storage
    var_dump ( $ flash -> has ( ' messages ' ));

    // Clear a key defined
    $ flash -> clear ( ' messages ' );

    var_dump ( $ flash -> getAll ());
    var_dump ( $ flash -> has ( ' messages ' ));

    $ flash -> add ( ' simple ' , ' Hello World! 2 ' );
    $ flash -> add ( ' simple ' , ' Hello World! 3 ' );

    var_dump ( $ flash -> getAll ());

    // Get first item from key
    var_dump ( $ flash -> get_first ( ' simple ' ));
    // or to pick up and remove first item.
    // var_dump($flash->get_first('simple', true));

    // Get last item from key
    // var_dump($flash->get_last('simple'));
    // or to pick up and remove last item.
    var_dump ( $ flash -> get_last ( ' simple ' , true ));

    var_dump ( $ flash -> get ( ' simple ' ));

    return $ response ;
});

$ app -> run ();

Avec conteneur

Cet exemple utilise le conteneur PHP-DI et Slim / Twig-View.

 <?php

use DI  Container ;
use Psr  Http  Message  ResponseInterface as Response ;
use Psr  Http  Message  ServerRequestInterface as Request ;
use Slim  Factory  AppFactory ;
use Slim  Views  Twig ;
use Slim  Views  TwigMiddleware ;
use SlimFlashMessages  Flash ;
use SlimFlashMessages  FlashMiddleware ;
use SlimFlashMessages  FlashProvider ;
use SlimFlashMessages  FlashProviderInterface ;
use SlimFlashMessages  FlashTwigExtension ;

require __DIR__ . ' /../vendor/autoload.php ' ;

// Create a new DI Container
$ container = new Container ();

// Add a FlashProvider to the container
$ container -> set (FlashProviderInterface::class, function () {
    // Important! if the storage is not passed to the constructor,
    // $_SESSION will be used
    return Flash:: getInstance ();
});

// Set container to create App with on AppFactory
AppFactory:: setContainer ( $ container );
$ app = AppFactory:: create ();

$ app -> setBasePath ( ' /example2 ' );  // Optional

// Add FlashMiddleware from container
$ app -> add (FlashMiddleware:: createFromContainer ( $ app ));

// Create Twig and add FlashTwigExtension
$ twig = Twig:: create ( __DIR__ . ' /templates ' , [ ' cache ' => false ]);
$ twig -> addExtension (FlashTwigExtension:: createFromContainer ( $ app ));

// Add Twig-View Middleware
$ app -> add (TwigMiddleware:: create ( $ app , $ twig ));

$ app -> addErrorMiddleware ( true , true , true );

$ app -> get ( ' / ' , function ( Request $ request , Response $ response , $ args ) {
    // Get Twig and FlashProvider from request
    $ view = Twig:: fromRequest ( $ request );

    // FlashMiddleware previously took care of adding the FlashProvider to the request
    $ flash = FlashProvider:: fromRequest ( $ request , ' flash ' );

    $ alerts = [ ' primary ' , ' secondary ' , ' success ' , ' danger ' , ' warning ' , ' info ' , ' light ' , ' dark ' ];

    // The 'add' method allows you to add a flash message or data (as an array, if you prefer!)
    $ flash -> add ( ' simple ' , ' Hello World! ' );

    $ flash -> add ( ' messages ' , [
        ' alert ' => $ alerts [ array_rand ( $ alerts )],
        ' text ' => ' 1. PHP is the best! '
    ]);

    $ flash -> add ( ' messages ' , [
        ' alert ' => $ alerts [ array_rand ( $ alerts )],
        ' text ' => ' 2. Slim Framework is amazing! '
    ]);

    $ flash -> add ( ' messages ' , [
        ' alert ' => $ alerts [ array_rand ( $ alerts )],
        ' text ' => ' 3. Lorem ipsum! '
    ]);

    return $ view -> render ( $ response , ' template.html.twig ' , [
        ' page ' => ' Slim Flash Messages ' ,
    ]);
});

$ app -> run ();

Dans le modèle:

{% for msg in flash( ' messages ' ) %}
< div class = " alert alert-{{ msg . alert }} alert-dismissible fade show " role = " alert " >
    {{ msg . text }}
    < button type = " button " class = " btn-close " data-bs-dismiss = " alert " aria-label = " Close " ></ button >
</ div >
{% endfor %}

Exécuter ces exemples

La façon la plus simple d'exécuter ces exemples est de Docker.

git clone https://github.com/WilliamSampaio/Slim-Flash-Messages.git
cd Slim-Flash-Messages
docker compose up -d --build

Lorsque vous terminez le processus UP, accédez:

Exemple 1: http: // localhost: 8080 / example1 /
Exemple 2: http: // localhost: 8080 / example2 /
Couverture de code: http: // localhost: 8080 / couverture / index.html

Fonctions de brindilles personnalisées

FlashTwigExtension fournit ces fonctions à vos modèles de brindilles.

éclair()

Il reçoit deux paramètres facultatifs, key (String / NULL = NULL ) et clear (bool = true ) .

key : Si elle n'est pas spécifiée, un tableau avec toutes les données de stockage sera renvoyé, sinon seul le tableau avec les données indexées par la valeur de clé sera renvoyée.
clear : Si est faux, les éléments ne seront pas supprimés du stockage une fois la fonction appelée.

{% for msg in flash( ' messages ' , false ) %}
< div class = " alert alert-{{ msg . alert }} alert-dismissible fade show " role = " alert " >
    {{ msg . text }}
    < button type = " button " class = " btn-close " data-bs-dismiss = " alert " aria-label = " Close " ></ button >
</ div >
{% endfor %}

flash_first ()

Il reçoit deux paramètres, key (String) et remove (bool = true ) .

key : le premier élément du tableau avec les données indexées par la valeur de clé sera renvoyée.
remove (facultatif): Si c'est faux, l'élément ne sera pas supprimé du stockage après l'appel de la fonction.

{% set first = flash_first( ' messages ' ) %}
< div class = " alert alert-{{ first . alert }} alert-dismissible fade show " role = " alert " >
    {{ first . text }}
    < button type = " button " class = " btn-close " data-bs-dismiss = " alert " aria-label = " Close " ></ button >
</ div >

flash_last ()

Il reçoit deux paramètres, key (String) et remove (bool = true ) .

key : le dernier élément du tableau avec les données indexées par la valeur clé sera renvoyée.
remove (facultatif): Si c'est faux, l'élément ne sera pas supprimé du stockage après l'appel de la fonction.

{% set last = flash_last( ' messages ' ) %}
< div class = " alert alert-{{ last . alert }} alert-dismissible fade show " role = " alert " >
    {{ last . text }}
    < button type = " button " class = " btn-close " data-bs-dismiss = " alert " aria-label = " Close " ></ button >
</ div >

flash_has ()

Il reçoit un paramètre, key (String) . Vérifie si une clé est définie dans le stockage. Retourner true ou false .

key : la clé qui sera vérifiée.

{{ flash_has( ' messages ' ) ? ' exists! ' : " it doesn't exist... " }}

flash_clear ()

Il reçoit un paramètres facultatifs, key (String) . Supprime les données du stockage. Retour void .

key (facultative): la clé qui sera supprimée. S'il n'est pas défini, il supprime toutes les données du stockage.

{{ flash_clear( ' messages ' ) }}

Tests

Pour exécuter la suite de tests, vous devrez cloner le référentiel et installer les dépendances.

git clone https://github.com/WilliamSampaio/Slim-Flash-Messages.git
cd Slim-Flash-Messages
composer install
composer test
# Or
# composer coverage

Licence

La licence MIT (MIT). Veuillez consulter le fichier de licence pour plus d'informations.

Développer

Slim Flash Messages