laraflash

Laraflash menyediakan cara praktis untuk bekerja dengan pesan flash.

Instalasi

Anda dapat menginstal paket ini melalui komposer menggunakan perintah ini:

composer require coderello/laraflash 

Setelah itu Anda perlu mendaftarkan CoderelloLaraflashMiddlewareHandleLaraflash::class middleware setelah IlluminateSessionMiddlewareStartSession::class satu di appHttpKernel.php

Anda dapat mempublikasikan file konfigurasi dengan:

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

Menambahkan pesan flash

Ada banyak variasi sintaks untuk menambahkan pesan flash, sehingga Anda dapat memilih yang paling Anda sukai.

Mari kita lihat beberapa dari mereka.

 use Coderello  Laraflash  Facades  Laraflash ;

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

message() Metode membuat dan mengembalikan instance FlashMessage segar yang dapat dimodifikasi dengan metode rantai (semua metode dapat ditemukan di bagian FlashMessage methods ).

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

Fasad Laraflash dapat diganti dengan penolong laraflash() seperti yang Anda lihat dalam contoh di atas.

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

Metode message() menerima hingga lima argumen: $content , $title , $type , $delay , $hops .

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

Argumen yang disebutkan dalam contoh sebelumnya dapat diteruskan langsung ke helper laraflash() .

Memberikan pesan flash

Pesan siap saji dapat diberikan menggunakan metode render() dari instance Laraflash .

 laraflash ()-> render ();

Semua metode contoh Laraflash (yang dapat diperoleh dengan memanggil helper laraflash() tanpa argumen yang disahkan) dapat ditemukan di bagian Laraflash methods .

Output HTML akan dihasilkan menggunakan kulit, ditentukan dalam konfigurasi laraflash.skin . Semua kulit yang tersedia tercantum dalam file konfigurasi.

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

Pemisah default antara pesan adalah <br> , yang ditentukan dalam konfigurasi laraflash.separator . Jangan ragu untuk mengubahnya jika Anda membutuhkan.

Contoh pesan yang diberikan sebagai html:

Memperoleh pesan flash sebagai array

Pesan flash dapat diperoleh sebagai array menggunakan metode toArray() .

 laraflash ()-> toArray ();

Inilah hasilnya:

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

Anda dapat menggunakan representasi array dari pesan flash untuk API Anda.

Metode Laraflash

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

Membuat dan mengembalikan instance FlashMessage baru.

render()

Membuat pesan flash siap sebagai html.

keep(): self

Menambahkan satu lagi hop ke setiap pesan flash.

clear(): self

Menghapus semua pesan flash.

all(): Collection

Mengembalikan contoh Collection yang berisi semua pesan flash.

ready(): Collection

Mengembalikan contoh Collection yang berisi pesan flash siap.

touch(): self

Menyentuh semua pesan flash (jumlah penurunan hop dan penundaan, menghapus pesan yang sudah kadaluwarsa).

toArray()

Mengembalikan representasi array dari pesan flash siap.

toJson()

Mengembalikan Representasi JSON dari Pesan Flash Siap.

Metode FlashMessage

content(?string $content): self

Menetapkan konten pesan flash.

title(?string $title): self

Menetapkan judul pesan Flash.

type(?string $type): self

Mengatur jenis pesan flash.

danger(): self

Mengatur jenis danger untuk pesan flash.

warning(): self

Mengatur jenis warning untuk pesan Flash.

info(): self

Mengatur jenis info untuk pesan flash.

success(): self

Menetapkan jenis success untuk pesan flash.

hops(int $hops): self

Menetapkan jumlah hop dari pesan (jumlah permintaan di mana pesan akan hadir).

Default: 1

delay(int $delay): self

Menetapkan keterlambatan pesan (jumlah permintaan di mana pesan akan menunggu untuk menerima status siap).

Default: 1

now(): self

Pintasan untuk ->delay(0)

keep(): self

Menambah jumlah hop.

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

Mengatur atribut khusus yang akan hadir dalam representasi array dari pesan dan dapat diperoleh dengan menggunakan metode get() .

get(string $key)

Mengembalikan nilai atribut.

toArray()

Mengembalikan representasi array dari pesan.

toJson()

Mengembalikan representasi pesan JSON.

Pengujian

Anda dapat menjalankan tes dengan:

composer test 

Changelog

Silakan lihat Changelog untuk informasi lebih lanjut apa yang telah berubah baru -baru ini.

Berkontribusi

Silakan lihat berkontribusi untuk detailnya.

Lisensi

Larflash adalah perangkat lunak bersumber terbuka yang dilisensikan di bawah lisensi MIT.