laraflash

Laraflash proporciona una forma útil de trabajar con los mensajes flash.

Instalación

Puede instalar este paquete a través del compositor usando este comando:

composer require coderello/laraflash 

Después de eso, debe registrar el CoderelloLaraflashMiddlewareHandleLaraflash::class middleware después del IlluminateSessionMiddlewareStartSession::class uno en la appHttpKernel.php

Puede publicar el archivo de configuración con:

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

Agregar mensajes flash

Hay muchas variaciones de sintaxis para agregar mensajes flash, por lo que puede elegir la que más le guste.

Echemos un vistazo a algunos de ellos.

 use Coderello  Laraflash  Facades  Laraflash ;

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

El método message() crea y devuelve una instancia FlashMessage fresca que puede modificarse mediante métodos de encadenamiento (todos los métodos se pueden encontrar en la sección FlashMessage methods ).

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

La fachada Laraflash se puede reemplazar con el ayudante laraflash() como se pudo ver en el ejemplo anterior.

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

El método message() acepta hasta cinco argumentos: $content , $title , $type , $delay , $hops .

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

Los argumentos mencionados en el ejemplo anterior se pueden pasar directamente al ayudante laraflash() .

Renderizar mensajes flash

Los mensajes de Flash Ready podrían representarse utilizando el método render() de la instancia Laraflash .

 laraflash ()-> render ();

Todos los métodos de la instancia Laraflash (que podrían obtenerse llamando laraflash() auxiliar sin argumentos) se pueden encontrar en la sección Laraflash methods .

La salida HTML se generará utilizando la piel, especificada en la configuración de laraflash.skin . Todas las pieles disponibles se enumeran en el archivo de configuración.

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

El separador predeterminado entre los mensajes es el <br> , que se especifica en la configuración de laraflash.separator . Siéntase libre de cambiarlo si lo necesita.

Ejemplo de mensajes renderizados como html:

Obtener mensajes flash como una matriz

Los mensajes flash se pueden obtener como una matriz utilizando el método toArray() .

 laraflash ()-> toArray ();

Aquí está el resultado:

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

Puede usar la representación de matriz de mensajes flash para su API.

Métodos de Laraflash

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

Crea y devuelve una nueva instancia FlashMessage .

render()

Rendera mensajes de flash listos como HTML.

keep(): self

Agrega un salto más a cada mensaje flash.

clear(): self

Elimina todos los mensajes flash.

all(): Collection

Devuelve la instancia Collection que contiene todos los mensajes flash.

ready(): Collection

Devuelve la instancia Collection que contiene mensajes de flash listos.

touch(): self

Toca todos los mensajes flash (disminuye la cantidad de lúpulo y el retraso, elimina los mensajes caducados).

toArray()

Devuelve una representación de matriz de mensajes Flash Ready.

toJson()

Devuelve la representación JSON de los mensajes Flash Ready.

Métodos de FlashMessage

content(?string $content): self

Establece el contenido del mensaje Flash.

title(?string $title): self

Establece el título del mensaje Flash.

type(?string $type): self

Establece el tipo de mensaje Flash.

danger(): self

Establece el tipo danger para el mensaje Flash.

warning(): self

Establece el tipo warning para el mensaje Flash.

info(): self

Establece el tipo info para el mensaje Flash.

success(): self

Establece el tipo success para el mensaje Flash.

hops(int $hops): self

Establece el monto del lúpulo del mensaje (el número de solicitudes en las que estará presente el mensaje).

Valor predeterminado: 1

delay(int $delay): self

Establece el retraso del mensaje (el número de solicitudes en las que el mensaje estará esperando para recibir el estado listo).

Valor predeterminado: 1

now(): self

Atajo para ->delay(0)

keep(): self

Incrementa la cantidad de lúpulo.

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

Establece el atributo personalizado que estará presente en la representación de la matriz del mensaje y podría obtenerse utilizando el método get() .

get(string $key)

Devuelve el valor del atributo.

toArray()

Devuelve una representación de matriz del mensaje.

toJson()

Devuelve la representación JSON del mensaje.

Pruebas

Puedes ejecutar las pruebas con:

composer test 

Colegio de cambios

Consulte ChangeLog para obtener más información lo que ha cambiado recientemente.

Que contribuye

Consulte contribuyendo para obtener más detalles.

Licencia

Larflash es un software de código abierto con licencia bajo la licencia MIT.