HasLength::__construct() - Code Metrics - Inspection of "In `RuleInterface` replace `getHandlerClassName():..." - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#468)

by Sergei

created 2022-12-16 08:48 UTC

HasLength::__construct() A

↳ Parent: HasLength

Complexity

Conditions	1
Paths	1

Size

Total Lines	59
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes

Metric	Value
eloc	7
c	0
b	0
f	0
dl	0
loc	59
ccs	1
cts	1
cp	1
rs	10
cc	1
nc	1
nop	11
crap	1

How to fix Long Method Many Parameters

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Attribute;
use Closure;
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;

/**
 * Validates that the value is of certain length.
 *
 * Note, this rule should only be used with strings.
 *
 * @psalm-import-type WhenType from WhenInterface
 */
#[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
final class HasLength implements
    RuleWithOptionsInterface,
    SkipOnErrorInterface,
    WhenInterface,
    SkipOnEmptyInterface,
    LimitInterface
{
    use LimitTrait;
    use SkipOnEmptyTrait;
    use SkipOnErrorTrait;
    use WhenTrait;

    public function __construct(
        /**
         * @var int|null minimum length. null means no minimum length limit. Can't be combined with
         * {@see $exactly}.
         *
         * @see $lessThanMinMessage for the customized message for a too short string.
         */
        int|null $min = null,
        /**
         * @var int|null maximum length. null means no maximum length limit. Can't be combined with
         * {@see $exactly}.
         *
         * @see $greaterThanMaxMessage for the customized message for a too long string.
         */
        int|null $max = null,
        /**
         * @var int|null exact length. `null` means no strict comparison. Mutually exclusive with {@see $min} and
         * {@see $max}.
         */
        int|null $exactly = null,
        /**
         * @var string user-defined error message used when the value is not a string.
         */
        private string $incorrectInputMessage = 'This value must be a string.',
        /**
         * @var string user-defined error message used when the length of the value is smaller than {@see $min}.
         */
        string $lessThanMinMessage = 'This value must contain at least {min, number} {min, plural, one{character} ' .
        'other{characters}}.',
        /**
         * @var string user-defined error message used when the length of the value is greater than {@see $max}.
         */
        string $greaterThanMaxMessage = 'This value must contain at most {max, number} {max, plural, one{character} ' .
        'other{characters}}.',
        string $notExactlyMessage = 'This value must contain exactly {exactly, number} {exactly, plural, ' .
        'one{character} other{characters}}.',
        /**
         * @var string the encoding of the string value to be validated (e.g. 'UTF-8').
         * If this property is not set, application wide encoding will be used.
         */
        private string $encoding = 'UTF-8',


        /**
         * @var bool|callable|null
         */
        private $skipOnEmpty = null,
        private bool $skipOnError = false,
        /**
         * @var WhenType
         */
        private Closure|null $when = null
    ) {
        $this->initLimitProperties(
            $min,
            $max,
            $exactly,
            $lessThanMinMessage,
            $greaterThanMaxMessage,
            $notExactlyMessage
        );
    }

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

    public function getIncorrectInputMessage(): string
    {
        return $this->incorrectInputMessage;
    }

    public function getEncoding(): string
    {
        return $this->encoding;
    }

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

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


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Validator\Rule;
6
7		use Attribute;
8		use Closure;
9		use Yiisoft\Validator\LimitInterface;
10		use Yiisoft\Validator\Rule\Trait\LimitTrait;
11		use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
12		use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
13		use Yiisoft\Validator\Rule\Trait\WhenTrait;
14		use Yiisoft\Validator\RuleWithOptionsInterface;
15		use Yiisoft\Validator\SkipOnEmptyInterface;
16		use Yiisoft\Validator\SkipOnErrorInterface;
17		use Yiisoft\Validator\WhenInterface;
18
19		/**
20		* Validates that the value is of certain length.
21		*
22		* Note, this rule should only be used with strings.
23		*
24		* @psalm-import-type WhenType from WhenInterface
25		*/
26		#[Attribute(Attribute::TARGET_PROPERTY \| Attribute::IS_REPEATABLE)]
27		final class HasLength implements
28		RuleWithOptionsInterface,
29		SkipOnErrorInterface,
30		WhenInterface,
31		SkipOnEmptyInterface,
32		LimitInterface
33		{
34		use LimitTrait;
35		use SkipOnEmptyTrait;
36		use SkipOnErrorTrait;
37		use WhenTrait;
38	34
39		public function __construct(
40		/**
41		* @var int\|null minimum length. null means no minimum length limit. Can't be combined with
42		* {@see $exactly}.
43		*
44		* @see $lessThanMinMessage for the customized message for a too short string.
45		*/
46		int\|null $min = null,
47		/**
48		* @var int\|null maximum length. null means no maximum length limit. Can't be combined with
49		* {@see $exactly}.
50		*
51		* @see $greaterThanMaxMessage for the customized message for a too long string.
52		*/
53		int\|null $max = null,
54		/**
55		* @var int\|null exact length. `null` means no strict comparison. Mutually exclusive with {@see $min} and
56		* {@see $max}.
57		*/
58		int\|null $exactly = null,
59		/**
60		* @var string user-defined error message used when the value is not a string.
61		*/
62		private string $incorrectInputMessage = 'This value must be a string.',
63		/**
64		* @var string user-defined error message used when the length of the value is smaller than {@see $min}.
65		*/
66		string $lessThanMinMessage = 'This value must contain at least {min, number} {min, plural, one{character} ' .
67		'other{characters}}.',
68		/**
69		* @var string user-defined error message used when the length of the value is greater than {@see $max}.
70		*/
71		string $greaterThanMaxMessage = 'This value must contain at most {max, number} {max, plural, one{character} ' .
72		'other{characters}}.',
73		string $notExactlyMessage = 'This value must contain exactly {exactly, number} {exactly, plural, ' .
74		'one{character} other{characters}}.',
75		/**
76		* @var string the encoding of the string value to be validated (e.g. 'UTF-8').
77		* If this property is not set, application wide encoding will be used.
78		*/
79		private string $encoding = 'UTF-8',
80
		0 ignored issues – show Coding Style introduced 2022-12-01 11:29 UTC by Report Bug Copy Issue Report Blank lines are not allowed in a multi-line function declaration Loading history...
81		/**
82		* @var bool\|callable\|null
83		*/
84		private $skipOnEmpty = null,
85		private bool $skipOnError = false,
86		/**
87		* @var WhenType
88		*/
89		private Closure\|null $when = null
90	34	) {
91		$this->initLimitProperties(
92		$min,
93		$max,
94		$exactly,
95		$lessThanMinMessage,
96		$greaterThanMaxMessage,
97		$notExactlyMessage
98		);
99		}
100	3
101		public function getName(): string
102	3	{
103		return 'hasLength';
104		}
105	7
106		public function getIncorrectInputMessage(): string
107	7	{
108		return $this->incorrectInputMessage;
109		}
110	69
111		public function getEncoding(): string
112	69	{
113		return $this->encoding;
114		}
115	5
116		public function getOptions(): array
117	5	{
118		return array_merge($this->getLimitOptions(), [
119	5	'incorrectInputMessage' => [
120		'template' => $this->incorrectInputMessage,
121		'parameters' => [],
122	5	],
123	5	'encoding' => $this->encoding,
124	5	'skipOnEmpty' => $this->getSkipOnEmptyOption(),
125		'skipOnError' => $this->skipOnError,
126		]);
127		}
128	76
129		public function getHandler(): string
130	76	{
131		return HasLengthHandler::class;
132		}
133		}
134

yiisoft / validator

Pull Request — master (#468)

HasLength::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Many Parameters

Long Method

Many Parameters

Duplication Side-by-Side

Filter issues like