Add ExcludeIf and ProhibitedIf Validation Methods (#41617)

* Add ExcludeIf and ProhibitedIf Validation Methods

* formatting

Co-authored-by: Taylor Otwell <[email protected]>

Author: intrepidws

src/Illuminate/Validation/Rule.php

@@ -5,9 +5,11 @@
 use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Support\Traits\Macroable;
 use Illuminate\Validation\Rules\Dimensions;
+use Illuminate\Validation\Rules\ExcludeIf;
 use Illuminate\Validation\Rules\Exists;
 use Illuminate\Validation\Rules\In;
 use Illuminate\Validation\Rules\NotIn;
+use Illuminate\Validation\Rules\ProhibitedIf;
 use Illuminate\Validation\Rules\RequiredIf;
 use Illuminate\Validation\Rules\Unique;
 
@@ -103,6 +105,28 @@ public static function requiredIf($callback)
         return new RequiredIf($callback);
     }
 
+    /**
+     * Get a exclude_if constraint builder instance.
+     *
+     * @param  callable|bool  $callback
+     * @return \Illuminate\Validation\Rules\ProhibitedIf
+     */
+    public static function excludeIf($callback)
+    {
+        return new ExcludeIf($callback);
+    }
+
+    /**
+     * Get a prohibited_if constraint builder instance.
+     *
+     * @param  callable|bool  $callback
+     * @return \Illuminate\Validation\Rules\ProhibitedIf
+     */
+    public static function prohibitedIf($callback)
+    {
+        return new ProhibitedIf($callback);
+    }
+
     /**
      * Get a unique constraint builder instance.
      *

src/Illuminate/Validation/Rules/ExcludeIf.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Illuminate\Validation\Rules;
+
+use InvalidArgumentException;
+
+class ExcludeIf
+{
+    /**
+     * The condition that validates the attribute.
+     *
+     * @var callable|bool
+     */
+    public $condition;
+
+    /**
+     * Create a new exclude validation rule based on a condition.
+     *
+     * @param  callable|bool  $condition
+     * @return void
+     */
+    public function __construct($condition)
+    {
+        if (! is_string($condition)) {
+            $this->condition = $condition;
+        } else {
+            throw new InvalidArgumentException('The provided condition must be a callable or boolean.');
+        }
+    }
+
+    /**
+     * Convert the rule to a validation string.
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        if (is_callable($this->condition)) {
+            return call_user_func($this->condition) ? 'exclude' : '';
+        }
+
+        return $this->condition ? 'exclude' : '';
+    }
+}

src/Illuminate/Validation/Rules/ProhibitedIf.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Illuminate\Validation\Rules;
+
+use InvalidArgumentException;
+
+class ProhibitedIf
+{
+    /**
+     * The condition that validates the attribute.
+     *
+     * @var callable|bool
+     */
+    public $condition;
+
+    /**
+     * Create a new prohibited validation rule based on a condition.
+     *
+     * @param  callable|bool  $condition
+     * @return void
+     */
+    public function __construct($condition)
+    {
+        if (! is_string($condition)) {
+            $this->condition = $condition;
+        } else {
+            throw new InvalidArgumentException('The provided condition must be a callable or boolean.');
+        }
+    }
+
+    /**
+     * Convert the rule to a validation string.
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        if (is_callable($this->condition)) {
+            return call_user_func($this->condition) ? 'prohibited' : '';
+        }
+
+        return $this->condition ? 'prohibited' : '';
+    }
+}

tests/Validation/ValidationExcludeIfTest.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Illuminate\Tests\Validation;
+
+use Exception;
+use Illuminate\Validation\Rules\ExcludeIf;
+use InvalidArgumentException;
+use PHPUnit\Framework\TestCase;
+
+class ValidationExcludeIfTest extends TestCase
+{
+    public function testItClousureReturnsFormatsAStringVersionOfTheRule()
+    {
+        $rule = new ExcludeIf(function () {
+            return true;
+        });
+
+        $this->assertSame('exclude', (string) $rule);
+
+        $rule = new ExcludeIf(function () {
+            return false;
+        });
+
+        $this->assertSame('', (string) $rule);
+
+        $rule = new ExcludeIf(true);
+
+        $this->assertSame('exclude', (string) $rule);
+
+        $rule = new ExcludeIf(false);
+
+        $this->assertSame('', (string) $rule);
+    }
+
+    public function testItOnlyCallableAndBooleanAreAcceptableArgumentsOfTheRule()
+    {
+        $rule = new ExcludeIf(false);
+
+        $rule = new ExcludeIf(true);
+
+        $this->expectException(InvalidArgumentException::class);
+
+        $rule = new ExcludeIf('phpinfo');
+    }
+
+    public function testItReturnedRuleIsNotSerializable()
+    {
+        $this->expectException(Exception::class);
+
+        $rule = serialize(new ExcludeIf(function () {
+            return true;
+        }));
+    }
+}

tests/Validation/ValidationProhibitedIfTest.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Illuminate\Tests\Validation;
+
+use Exception;
+use Illuminate\Validation\Rules\ProhibitedIf;
+use InvalidArgumentException;
+use PHPUnit\Framework\TestCase;
+
+class ValidationProhibitedIfTest extends TestCase
+{
+    public function testItClousureReturnsFormatsAStringVersionOfTheRule()
+    {
+        $rule = new ProhibitedIf(function () {
+            return true;
+        });
+
+        $this->assertSame('prohibited', (string) $rule);
+
+        $rule = new ProhibitedIf(function () {
+            return false;
+        });
+
+        $this->assertSame('', (string) $rule);
+
+        $rule = new ProhibitedIf(true);
+
+        $this->assertSame('prohibited', (string) $rule);
+
+        $rule = new ProhibitedIf(false);
+
+        $this->assertSame('', (string) $rule);
+    }
+
+    public function testItOnlyCallableAndBooleanAreAcceptableArgumentsOfTheRule()
+    {
+        $rule = new ProhibitedIf(false);
+
+        $rule = new ProhibitedIf(true);
+
+        $this->expectException(InvalidArgumentException::class);
+
+        $rule = new ProhibitedIf('phpinfo');
+    }
+
+    public function testItReturnedRuleIsNotSerializable()
+    {
+        $this->expectException(Exception::class);
+
+        $rule = serialize(new ProhibitedIf(function () {
+            return true;
+        }));
+    }
+}