[8.x] Add unless method on stringable (#37326)

* Add unless method to stringable * Update src/Illuminate/Support/Stringable.php Co-authored-by: Dinh Quoc Han <[email protected]> Co-authored-by: Dinh Quoc Han <[email protected]>
laravel · May 10, 2021 · 235db73 · 235db73
1 parent 32e4a6a
commit 235db73
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/src/Illuminate/Support/Stringable.php b/src/Illuminate/Support/Stringable.php
@@ -708,6 +708,19 @@ public function ucfirst()
         return new static(Str::ucfirst($this->value));
     }
 
+    /**
+     * Apply the callback's string changes if the given "value" is false.
+     *
+     * @param  mixed  $value
+     * @param  callable  $callback
+     * @param  callable|null  $default
+     * @return mixed|$this
+     */
+    public function unless($value, $callback, $default = null)
+    {
+        return $this->when(! $value, $callback, $default);
+    }
+
     /**
      * Apply the callback's string changes if the given "value" is true.
      *

diff --git a/tests/Support/SupportStringableTest.php b/tests/Support/SupportStringableTest.php
@@ -92,6 +92,19 @@ public function testCanBeLimitedByWords()
         $this->assertSame('Taylor Otwell', (string) $this->stringable('Taylor Otwell')->words(3));
     }
 
+    public function testUnless()
+    {
+        $this->assertSame('unless false', (string) $this->stringable('unless')->unless(false, function ($stringable, $value) {
+            return $stringable->append(' false');
+        }));
+
+        $this->assertSame('unless true fallbacks to default', (string) $this->stringable('unless')->unless(true, function ($stringable, $value) {
+            return $stringable->append($value);
+        }, function ($stringable) {
+            return $stringable->append(' true fallbacks to default');
+        }));
+    }
+
     public function testWhenEmpty()
     {
         tap($this->stringable(), function ($stringable) {