wip

Author: freekmurze

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `laravel-flash` will be documented in this file
 
+## 1.6.0 - 2020-03-18
+
+- add `level` property on `flash()`
+
 ## 1.5.0 - 2020-03-01
 
 - add support for Laravel 7

README.md

@@ -108,7 +108,7 @@ In your view you can use the class like this:
 You can also set an array of classes. These will be output by `flash()->class` by imploding the array with a space-delimiter.
 
 ```php
- flash('My message', ['my-class', 'another-class'])); // flash()->class output is: 'my-class another-class'
+flash('My message', ['my-class', 'another-class']); // flash()->class output is: 'my-class another-class'
 ```
 
 
@@ -136,6 +136,20 @@ flash()->warning('Mayybeee');
 flash()->error('Oh Oh');
 ```
 
+The most likely scenario is that you want to consume the flash message in a view. You can use the `message`, `class` and `level` properties on the view.
+
+```blade
+@if (flash()->message)
+    <div class="{{ flash()->class }}">
+        {{ flash()->message }}
+    </div>
+
+    @if(flash()->level === 'error')
+        This was an error.
+    @endif
+@endif
+```
+
 Additionally, when you've added your own method, you can also pass that method name as a second parameter to `flash` itself:
 
 ```php
@@ -162,6 +176,20 @@ You can now use a `warning` method on `flash`:
 flash()->warning('Look above you!');
 ```
 
+You can pass the desired `level` as the third argument to `Message`.
+
+```php
+// in a service provider
+use Spatie\Flash\Message;
+
+\Spatie\Flash\Flash::macro('warning', function (string $message) {
+    return $this->flashMessage(new Message($message, 'alert alert-warning', 'my-level'));
+});
+
+// in the next request, after having flashed a message 
+flash()->level; // returns `my-level`
+```
+
 ## Alternatives
 
 This package is intended to be lightweight. If you need things like multiple messages, support for Bootstrap, overlays, ... take a look at [this excellent flash package](https://github.com/laracasts/flash) by [Jeffrey Way](https://github.com/JeffreyWay) or [Laraflash](https://github.com/coderello/laraflash) by [Ilya Sakovich](https://github.com/hivokas).

src/Flash.php

@@ -30,7 +30,11 @@ public function getMessage(): ?Message
             return null;
         }
 
-        return new Message($flashedMessageProperties['message'], $flashedMessageProperties['class']);
+        return new Message(
+            $flashedMessageProperties['message'],
+            $flashedMessageProperties['class'],
+            $flashedMessageProperties['level']
+        );
     }
 
     public function flash(Message $message): void
@@ -54,7 +58,7 @@ public function flashMessage(Message $message): void
     public static function levels(array $methodClasses): void
     {
         foreach ($methodClasses as $method => $classes) {
-            self::macro($method, fn (string $message) => $this->flashMessage(new Message($message, $classes)));
+            self::macro($method, fn (string $message) => $this->flashMessage(new Message($message, $classes, $method)));
         }
     }
 }

src/Message.php

@@ -8,7 +8,9 @@ class Message
 
     public ?string $class;
 
-    public function __construct(string $message, $class = null)
+    public ?string $level;
+
+    public function __construct(string $message, $class = null, $level = null)
     {
         if (is_array($class)) {
             $class = implode(' ', $class);
@@ -17,13 +19,16 @@ public function __construct(string $message, $class = null)
         $this->message = $message;
 
         $this->class = $class;
+
+        $this->level = $level;
     }
 
     public function toArray(): array
     {
         return [
             'message' => $this->message,
             'class' => $this->class,
+            'level' => $this->level,
         ];
     }
 }

tests/FlashTest.php

@@ -64,6 +64,31 @@ public function multiple_methods_can_be_added_in_one_go()
         $this->assertEquals('alert-error', flash()->class);
     }
 
+    /** @test */
+    public function it_can_get_the_flash_level_when_the_level_is_registered_using_the_macro()
+    {
+        Flash::macro('info', function (string $message) {
+            return $this->flash(new Message($message, 'my-info-class', 'info'));
+        });
+
+        flash()->info('my info message');
+
+        $this->assertEquals('info', flash()->level);
+    }
+
+    /** @test */
+    public function it_can_get_the_flash_level_when_levels_are_registering_in_one_go()
+    {
+        Flash::levels([
+            'warning' => 'alert-warning',
+            'error' => 'alert-error',
+        ]);
+
+        flash()->error('my error');
+
+        $this->assertEquals('error', flash()->level);
+    }
+
     /** @test */
     public function when_passing_a_class_name_that_is_registered_as_method_it_will_call_that_method()
     {