laraflash

Laraflash bietet eine praktische Möglichkeit, mit den Flash -Nachrichten zu arbeiten.

Installation

Sie können dieses Paket über den Komponisten mit diesem Befehl installieren:

composer require coderello/laraflash 

Danach müssen Sie die CoderelloLaraflashMiddlewareHandleLaraflash::class Middleware nach der IlluminateSessionMiddlewareStartSession::class Eins in der appHttpKernel.php registrieren

Sie können die Konfigurationsdatei mit:

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

Hinzufügen von Flash -Nachrichten

Es gibt viele Syntaxvariationen für das Hinzufügen von Flash -Nachrichten, sodass Sie diejenigen auswählen können, die Ihnen am besten gefällt.

Schauen wir uns einige von ihnen an.

 use Coderello  Laraflash  Facades  Laraflash ;

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

message() Methode erstellt und gibt eine frische FlashMessage -Instanz zurück, die durch Verkettungsmethoden geändert werden kann (alle Methoden finden sich im Abschnitt FlashMessage methods ).

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

Laraflash -Fassade kann durch den Helfer laraflash() ersetzt werden, wie Sie im obigen Beispiel sehen konnten.

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

message() Methode akzeptiert bis zu fünf Argumente: $content , $title , $type , $delay , $hops .

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

Im vorherige Beispiel erwähnte Argumente können direkt an den Helfer laraflash() übergeben werden.

Flash -Nachrichten rendern

Ready Flash -Nachrichten können mit der render() -Methode der Laraflash -Instanz wiedergegeben werden.

 laraflash ()-> render ();

Alle Methoden der Laraflash -Instanz (die durch Aufrufen laraflash() -Helfer ohne Argumente erhalten werden konnten) konnten im Abschnitt Laraflash methods gefunden werden.

Die Ausgabe -HTML wird mit Haut erzeugt, die in der laraflash.skin -Konfiguration angegeben ist. Alle verfügbaren Skins sind in der Konfigurationsdatei aufgeführt.

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

Das Standardabscheider zwischen den Nachrichten ist der <br> , das in der laraflash.separator -Konfiguration angegeben ist. Fühlen Sie sich frei, es zu ändern, wenn Sie brauchen.

Beispiel für Nachrichten als HTML:

Erhalten von Flash -Nachrichten als Array

Flash -Nachrichten können als Array mit der Methode toArray() erhalten werden.

 laraflash ()-> toArray ();

Hier ist das Ergebnis:

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

Sie können die Array -Darstellung von Flash -Nachrichten für Ihre API verwenden.

Laraflash -Methoden

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

Erstellt und gibt frische FlashMessage -Instanz zurück.

render()

Renders Fread -Flash -Nachrichten als HTML.

keep(): self

Fügt jeder Flash -Nachricht noch einen Hop hinzu.

clear(): self

Löscht alle Flash -Nachrichten.

all(): Collection

Gibt die Collection zurück, die alle Flash -Nachrichten enthält.

ready(): Collection

Gibt die Collection mit Ready Flash -Nachrichten zurück.

touch(): self

Berührt alle Flash -Nachrichten (verringert die Menge an Hopfen und Verzögerung, löscht abgelaufene Nachrichten).

toArray()

Gibt eine Array -Darstellung von Ready Flash -Nachrichten zurück.

toJson()

Gibt die JSON -Darstellung von Ready Flash -Nachrichten zurück.

FlashMessage -Methoden

content(?string $content): self

Legt den Inhalt der Flash -Nachricht fest.

title(?string $title): self

Legt den Titel der Flash -Nachricht fest.

type(?string $type): self

Legt den Typ der Flash -Nachricht fest.

danger(): self

Legt den danger für die Flash -Nachricht fest.

warning(): self

Legt den warning für die Flash -Nachricht fest.

info(): self

Legt den info -Typ für die Flash -Nachricht fest.

success(): self

Legt den success für die Flash -Nachricht fest.

hops(int $hops): self

Legt den Hopfenbetrag der Nachricht fest (die Anzahl der Anforderungen, in denen die Nachricht vorhanden ist).

Standard: 1

delay(int $delay): self

Legt die Verzögerung der Nachricht fest (die Anzahl der Anfragen, in denen die Nachricht darauf wartet, den fertigen Zustand zu erhalten).

Standard: 1

now(): self

Verknüpfung für ->delay(0)

keep(): self

Erhöht die Menge der Hopfen.

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

Legt das benutzerdefinierte Attribut fest, das in der Array -Darstellung der Nachricht vorhanden ist und mit der Methode get() erhalten werden kann.

get(string $key)

Gibt den Wert des Attributs zurück.

toArray()

Gibt eine Array -Darstellung der Nachricht zurück.

toJson()

Gibt die JSON -Darstellung der Nachricht zurück.

Testen

Sie können die Tests mit: ausführen mit:

composer test 

Changelog

Weitere Informationen finden Sie in letzter Zeit, was in letzter Zeit geändert wurde.

Beitragen

Weitere Informationen finden Sie unter Beitrag.

Lizenz

Larflash ist unter der MIT-Lizenz eine Open-Sourcing-Software lizenziert.