Change type of $skipOnEmpty argument in rules' constructors from mixed to bool|callable|null

CHANGELOG.md

@@ -24,6 +24,7 @@
   (@arogachev)
 - Chg #679: Change type of `$rule` argument in `RuleHandlerInterface::validate()` from `object` to `RuleInterface`
   (@arogachev)
+- Chg #660: Change type of `$skipOnEmpty` argument in rules' constructors from `mixed` to `bool|callable|null`
 - Chg #613: Change type of `$escape` argument in `Error::getValuePath()` from `bool|string|null` to `string|null` 
   (@arogachev)
 

UPGRADE.md

@@ -30,3 +30,34 @@ for both A and B.
 
 * The type of `$escape` argument in `Yiisoft\Validator\Error::getValuePath()` changed from `bool|string|null` to 
   `string|null`. If you used `bool`, replace `false` with `null` and `true` with dot (`.`).
+
+* For custom rules using `Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait`, apply the following changes for `$skipOnEmpty` 
+  property in the constructor:
+
+  - Turn in it into argument (remove `private` visibility).
+  - Change type from `mixed` to more specific `bool|callable|null` 
+  - Add manual initialization of property value.
+
+  For example:
+
+  ```php
+  public function __construct(
+      // ...
+      private mixed $skipOnEmpty = null,
+      // ...
+  ) {
+      // ...
+  }
+  ```
+
+  Change to:
+
+  ```php
+  public function __construct(
+      // ...
+      bool|callable|null $skipOnEmpty = null,
+      // ...
+  ) {
+      $this->skipOnEmpty = $skipOnEmpty;
+  }
+  ```

src/Rule/AbstractCompare.php

@@ -151,7 +151,7 @@ public function __construct(
         private string|null $message = null,
         private string $type = CompareType::NUMBER,
         private string $operator = '==',
-        private mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         private bool $skipOnError = false,
         private Closure|null $when = null,
     ) {
@@ -169,6 +169,8 @@ public function __construct(
 
             throw new InvalidArgumentException($message);
         }
+
+        $this->skipOnEmpty = $skipOnEmpty;
     }
 
     public function getName(): string

src/Rule/AbstractNumber.php

@@ -104,7 +104,7 @@ public function __construct(
         private string $lessThanMinMessage,
         private string $greaterThanMaxMessage,
         string $pattern,
-        private mixed $skipOnEmpty,
+        bool|callable|null $skipOnEmpty,
         private bool $skipOnError,
         private Closure|null $when,
     ) {
@@ -113,6 +113,7 @@ public function __construct(
         }
 
         $this->pattern = $pattern;
+        $this->skipOnEmpty = $skipOnEmpty;
     }
 
     public function getName(): string

src/Rule/AtLeast.php

@@ -65,13 +65,15 @@ public function __construct(
         private string $incorrectInputMessage = '{Attribute} must be an array or an object.',
         private string $message = 'At least {min, number} {min, plural, one{attribute} other{attributes}} from this ' .
         'list must be filled: {attributes}.',
-        private mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         private bool $skipOnError = false,
         private Closure|null $when = null
     ) {
         if ($min > count($this->attributes)) {
             throw new InvalidArgumentException('$min must be no greater than amount of $attributes.');
         }
+
+        $this->skipOnEmpty = $skipOnEmpty;
     }
 
     public function getName(): string

src/Rule/BooleanValue.php

@@ -85,10 +85,11 @@ public function __construct(
         private bool $strict = false,
         private string $incorrectInputMessage = 'The allowed types are integer, float, string, boolean. {type} given.',
         private string $message = '{Attribute} must be either "{true}" or "{false}".',
-        private mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         private bool $skipOnError = false,
         private Closure|null $when = null,
     ) {
+        $this->skipOnEmpty = $skipOnEmpty;
     }
 
     public function getName(): string

src/Rule/Callback.php

