laraflash

Laraflash fornece uma maneira útil de trabalhar com as mensagens flash.

Instalação

Você pode instalar este pacote via compositor usando este comando:

composer require coderello/laraflash 

Depois disso, você precisa registrar o middleware CoderelloLaraflashMiddlewareHandleLaraflash::class após o IlluminateSessionMiddlewareStartSession::class um no appHttpKernel.php

Você pode publicar o arquivo de configuração com:

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

Adicionando mensagens flash

Existem muitas variações de sintaxe para adicionar mensagens flash, para que você possa escolher o que você mais gosta.

Vamos dar uma olhada em alguns deles.

 use Coderello  Laraflash  Facades  Laraflash ;

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

message() Método cria e retorna a instância fresca FlashMessage , que pode ser modificada por métodos de encadeamento (todos os métodos podem ser encontrados na seção FlashMessage methods ).

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

A fachada Laraflash pode ser substituída pelo ajudante laraflash() como você poderia ver no exemplo acima.

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

message() Método aceita até cinco argumentos: $content , $title , $type , $delay , $hops .

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

Os argumentos mencionados no exemplo anterior podem ser passados ​​diretamente para o ajudante laraflash() .

Renderizando mensagens flash

As mensagens flash prontas podem ser renderizadas usando o método render() da instância de Laraflash .

 laraflash ()-> render ();

Todos os métodos da instância de Laraflash (que poderiam ser obtidos chamando laraflash() Helper sem argumentos sendo passados) podem ser encontrados na seção Laraflash methods .

A saída HTML será gerada usando a pele, especificada na configuração laraflash.skin . Todas as peles disponíveis estão listadas no arquivo de configuração.

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

O separador padrão entre as mensagens é o <br> , que é especificado na configuração laraflash.separator . Sinta -se à vontade para alterá -lo, se precisar.

Exemplo de mensagens renderizadas como HTML:

Obtendo mensagens flash como uma matriz

As mensagens flash podem ser obtidas como uma matriz usando o método toArray() .

 laraflash ()-> toArray ();

Aqui está o resultado:

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

Você pode usar a representação da matriz de mensagens flash para sua API.

Métodos de Laraflash

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

Cria e retorna a instância fresca FlashMessage .

render()

Renderiza mensagens flash prontas como html.

keep(): self

Adiciona mais um salto a cada mensagem flash.

clear(): self

Exclui todas as mensagens flash.

all(): Collection

Retorna a instância Collection que contém todas as mensagens flash.

ready(): Collection

Retorna a instância Collection contendo mensagens flash prontas.

touch(): self

Toque em todas as mensagens flash (quantidade reduz de salto e atraso, exclui mensagens expiradas).

toArray()

Retorna uma representação de matriz de mensagens flash prontas.

toJson()

Retorna a representação JSON de mensagens flash prontas.

Métodos FlashMessage

content(?string $content): self

Define o conteúdo da mensagem flash.

title(?string $title): self

Define o título da mensagem flash.

type(?string $type): self

Define o tipo da mensagem flash.

danger(): self

Define o tipo danger para a mensagem flash.

warning(): self

Define o tipo de warning para a mensagem flash.

info(): self

Define o tipo de info para a mensagem flash.

success(): self

Define o tipo success para a mensagem flash.

hops(int $hops): self

Define o valor do salto da mensagem (o número de solicitações nas quais a mensagem estará presente).

Padrão: 1

delay(int $delay): self

Define o atraso da mensagem (o número de solicitações nas quais a mensagem estará esperando para receber o estado pronto).

Padrão: 1

now(): self

Atalho para ->delay(0)

keep(): self

Incrementa a quantidade de lúpulo.

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

Define o atributo personalizado que estará presente na representação da matriz da mensagem e pode ser obtido usando o método get() .

get(string $key)

Retorna o valor do atributo.

toArray()

Retorna uma representação de matriz da mensagem.

toJson()

Retorna a representação JSON da mensagem.

Teste

Você pode executar os testes com:

composer test 

Changelog

Consulte Changelog para obter mais informações o que mudou recentemente.

Contribuindo

Por favor, consulte a contribuição para obter detalhes.

Licença

O Larflash é um software de código aberto licenciado sob a licença do MIT.