Count::getObjectValidated() - Code Metrics - Inspection of "Add `DataWrapperInteface`" - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#464)

by Alexander

created 2023-01-08 06:51 UTC

Count::getObjectValidated() A

↳ Parent: Count

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	0
cts	0
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Attribute;
use Closure;
use Countable;
use Yiisoft\Validator\LimitInterface;
use Yiisoft\Validator\Rule\Trait\LimitTrait;
use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
use Yiisoft\Validator\Rule\Trait\WhenTrait;
use Yiisoft\Validator\RuleWithOptionsInterface;
use Yiisoft\Validator\SkipOnEmptyInterface;
use Yiisoft\Validator\SkipOnErrorInterface;
use Yiisoft\Validator\WhenInterface;

/**
 * Defines validation options to check that the value contains certain number of items.
 * Can be applied to arrays or classes implementing {@see Countable} interface.
 *
 * @see CountHandler
 *
 * @psalm-import-type WhenType from WhenInterface
 */
#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
final class Count implements
    RuleWithOptionsInterface,
    SkipOnErrorInterface,
    WhenInterface,
    SkipOnEmptyInterface,
    LimitInterface
{
    use LimitTrait;
    use SkipOnEmptyTrait;
    use SkipOnErrorTrait;
    use WhenTrait;

    /**
     * @var object|null Object being validated.
     */
    private ?object $objectValidated = null;


    /**
     * @param int|null $exactly Exact number of items. `null` means no strict comparison. Mutually exclusive with
     * {@see $min} and {@see $max}.
     * @param int|null $min Minimum number of items. null means no minimum number limit. Can't be combined with
     * {@see $exactly}. See {@see $lessThanMinMessage} for the customized message for a value with too few items.
     * @param int|null $max Maximum number of items. null means no maximum number limit. Can't be combined with
     * {@see $exactly}. See {@see $greaterThanMaxMessage} for the customized message for a value with too many items.
     * @param string $incorrectInputMessage Error message used when the value is neither an array nor an object
     * implementing {@see \Countable} interface.
     *
     * You may use the following placeholders in the message:
     *
     * - `{attribute}`: the translated label of the attribute being validated.
     * - `{type}`: the type of the value being validated.
     * @param string $lessThanMinMessage Error message used when the number of items is smaller than {@see $min}.
     *
     * You may use the following placeholders in the message:
     *
     * - `{attribute}`: the translated label of the attribute being validated.
     * - `{min}`: minimum number of items required.
     * - `{number}`: actual number of items.
     * @param string $greaterThanMaxMessage Error message used when the number of items is greater than {@see $max}.
     *
     * You may use the following placeholders in the message:
     *
     * - `{attribute}`: the translated label of the attribute being validated.
     * - `{max}`: maximum number of items required.
     * - `{number}`: actual number of items.
     * @param string $notExactlyMessage Error message used when the number of items does not equal {@see $exactly}.
     *
     * You may use the following placeholders in the message:
     *
     * - `{attribute}`: the translated label of the attribute being validated.
     * - `{exactly}`: exact number of items required.
     * - `{number}`: actual number of items.
     * @param bool|callable|null $skipOnEmpty Whether to skip this rule if the value validated is empty.
     * See {@see SkipOnEmptyInterface}.
     * @param bool $skipOnError Whether to skip this rule if any of the previous rules gave an error.
     * See {@see SkipOnErrorInterface}.
     * @param Closure|null $when A callable to define a condition for applying the rule.
     * See {@see WhenInterface}.
     * @psalm-param WhenType $when
     */
    public function __construct(
        int|null $exactly = null,
        int|null $min = null,
        int|null $max = null,
        private string $incorrectInputMessage = 'This value must be an array or implement \Countable interface.',
        string $lessThanMinMessage = 'This value must contain at least {min, number} {min, plural, one{item} ' .
        'other{items}}.',
        string $greaterThanMaxMessage = 'This value must contain at most {max, number} {max, plural, one{item} ' .
        'other{items}}.',
        string $notExactlyMessage = 'This value must contain exactly {exactly, number} {exactly, plural, one{item} ' .
        'other{items}}.',
        private mixed $skipOnEmpty = null,
        private bool $skipOnError = false,
        private Closure|null $when = null,
    ) {
        $this->initLimitProperties(
            $min,
            $max,
            $exactly,
            $lessThanMinMessage,
            $greaterThanMaxMessage,
            $notExactlyMessage
        );
    }

    public function getName(): string
    {
        return 'count';
    }

    /**
     * Get error message used when the value is neither an array nor an object implementing {@see \Countable} interface.
     *
     * @return string Error message.
     *
     * @see $incorrectInputMessage
     */
    public function getIncorrectInputMessage(): string
    {
        return $this->incorrectInputMessage;
    }

    public function getOptions(): array
    {
        return array_merge($this->getLimitOptions(), [
            'incorrectInputMessage' => [
                'template' => $this->getIncorrectInputMessage(),
                'parameters' => [],
            ],
            'skipOnEmpty' => $this->getSkipOnEmptyOption(),
            'skipOnError' => $this->skipOnError,
        ]);
    }

    public function getHandler(): string
    {
        return CountHandler::class;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Validator\Rule;
6
7		use Attribute;
8		use Closure;
9		use Countable;
10		use Yiisoft\Validator\LimitInterface;
11		use Yiisoft\Validator\Rule\Trait\LimitTrait;
12		use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
13		use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
14		use Yiisoft\Validator\Rule\Trait\WhenTrait;
15		use Yiisoft\Validator\RuleWithOptionsInterface;
16		use Yiisoft\Validator\SkipOnEmptyInterface;
17		use Yiisoft\Validator\SkipOnErrorInterface;
18		use Yiisoft\Validator\WhenInterface;
19
20		/**
21		* Defines validation options to check that the value contains certain number of items.
22		* Can be applied to arrays or classes implementing {@see Countable} interface.
23		*
24		* @see CountHandler
25		*
26		* @psalm-import-type WhenType from WhenInterface
27		*/
28		#[Attribute(Attribute::TARGET_CLASS \| Attribute::TARGET_PROPERTY \| Attribute::IS_REPEATABLE)]
29		final class Count implements
30		RuleWithOptionsInterface,
31		SkipOnErrorInterface,
32		WhenInterface,
33		SkipOnEmptyInterface,
34		LimitInterface
35		{
36		use LimitTrait;
37		use SkipOnEmptyTrait;
38	18	use SkipOnErrorTrait;
39		use WhenTrait;
40
41		/**
42		* @var object\|null Object being validated.
43		*/
44		private ?object $objectValidated = null;
		0 ignored issues – show introduced 2023-01-08 06:55 UTC by Report Bug Copy Issue Report The private property `$objectValidated` is not used, and could be removed. Loading history...
45
46		/**
47		* @param int\|null $exactly Exact number of items. `null` means no strict comparison. Mutually exclusive with
48		* {@see $min} and {@see $max}.
49		* @param int\|null $min Minimum number of items. null means no minimum number limit. Can't be combined with
50		* {@see $exactly}. See {@see $lessThanMinMessage} for the customized message for a value with too few items.
51		* @param int\|null $max Maximum number of items. null means no maximum number limit. Can't be combined with
52		* {@see $exactly}. See {@see $greaterThanMaxMessage} for the customized message for a value with too many items.
53		* @param string $incorrectInputMessage Error message used when the value is neither an array nor an object
54		* implementing {@see \Countable} interface.
55		*
56		* You may use the following placeholders in the message:
57		*
58		* - `{attribute}`: the translated label of the attribute being validated.
59		* - `{type}`: the type of the value being validated.
60		* @param string $lessThanMinMessage Error message used when the number of items is smaller than {@see $min}.
61		*
62		* You may use the following placeholders in the message:
63		*
64		* - `{attribute}`: the translated label of the attribute being validated.
65		* - `{min}`: minimum number of items required.
66		* - `{number}`: actual number of items.
67		* @param string $greaterThanMaxMessage Error message used when the number of items is greater than {@see $max}.
68		*
69		* You may use the following placeholders in the message:
70		*
71		* - `{attribute}`: the translated label of the attribute being validated.
72		* - `{max}`: maximum number of items required.
73		* - `{number}`: actual number of items.
74		* @param string $notExactlyMessage Error message used when the number of items does not equal {@see $exactly}.
75		*
76		* You may use the following placeholders in the message:
77		*
78		* - `{attribute}`: the translated label of the attribute being validated.
79		* - `{exactly}`: exact number of items required.
80		* - `{number}`: actual number of items.
81		* @param bool\|callable\|null $skipOnEmpty Whether to skip this rule if the value validated is empty.
82		* See {@see SkipOnEmptyInterface}.
83		* @param bool $skipOnError Whether to skip this rule if any of the previous rules gave an error.
84		* See {@see SkipOnErrorInterface}.
85		* @param Closure\|null $when A callable to define a condition for applying the rule.
86		* See {@see WhenInterface}.
87		* @psalm-param WhenType $when
88		*/
89		public function __construct(
90		int\|null $exactly = null,
91	18	int\|null $min = null,
92		int\|null $max = null,
93		private string $incorrectInputMessage = 'This value must be an array or implement \Countable interface.',
94		string $lessThanMinMessage = 'This value must contain at least {min, number} {min, plural, one{item} ' .
95		'other{items}}.',
96		string $greaterThanMaxMessage = 'This value must contain at most {max, number} {max, plural, one{item} ' .
97		'other{items}}.',
98		string $notExactlyMessage = 'This value must contain exactly {exactly, number} {exactly, plural, one{item} ' .
99		'other{items}}.',
100		private mixed $skipOnEmpty = null,
101	1	private bool $skipOnError = false,
102		private Closure\|null $when = null,
103	1	) {
104		$this->initLimitProperties(
105		$min,
106	5	$max,
107		$exactly,
108	5	$lessThanMinMessage,
109		$greaterThanMaxMessage,
110		$notExactlyMessage
111	1	);
112		}
113	1
114		public function getName(): string
115	1	{
116		return 'count';
117		}
118	1
119	1	/**
120		* Get error message used when the value is neither an array nor an object implementing {@see \Countable} interface.
121		*
122		* @return string Error message.
123	34	*
124		* @see $incorrectInputMessage
125	34	*/
126		public function getIncorrectInputMessage(): string
127		{
128		return $this->incorrectInputMessage;
129		}
130
131		public function getOptions(): array
132		{
133		return array_merge($this->getLimitOptions(), [
134		'incorrectInputMessage' => [
135		'template' => $this->getIncorrectInputMessage(),
136		'parameters' => [],
137		],
138		'skipOnEmpty' => $this->getSkipOnEmptyOption(),
139		'skipOnError' => $this->skipOnError,
140		]);
141		}
142
143		public function getHandler(): string
144		{
145		return CountHandler::class;
146		}
147		}
148

yiisoft / validator

Pull Request — master (#464)

Count::getObjectValidated() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like