laraflash

Laraflash предоставляет удобный способ работать с флэш -сообщениями.

Установка

Вы можете установить этот пакет через композитор, используя эту команду:

composer require coderello/laraflash 

После этого вам нужно зарегистрировать CoderelloLaraflashMiddlewareHandleLaraflash::class после IlluminateSessionMiddlewareStartSession::class в appHttpKernel.php

Вы можете опубликовать файл конфигурации с помощью:

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

Добавление флэш -сообщений

Существует множество вариаций синтаксиса для добавления флэш -сообщений, поэтому вы можете выбрать тот, который вам больше всего нравится.

Давайте посмотрим на некоторые из них.

 use Coderello  Laraflash  Facades  Laraflash ;

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

Метод message() Создает и возвращает свежий экземпляр FlashMessage , который можно изменить с помощью методов цепочки (все методы можно найти в разделе FlashMessage methods »).

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

Фасад Laraflash может быть заменен помощником laraflash() как вы могли увидеть в примере выше.

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

Метод message() принимает до пяти аргументов: $content , $title , $type , $delay , $hops .

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

Аргументы, упомянутые в предыдущем примере, могут быть переданы непосредственно вспомогательному помощнику laraflash() .

Рендеринг флэш -сообщений

Готовые флэш -сообщения могут быть отображены с использованием метода render() экземпляра Laraflash .

 laraflash ()-> render ();

Все методы экземпляра Laraflash (который может быть получен путем вызова помощника laraflash() без аргументов), можно найти в разделе Laraflash methods .

Выходной HTML будет генерироваться с использованием кожи, указанной в конфигурации laraflash.skin . Все доступные скины перечислены в файле конфигурации.

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

Разделитель по умолчанию между сообщениями - <br> , который указан в конфигурации laraflash.separator . Не стесняйтесь изменить его, если вам нужно.

Пример сообщений, представленных как HTML:

Получение флэш -сообщений в качестве массива

Флэш -сообщения можно получить в виде массива с использованием метода toArray() .

 laraflash ()-> toArray ();

Вот результат:

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

Вы можете использовать массив представления флэш -сообщений для вашего API.

Методы Laraflash

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

Создает и возвращает свежий экземпляр FlashMessage .

render()

Образует готовые флэш -сообщения как HTML.

keep(): self

Добавляет еще один прыжок к каждому флэш -сообщению.

clear(): self

Удаляет все флэш -сообщения.

all(): Collection

Возвращает экземпляр Collection , содержащий все сообщения Flash.

ready(): Collection

Возвращает экземпляр Collection , содержащий готовые флэш -сообщения.

touch(): self

Касается всех флэш -сообщений (уменьшайте количество хмеля и задержки, удаляет истекшие сообщения).

toArray()

Возвращает массив представления готовых флэш -сообщений.

toJson()

Возвращает представление JSON готовых флеш -сообщений.

Методы FlashMessage

content(?string $content): self

Устанавливает содержимое сообщения Flash.

title(?string $title): self

Устанавливает заголовок флэш -сообщения.

type(?string $type): self

Устанавливает тип флэш -сообщения.

danger(): self

Устанавливает тип danger для флэш -сообщения.

warning(): self

Устанавливает тип warning для сообщения Flash.

info(): self

Устанавливает тип info для сообщения Flash.

success(): self

Устанавливает тип success для сообщения Flash.

hops(int $hops): self

Устанавливает сумму хмеля сообщения (количество запросов, в которых будет присутствовать сообщение).

По умолчанию: 1

delay(int $delay): self

Устанавливает задержку сообщения (количество запросов, в которых сообщение будет ждать, чтобы получить состояние готового состояния).

По умолчанию: 1

now(): self

Ярлык для ->delay(0)

keep(): self

Приращивает количество хмеля.

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

Устанавливает пользовательский атрибут, который будет присутствовать в представлении массива сообщения и может быть получен с помощью метода get() .

get(string $key)

Возвращает значение атрибута.

toArray()

Возвращает массивовое представление сообщения.

toJson()

Возвращает представление сообщения.

Тестирование

Вы можете запустить тесты с:

composer test 

Изменение

Пожалуйста, смотрите ChangeLog для получения дополнительной информации, что изменилось в последнее время.

Внося

Пожалуйста, смотрите для получения подробной информации.

Лицензия

LARFLASH -это программное обеспечение с открытым исходным кодом, лицензированное по лицензии MIT.