Email::__construct() - Code Metrics - Inspection of "Remove `RuleNameTrait`" - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#333)

by Sergei

created 2022-10-09 10:12 UTC

Email::__construct() A

↳ Parent: Email

Complexity

Conditions	3
Paths	2

Size

Total Lines	52
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	3.3332

Importance

Changes

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

How to fix Long Method Many Parameters

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Attribute;
use Closure;
use RuntimeException;
use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
use Yiisoft\Validator\Rule\Trait\WhenTrait;
use Yiisoft\Validator\SerializableRuleInterface;
use Yiisoft\Validator\SkipOnEmptyInterface;
use Yiisoft\Validator\SkipOnErrorInterface;
use Yiisoft\Validator\ValidationContext;
use Yiisoft\Validator\WhenInterface;

use function function_exists;

/**
 * Validates that the value is a valid email address.
 */
#[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
final class Email implements SerializableRuleInterface, SkipOnErrorInterface, WhenInterface, SkipOnEmptyInterface
{
    use SkipOnEmptyTrait;
    use SkipOnErrorTrait;
    use WhenTrait;

    public function __construct(
        /**
         * @var string the regular expression used to validate value.
         *
         * @link http://www.regular-expressions.info/email.html
         */
        private string $pattern = '/^[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$/',
        /**
         * @var string the regular expression used to validate email addresses with the name part. This property is used
         * only when {@see $allowName} is `true`.
         *
         * @see $allowName
         */
        private string $fullPattern = '/^[^@]*<[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?>$/',
        /**
         * @var string the regular expression used to validate complex emails when {@see $enableIDN} is `true`.
         */
        private string $idnEmailPattern = '/^([a-zA-Z0-9._%+-]+)@((\[\d{1,3}\.\d{1,3}\.\d{1,3}\.)|(([\w-]+\.)+))([a-zA-Z]{2,4}|\d{1,3})(\]?)$/',
        /**
         * @var bool whether to allow name in the email address (e.g. "John Smith <[email protected]>"). Defaults
         * to `false`.
         *
         * @see $fullPattern
         */
        private bool $allowName = false,
        /**
         * @var bool whether to check whether the email's domain exists and has either an A or MX record.
         * Be aware that this check can fail due to temporary DNS problems even if the email address is
         * valid and an email would be deliverable. Defaults to `false`.
         */
        private bool $checkDNS = false,
        /**
         * @var bool whether validation process should take into account IDN (internationalized domain
         * names). Defaults to false meaning that validation of emails containing IDN will always fail.
         * Note that in order to use IDN validation you have to install and enable `intl` PHP extension,
         * otherwise an exception would be thrown.
         */
        private bool $enableIDN = false,
        private string $message = 'This value is not a valid email address.',

        /**
         * @var bool|callable|null
         */
        private $skipOnEmpty = null,
        private bool $skipOnError = false,
        /**
         * @var Closure(mixed, ValidationContext):bool|null
         */
        private ?Closure $when = null,
    ) {
        if ($enableIDN && !function_exists('idn_to_ascii')) {
            throw new RuntimeException('In order to use IDN validation intl extension must be installed and enabled.');
        }
    }

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

    public function getPattern(): string
    {
        return $this->pattern;
    }

    public function getFullPattern(): string
    {
        return $this->fullPattern;
    }

    public function getIdnEmailPattern(): string
    {
        return $this->idnEmailPattern;
    }

    public function isAllowName(): bool
    {
        return $this->allowName;
    }

    public function isCheckDNS(): bool
    {
        return $this->checkDNS;
    }

    public function isEnableIDN(): bool
    {
        return $this->enableIDN;
    }

    public function getMessage(): string
    {
        return $this->message;
    }

    public function getOptions(): array
    {
        return [
            'pattern' => $this->pattern,
            'fullPattern' => $this->fullPattern,
            'idnEmailPattern' => $this->idnEmailPattern,
            'allowName' => $this->allowName,
            'checkDNS' => $this->checkDNS,
            'enableIDN' => $this->enableIDN,
            'message' => [
                'message' => $this->message,
            ],
            'skipOnEmpty' => $this->getSkipOnEmptyOption(),
            'skipOnError' => $this->skipOnError,
        ];
    }

