WhenEmpty::__construct() - Code Metrics - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

WhenEmpty::__construct() A
last analyzed 2024-01-12 07:44 UTC

↳ Parent: WhenEmpty

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	0

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	0
nc	1
nop	1
dl	0
loc	7
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\EmptyCondition;

use function is_string;

/**
 * Empty condition is a callable returning `true` if a value must be considered empty.
 *
 * With `WhenEmpty`, a value is considered empty only when it is either:
 *
 * - Not passed at all.
 * - `null`.
 * - An empty string (not trimmed by default).
 * - An empty iterable.
 *
 * With regard to validation process, a corresponding rule is skipped only if this condition is met and `WhenEmpty` is
 * set:
 *
 * - At a rule level via `$skipOnEmpty` property, but only for rules implementing {@see SkipOnEmptyTrait} / including
 * {@see SkipOnEmptyTrait}.
 * - At validator level ({@see Validator::$defaultSkipOnEmptyCondition}).
 *
 * A shortcut for `new WhenEmpty()` is `true` (string is not trimmed). If you want a string to be trimmed before
 * checking, use `new WhenEmpty(trimString: false)`.
 */
final class WhenEmpty
{
    public function __construct(
        /*
         * @var bool Whether to trim string (both from the start and from the end) before checking. Defaults to `false`

         * meaning no trimming is done.

         */

        private bool $trimString = false,
    ) {
    }

    /**
     * @param mixed $value The validated value.
     * @param bool $isAttributeMissing A flag defining whether the attribute is missing (not used / not passed at all).
     *
     * @return bool Whether the validated value is considered empty.
     */
    public function __invoke(mixed $value, bool $isAttributeMissing): bool
    {
        if ($isAttributeMissing || $value === null) {
            return true;
        }

        if (is_string($value)) {
            if ($this->trimString) {
                $value = trim($value);
            }

            return $value === '';
        }

        if (is_iterable($value)) {
            foreach ($value as $_item) {
                return false;
            }

            return true;
        }

        return false;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Yiisoft\Validator\EmptyCondition;
6
7			use function is_string;
8
9			/**
10			* Empty condition is a callable returning `true` if a value must be considered empty.
11			*
12			* With `WhenEmpty`, a value is considered empty only when it is either:
13			*
14			* - Not passed at all.
15			* - `null`.
16			* - An empty string (not trimmed by default).
17			* - An empty iterable.
18			*
19			* With regard to validation process, a corresponding rule is skipped only if this condition is met and `WhenEmpty` is
20			* set:
21			*
22			* - At a rule level via `$skipOnEmpty` property, but only for rules implementing {@see SkipOnEmptyTrait} / including
23			* {@see SkipOnEmptyTrait}.
24			* - At validator level ({@see Validator::$defaultSkipOnEmptyCondition}).
25			*
26			* A shortcut for `new WhenEmpty()` is `true` (string is not trimmed). If you want a string to be trimmed before
27			* checking, use `new WhenEmpty(trimString: false)`.
28			*/
29			final class WhenEmpty
30			{
31			public function __construct(
32			/*
33			* @var bool Whether to trim string (both from the start and from the end) before checking. Defaults to `false`
			0 ignored issues – show Coding Style introduced 2022-12-06 11:01 UTC by Report Bug Copy Issue Report Multi-line function declaration not indented correctly; expected 8 spaces but found 0 Loading history...
34			* meaning no trimming is done.
			0 ignored issues – show Coding Style introduced 2022-12-06 11:01 UTC by Report Bug Copy Issue Report Multi-line function declaration not indented correctly; expected 8 spaces but found 0 Loading history...
35			*/
			0 ignored issues – show Coding Style introduced 2022-12-06 11:01 UTC by Report Bug Copy Issue Report Multi-line function declaration not indented correctly; expected 8 spaces but found 0 Loading history...
36			private bool $trimString = false,
37			) {
38			}
39
40			/**
41			* @param mixed $value The validated value.
42			* @param bool $isAttributeMissing A flag defining whether the attribute is missing (not used / not passed at all).
43			*
44			* @return bool Whether the validated value is considered empty.
45			*/
46			public function __invoke(mixed $value, bool $isAttributeMissing): bool
47			{
48			if ($isAttributeMissing \|\| $value === null) {
49			return true;
50			}
51
52			if (is_string($value)) {
53			if ($this->trimString) {
54			$value = trim($value);
55			}
56
57			return $value === '';
58			}
59
60			if (is_iterable($value)) {
61			foreach ($value as $_item) {
62			return false;
63			}
64
65			return true;
66			}
67
68			return false;
69			}
70			}
71

yiisoft / validator

WhenEmpty::__construct() A last analyzed 2024-01-12 07:44 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

WhenEmpty::__construct() A
last analyzed 2024-01-12 07:44 UTC