laraflash

Laraflash fournit un moyen pratique de travailler avec les messages flash.

Installation

Vous pouvez installer ce package via Composer en utilisant cette commande:

composer require coderello/laraflash 

Après cela, vous devez enregistrer le CoderelloLaraflashMiddlewareHandleLaraflash::class middleware après le IlluminateSessionMiddlewareStartSession::class One dans l' appHttpKernel.php

Vous pouvez publier le fichier de configuration avec:

php artisan vendor:publish --tag= " laraflash-config " 

Ajout de messages flash

Il existe de nombreuses variations de syntaxe pour ajouter des messages flash, vous pouvez donc choisir celui que vous aimez le plus.

Jetons un coup d'œil à certains d'entre eux.

 use Coderello  Laraflash  Facades  Laraflash ;

Laraflash:: message ()-> content ( ' Some content ' )-> title ( ' Some title ' )-> type ( ' success ' );

La méthode message() crée et renvoie une instance FlashMessage fraîche qui peut être modifiée par des méthodes de chaînage (toutes les méthodes peuvent être trouvées dans la section FlashMessage methods ).

 laraflash ()-> message ()-> content ( ' Some content ' )-> title ( ' Some title ' )-> type ( ' success ' );

La façade Laraflash peut être remplacée par l'assistance laraflash() comme vous pouvez le voir dans l'exemple ci-dessus.

 laraflash ()-> message ( ' Some content ' , ' Some title ' )-> success ();

La méthode message() accepte jusqu'à cinq arguments: $content , $title , $type , $delay , $hops .

 laraflash ( ' Some content ' , ' Some title ' )-> success ();

Les arguments mentionnés dans l'exemple précédent peuvent être transmis directement à l'assistance laraflash() .

Rendre des messages flash

Les messages Flash Ready peuvent être rendus à l'aide de la méthode render() de l'instance Laraflash .

 laraflash ()-> render ();

Toutes les méthodes de l'instance Laraflash (qui pourraient être obtenues en appelant l'assistance laraflash() sans arguments) ont pu être trouvées dans la section Laraflash methods .

La sortie HTML sera générée à l'aide de la peau, spécifiée dans la configuration laraflash.skin . Tous les skins disponibles sont répertoriés dans le fichier de configuration.

 < div class =" alert alert-danger " role =" alert " >
   Danger message.
</ div > < br > < div class =" alert alert-info " role =" alert " >
   Info message.
</ div >

Le séparateur par défaut entre les messages est le <br> , qui est spécifié dans la configuration de laraflash.separator . N'hésitez pas à le changer si vous en avez besoin.

Exemple de messages rendus en HTML:

Obtenir des messages flash comme tableau

Les messages flash peuvent être obtenus sous forme de tableau à l'aide de la méthode toArray() .

 laraflash ()-> toArray ();

Voici le résultat:

 [
  [
    "title" => null,
    "content" => "Instant message.",
    "type" => "danger",
    "hops" => 1,
    "delay" => 0,
  ],
]

Vous pouvez utiliser la représentation du tableau des messages flash pour votre API.

Méthodes Laraflash

message(?string $content = null, ?string $title = null, ?string $type = null, ?int $delay = null, ?int $hops = null): FlashMessage

Crée et renvoie une instance FlashMessage fraîche.

render()

Rend les messages Flash Ready comme HTML.

keep(): self

Ajoute un autre houblon à chaque message flash.

clear(): self

Supprime tous les messages Flash.

all(): Collection

Renvoie l'instance Collection contenant tous les messages flash.

ready(): Collection

Renvoie l'instance Collection contenant des messages Flash Ready.

touch(): self

Touche tous les messages Flash (diminue la quantité de houblon et de retard, supprime les messages expirés).

toArray()

Renvoie une représentation du tableau des messages Flash Ready.

toJson()

Renvoie la représentation JSON des messages Flash Ready.

Méthodes FlashMessage

content(?string $content): self

Définit le contenu du message Flash.

title(?string $title): self

Définit le titre du message Flash.

type(?string $type): self

Définit le type de message flash.

danger(): self

Définit le type danger pour le message Flash.

warning(): self

Définit le type warning pour le message Flash.

info(): self

Définit le type info pour le message Flash.

success(): self

Définit le type success du message Flash.

hops(int $hops): self

Définit le montant du houblon du message (le nombre de demandes dans lesquelles le message sera présent).

Par défaut: 1

delay(int $delay): self

Définit le retard du message (le nombre de demandes dans lesquelles le message attendra pour recevoir l'état prêt).

Par défaut: 1

now(): self

Raccourci pour ->delay(0)

keep(): self

Incréments la quantité de houblon.

attribute(string $key, $value = null): self

Définit l'attribut personnalisé qui sera présent dans la représentation du tableau du message et pourrait être obtenu à l'aide de la méthode get() .

get(string $key)

Renvoie la valeur de l'attribut.

toArray()

Renvoie une représentation du tableau du message.

toJson()

Renvoie la représentation JSON du message.

Essai

Vous pouvez exécuter les tests avec:

composer test 

Changelog

Veuillez consulter Changelog pour plus d'informations ce qui a changé récemment.

Contributif

Veuillez consulter la contribution pour plus de détails.

Licence

Larflash est un logiciel open d'open sous licence MIT.