    public function getHandlerClassName(): string
    {
        return EmailHandler::class;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Validator\Rule;
6
7		use Attribute;
8		use Closure;
9		use RuntimeException;
10		use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
11		use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
12		use Yiisoft\Validator\Rule\Trait\WhenTrait;
13		use Yiisoft\Validator\SerializableRuleInterface;
14		use Yiisoft\Validator\SkipOnEmptyInterface;
15		use Yiisoft\Validator\SkipOnErrorInterface;
16		use Yiisoft\Validator\ValidationContext;
17		use Yiisoft\Validator\WhenInterface;
18
19		use function function_exists;
20
21		/**
22		* Validates that the value is a valid email address.
23		*/
24		#[Attribute(Attribute::TARGET_PROPERTY \| Attribute::IS_REPEATABLE)]
25		final class Email implements SerializableRuleInterface, SkipOnErrorInterface, WhenInterface, SkipOnEmptyInterface
26		{
27		use SkipOnEmptyTrait;
28		use SkipOnErrorTrait;
29		use WhenTrait;
30
31	2	public function __construct(
32		/**
33		* @var string the regular expression used to validate value.
34		*
35		* @link http://www.regular-expressions.info/email.html
36		*/
37		private string $pattern = '/^[a-zA-Z0-9!#$%&\'+\\/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&\'+\\/=?^_`{\|}~-]+)@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-][a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$/',
38		/**
39		* @var string the regular expression used to validate email addresses with the name part. This property is used
40		* only when {@see $allowName} is `true`.
41		*
42		* @see $allowName
43		*/
44		private string $fullPattern = '/^[^@]<[a-zA-Z0-9!#$%&\'+\\/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&\'+\\/=?^_`{\|}~-]+)@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-][a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-][a-zA-Z0-9])?>$/',
45		/**
46		* @var string the regular expression used to validate complex emails when {@see $enableIDN} is `true`.
47		*/
48		private string $idnEmailPattern = '/^([a-zA-Z0-9._%+-]+)@((\[\d{1,3}\.\d{1,3}\.\d{1,3}\.)\|(([\w-]+\.)+))([a-zA-Z]{2,4}\|\d{1,3})(\]?)$/',
49		/**
50		* @var bool whether to allow name in the email address (e.g. "John Smith <[email protected]>"). Defaults
51		* to `false`.
52		*
53		* @see $fullPattern
54		*/
55		private bool $allowName = false,
56		/**
57		* @var bool whether to check whether the email's domain exists and has either an A or MX record.
58		* Be aware that this check can fail due to temporary DNS problems even if the email address is
59		* valid and an email would be deliverable. Defaults to `false`.
60		*/
61		private bool $checkDNS = false,
62		/**
63		* @var bool whether validation process should take into account IDN (internationalized domain
64		* names). Defaults to false meaning that validation of emails containing IDN will always fail.
65		* Note that in order to use IDN validation you have to install and enable `intl` PHP extension,
66		* otherwise an exception would be thrown.
67		*/
68		private bool $enableIDN = false,
69		private string $message = 'This value is not a valid email address.',
70
71		/**
72		* @var bool\|callable\|null
73		*/
74		private $skipOnEmpty = null,
75		private bool $skipOnError = false,
76		/**
77		* @var Closure(mixed, ValidationContext):bool\|null
78		*/
79		private ?Closure $when = null,
80		) {
81	2	if ($enableIDN && !function_exists('idn_to_ascii')) {
82		throw new RuntimeException('In order to use IDN validation intl extension must be installed and enabled.');
83		}
84		}
85
86	1	public function getName(): string
87		{
88	1	return 'email';
89		}
90
91	73	public function getPattern(): string
92		{
93	73	return $this->pattern;
94		}
95
96	20	public function getFullPattern(): string
97		{
98	20	return $this->fullPattern;
99		}
100
101	10	public function getIdnEmailPattern(): string
102		{
103	10	return $this->idnEmailPattern;
104		}
105
106	47	public function isAllowName(): bool
107		{
108	47	return $this->allowName;
109		}
110
111	39	public function isCheckDNS(): bool
112		{
113	39	return $this->checkDNS;
114		}
115
116	83	public function isEnableIDN(): bool
117		{
118	83	return $this->enableIDN;
119		}
120
121	45	public function getMessage(): string
122		{
123	45	return $this->message;
124		}
125
126	4	public function getOptions(): array
127		{
128		return [
129	4	'pattern' => $this->pattern,
130	4	'fullPattern' => $this->fullPattern,
131	4	'idnEmailPattern' => $this->idnEmailPattern,
132	4	'allowName' => $this->allowName,
133	4	'checkDNS' => $this->checkDNS,
134	4	'enableIDN' => $this->enableIDN,
135		'message' => [
136	4	'message' => $this->message,
137		],
138	4	'skipOnEmpty' => $this->getSkipOnEmptyOption(),
139	4	'skipOnError' => $this->skipOnError,
140		];
141		}
142
143	1	public function getHandlerClassName(): string
144		{
145	1	return EmailHandler::class;
146		}
147		}
148

yiisoft / validator

Pull Request — master (#333)

Email::__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