@@ -58,7 +58,7 @@ final class Callback implements
     public function __construct(
         private mixed $callback = null,
         private string|null $method = null,
-        private mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         private bool $skipOnError = false,
         private Closure|null $when = null,
     ) {
@@ -69,6 +69,8 @@ public function __construct(
         if ($this->callback !== null && $this->method !== null) {
             throw new InvalidArgumentException('"$callback" and "$method" are mutually exclusive.');
         }
+
+        $this->skipOnEmpty = $skipOnEmpty;
     }
 
     public function getName(): string

src/Rule/Composite.php

@@ -92,13 +92,6 @@ class Composite implements
      */
     protected iterable $rules = [];
 
-    /**
-     * @var bool|callable|null Whether to skip this rule group if the validated value is empty / not passed. See
-     * {@see SkipOnEmptyInterface}.
-     * @psalm-var SkipOnEmptyValue
-     */
-    private mixed $skipOnEmpty = null;
-
     /**
      * @var bool Whether to skip this rule group if any of the previous rules gave an error. See
      * {@see SkipOnErrorInterface}.
@@ -133,8 +126,8 @@ public function __construct(
         bool $skipOnError = false,
         Closure|null $when = null,
     ) {
-        $this->rules = RulesNormalizer::normalizeList($rules);
         $this->skipOnEmpty = $skipOnEmpty;
+        $this->rules = RulesNormalizer::normalizeList($rules);
         $this->skipOnError = $skipOnError;
         $this->when = $when;
     }

src/Rule/Count.php

@@ -95,7 +95,7 @@ public function __construct(
         'other{items}}.',
         string $notExactlyMessage = '{Attribute} must contain exactly {exactly, number} {exactly, plural, one{item} ' .
         'other{items}}.',
-        private mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         private bool $skipOnError = false,
         private Closure|null $when = null,
     ) {
@@ -107,6 +107,7 @@ public function __construct(
             $greaterThanMaxMessage,
             $notExactlyMessage
         );
+        $this->skipOnEmpty = $skipOnEmpty;
     }
 
     public function getName(): string

src/Rule/Date/BaseDate.php

@@ -43,10 +43,11 @@ public function __construct(
         private ?string $incorrectInputMessage,
         private ?string $tooEarlyMessage,
         private ?string $tooLateMessage,
-        private mixed $skipOnEmpty,
+        bool|callable|null $skipOnEmpty,
         private bool $skipOnError,
         private Closure|null $when,
     ) {
+        $this->skipOnEmpty = $skipOnEmpty;
     }
 
     public function getFormat(): ?string

src/Rule/Date/Date.php

@@ -130,7 +130,7 @@ public function __construct(
         ?string $incorrectInputMessage = null,
         ?string $tooEarlyMessage = null,
         ?string $tooLateMessage = null,
-        mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         bool $skipOnError = false,
         Closure|null $when = null,
     ) {

src/Rule/Date/DateTime.php

@@ -140,7 +140,7 @@ public function __construct(
         ?string $incorrectInputMessage = null,
         ?string $tooEarlyMessage = null,
         ?string $tooLateMessage = null,
-        mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         bool $skipOnError = false,
         Closure|null $when = null,
     ) {

src/Rule/Date/Time.php

@@ -130,7 +130,7 @@ public function __construct(
         ?string $incorrectInputMessage = null,
         ?string $tooEarlyMessage = null,
         ?string $tooLateMessage = null,
-        mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         bool $skipOnError = false,
         Closure|null $when = null,
     ) {

src/Rule/DateTime.php

@@ -90,7 +90,7 @@ public function __construct(
         string $format = 'Y-m-d',
         private string $incorrectInputMessage = '{Attribute} must be a date.',
         private string $message = '{Attribute} is not a valid date.',
-        private mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         private bool $skipOnError = false,
         private ?Closure $when = null,
     ) {
@@ -99,6 +99,7 @@ public function __construct(
         }
 
         $this->format = $format;
+        $this->skipOnEmpty = $skipOnEmpty;
     }
 
     /**

src/Rule/Each.php

@@ -121,11 +121,12 @@ public function __construct(
         callable|iterable|object|string $rules = [],
         private string $incorrectInputMessage = '{Attribute} must be array or iterable.',
         private string $incorrectInputKeyMessage = 'Every iterable key must have an integer or a string type.',
-        private mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         private bool $skipOnError = false,
         private Closure|null $when = null,
     ) {
         $this->rules = RulesNormalizer::normalize($rules);
+        $this->skipOnEmpty = $skipOnEmpty;
     }
 
     public function getName(): string

src/Rule/Email.php

@@ -96,7 +96,7 @@ public function __construct(
         private bool $enableIdn = false,
         private string $incorrectInputMessage = '{Attribute} must be a string.',
         private string $message = '{Attribute} is not a valid email address.',
-        private mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         private bool $skipOnError = false,
         private Closure|null $when = null,
     ) {
@@ -124,6 +124,8 @@ public function __construct(
             throw new RuntimeException('In order to use IDN validation intl extension must be installed and enabled.');
             // @codeCoverageIgnoreEnd
         }
+
+        $this->skipOnEmpty = $skipOnEmpty;
     }
 
     public function getName(): string

src/Rule/Image/Image.php

@@ -130,7 +130,7 @@ public function __construct(
         private string $tooLargeWidthMessage = 'The width cannot be larger than {limit, number} {limit, plural, one{pixel} other{pixels}}.',
         private string $tooLargeHeightMessage = 'The height cannot be larger than {limit, number} {limit, plural, one{pixel} other{pixels}}.',
         private string $invalidAspectRatioMessage = 'The aspect ratio must be {aspectRatioWidth, number}:{aspectRatioHeight, number} with margin {aspectRatioMargin, number}%.',
-        private mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         private bool $skipOnError = false,
         private Closure|null $when = null,
     ) {
@@ -141,6 +141,8 @@ public function __construct(
         if ($this->height !== null && ($this->minHeight !== null || $this->maxHeight !== null)) {
             throw new InvalidArgumentException('Exact width and min / max height can\'t be specified together.');
         }
+
+        $this->skipOnEmpty = $skipOnEmpty;
     }
 
     public function getWidth(): ?int

src/Rule/In.php

@@ -74,10 +74,11 @@ public function __construct(
         private bool $strict = false,
         private bool $not = false,
         private string $message = '{Attribute} is not in the list of acceptable values.',
-        private mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         private bool $skipOnError = false,
         private Closure|null $when = null,
     ) {
+        $this->skipOnEmpty = $skipOnEmpty;
     }
 
     public function getName(): string

src/Rule/Integer.php

@@ -74,7 +74,7 @@ public function __construct(
         string $lessThanMinMessage = self::DEFAULT_LESS_THAN_MIN_MESSAGE,
         string $greaterThanMaxMessage = self::DEFAULT_GREATER_THAN_MAX_MESSAGE,
         string $pattern = '/^\s*[+-]?\d+\s*$/',
-        mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         bool $skipOnError = false,
         Closure|null $when = null,
     ) {

src/Rule/Ip.php

@@ -193,7 +193,7 @@ public function __construct(
         private string $hasSubnetMessage = '{Attribute} must not be a subnet.',
         private string $notInRangeMessage = '{Attribute} is not in the allowed range.',
         private array $ranges = [],
-        private mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         private bool $skipOnError = false,
         private Closure|null $when = null,
     ) {
@@ -217,6 +217,7 @@ public function __construct(
         }
 
         $this->ranges = $this->prepareRanges($ranges);
+        $this->skipOnEmpty = $skipOnEmpty;
     }
 
     public function getName(): string

src/Rule/Json.php

@@ -58,10 +58,11 @@ final class Json implements DumpedRuleInterface, SkipOnErrorInterface, WhenInter
     public function __construct(
         private string $incorrectInputMessage = '{Attribute} must be a string.',
         private string $message = '{Attribute} is not JSON.',
-        private mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         private bool $skipOnError = false,
         private Closure|null $when = null,
     ) {
+        $this->skipOnEmpty = $skipOnEmpty;
     }
 
     public function getName(): string

src/Rule/Length.php

@@ -97,7 +97,7 @@ public function __construct(
         string $notExactlyMessage = '{Attribute} must contain exactly {exactly, number} {exactly, plural, ' .
         'one{character} other{characters}}.',
         private string $encoding = 'UTF-8',
-        private mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         private bool $skipOnError = false,
         private Closure|null $when = null
     ) {
@@ -109,6 +109,7 @@ public function __construct(
             $greaterThanMaxMessage,
             $notExactlyMessage
         );
+        $this->skipOnEmpty = $skipOnEmpty;
     }
 
     public function getName(): string

src/Rule/Nested.php

@@ -221,10 +221,11 @@ public function __construct(
         private string $noPropertyPathMessage = 'Property "{path}" is not found.',
         private bool $handleEachShortcut = true,
         private bool $propagateOptions = false,
-        private mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         private bool $skipOnError = false,
         private Closure|null $when = null,
     ) {
+        $this->skipOnEmpty = $skipOnEmpty;
         $this->prepareRules($rules);
     }
 

src/Rule/Number.php

@@ -74,7 +74,7 @@ public function __construct(
         string $lessThanMinMessage = '{Attribute} must be no less than {min}.',
         string $greaterThanMaxMessage = '{Attribute} must be no greater than {max}.',
         string $pattern = '/^\s*[-+]?\d*\.?\d+([eE][-+]?\d+)?\s*$/',
-        mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         bool $skipOnError = false,
         Closure|null $when = null,
     ) {

src/Rule/OneOf.php

@@ -58,10 +58,11 @@ public function __construct(
         private array $attributes,
         private string $incorrectInputMessage = '{Attribute} must be an array or an object.',
         private string $message = 'Exactly 1 attribute from this list must be filled: {attributes}.',
-        private mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         private bool $skipOnError = false,
         private Closure|null $when = null
     ) {
+        $this->skipOnEmpty = $skipOnEmpty;
     }
 
     public function getName(): string

src/Rule/Regex.php

@@ -71,7 +71,7 @@ public function __construct(
         private bool $not = false,
         private string $incorrectInputMessage = '{Attribute} must be a string.',
         private string $message = '{Attribute} is invalid.',
-        private mixed $skipOnEmpty = null,
+        bool|callable|null $skipOnEmpty = null,
         private bool $skipOnError = false,
         private Closure|null $when = null,
     ) {
@@ -80,6 +80,7 @@ public function __construct(
         }
 
         $this->pattern = $pattern;
+        $this->skipOnEmpty = $skipOnEmpty;
     }
 
     public function getName(): string