Email::__construct() - Code Metrics - Inspection of "[Coverage] Rules" - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#369)

unknown

created 2022-11-15 15:00 UTC

Email::__construct() A

↳ Parent: Email

Complexity

Conditions	3
Paths	2

Size

Total Lines	58
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	0

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

How to fix Long Method Many Parameters

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Attribute;
use Closure;
use JetBrains\PhpStorm\Language;
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(
        #[Language('RegExp')]
        /**
         * @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])?$/',
        #[Language('RegExp')]
        /**
         * @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])?>$/',
        #[Language('RegExp')]
        /**
         * @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 $incorrectInputMessage = 'The value must have a string type.',
        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')) {
            // Tested via separate CI configuration (see ".github/workflows/build.yml").
            // @codeCoverageIgnoreStart
            throw new RuntimeException('In order to use IDN validation intl extension must be installed and enabled.');
            // @codeCoverageIgnoreEnd
        }
    }

    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 getIncorrectInputMessage(): string
    {
        return $this->incorrectInputMessage;
    }

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

yiisoft / validator

Pull Request — master (#369)

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