Yiisoft\Validator\Rule\Trait\WhenTrait

Complexity

Total Complexity

2

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	when()	0	5	1
A	getWhen()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule\Trait;

use Closure;
use Yiisoft\Validator\WhenInterface;

/**
 * An implementation for {@see WhenInterface} intended to be included in rules. Requires an additional private class
 * property `$when`. In package rules it's `null` by default:
 *
 * ```php
 * public function __construct(
 *     // ...
 *     private Closure|null $when = null
 *     // ...
 * ) {
 * }
 * ```
 *
 * @psalm-import-type WhenType from WhenInterface
 */
trait WhenTrait
{
    /**
     * An immutable setter to change `$when` property.
     *
     * @psalm-param WhenType $value
     *
     * @param Closure|null $value A new value:
     *
     * - `null` - always apply the validation.
     * - `callable` - apply the validation depending on a return value: `true` - apply, `false` - do not apply.
     *
     * @return $this The new instance with a changed value.
     */
    public function when(Closure|null $value): static
    {
        $new = clone $this;
        $new->when = $value;

The property when does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return $new;
    }

    /**
     * A getter for `$when` property.
     *
     * @psalm-return WhenType
     *
     * @return Closure|null Current value:
     *
     * - `null` - always apply the validation.
     * - `callable` - apply the validation depending on a return value: `true` - apply, `false` - do not apply.
     */
    public function getWhen(): Closure|null
    {
        return $this->when;
    }
}