Yiisoft\Validator\Helper\PropagateOptionsHelper

Complexity

Total Complexity

9

Size/Duplication

Total Lines	41
Duplicated Lines	0 %

Importance

Changes	4
Bugs	1	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
B	propagate()	0	24	9

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Helper;

use Yiisoft\Validator\PropagateOptionsInterface;
use Yiisoft\Validator\RuleInterface;
use Yiisoft\Validator\SkipOnEmptyInterface;
use Yiisoft\Validator\SkipOnErrorInterface;
use Yiisoft\Validator\WhenInterface;

/**
 * A helper class used to propagate options' values from a single parent rule to its child rules at all nesting levels
 * recursively.
 */
final class PropagateOptionsHelper
{
    /**
     * Propagates options' values from a single parent rule to its child rules at all nesting levels recursively. The
     * following options' values are propagated:
     *
     * - `$skipOnEmpty` (both rules must implement {@see SkipOnEmptyInterface}).
     * - `$skipOnError` (both rules must implement {@see SkipOnErrorInterface}).
     * - `$when` (both rules must implement {@see WhenInterface}).
     *
     * @param RuleInterface $parentRule A parent rule which options' values need to be propagated.
     * @param iterable<RuleInterface> $childRules Direct child rules (located at the first nesting level) which options'
     * values must be changed to be the same as in parent.
     *
     * @return list<RuleInterface> A list of child rules of the same nesting level with changed options' values or

The type Yiisoft\Validator\Helper\list was not found. Maybe you did not declare it correctly or list all dependencies?

     * unchanged if none of the required interfaces were implemented.
     */
    public static function propagate(RuleInterface $parentRule, iterable $childRules): array
    {
        $rules = [];
        foreach ($childRules as $childRule) {
            if ($parentRule instanceof SkipOnEmptyInterface && $childRule instanceof SkipOnEmptyInterface) {
                $childRule = $childRule->skipOnEmpty($parentRule->getSkipOnEmpty());
            }

            if ($parentRule instanceof SkipOnErrorInterface && $childRule instanceof SkipOnErrorInterface) {
                $childRule = $childRule->skipOnError($parentRule->shouldSkipOnError());
            }

            if ($parentRule instanceof WhenInterface && $childRule instanceof WhenInterface) {
                $childRule = $childRule->when($parentRule->getWhen());
            }

            if ($childRule instanceof PropagateOptionsInterface) {
                $childRule->propagateOptions();
            }

            $rules[] = $childRule;
        }

        return $rules;

The expression return $rules returns the type array which is incompatible with the documented return type Yiisoft\Validator\Helper\list.

    }
}