Email::getOptions() - Code Metrics - Inspection of "Add phpdoc for Email and EmailHandler" - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#477)

by Alexander

created 2022-12-20 20:54 UTC

Email::getOptions() A

↳ Parent: Email

Complexity

Conditions	1
Paths	1

Size

Total Lines	19
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	15
nc	1
nop	0
dl	0
loc	19
ccs	0
cts	0
cp	0
crap	2
rs	9.7666
c	0
b	0
f	0

<?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\RuleWithOptionsInterface;
use Yiisoft\Validator\SkipOnEmptyInterface;
use Yiisoft\Validator\SkipOnErrorInterface;
use Yiisoft\Validator\WhenInterface;

use function function_exists;

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

    /**
     * @param string $pattern The regular expression used to validate the value. See {@link https://www.regular-expressions.info/email.html}.
     * @param string $fullPattern The regular expression used to validate email addresses with the name part.
     * This property is used only when {@see $allowName} is `true`.
     * @param string $idnEmailPattern The regular expression used to validate complex emails when {@see $enableIdn} is `true`.
     * @param bool $allowName bool Whether to allow a name in the email address (e.g. "John Smith <[email protected]>").
     * Defaults to `false`. See {@see $fullPattern}.
     * @param bool $checkDns bool Whether to check 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`.
     * @param bool $enableIdn Whether validation process should take IDN (internationalized domain names) into account.
     * 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.
     * @param string $incorrectInputMessage A message used when the input is incorrect.
     *
     * You may use the following placeholders in the message:
     *
     * - `{attribute}`: the label of the attribute being validated.
     * - `{type}`: the type of the attribute being validated.
     * @param string $message A message used when the value is not valid.
     *
     * You may use the following placeholders in the message:
     *
     * - `{attribute}`: the label of the attribute being validated.
     * - `{value}`: the value of the attribute being validated.
     * @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(
        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])?$/',
        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])?>$/',
        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})(\]?)$/',
        private bool $allowName = false,
        private bool $checkDns = false,
        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.',
        private $skipOnEmpty = null,
        private bool $skipOnError = false,
        private Closure|null $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';
    }

    /**
     * Get the regular expression used to validate the value.
     *
     * @return string The regular expression.
     *
     * @see $pattern
     */
    public function getPattern(): string
    {
        return $this->pattern;
    }

    /**
     * Get the regular expression used to validate email addresses with the name part.
     *
     * @return string The regular expression.
     *
     * @see $fullPattern
     */
    public function getFullPattern(): string
    {
        return $this->fullPattern;
    }

    /**
     * Get the regular expression used to validate complex emails when {@see $enableIdn} is `true`.
     *
     * @return string The regular expression.
     *
     * @see $idnEmailPattern
     */
    public function getIdnEmailPattern(): string
    {
        return $this->idnEmailPattern;
    }

    /**
     * Whether to allow a name in the email address (e.g. "John Smith <[email protected]>").
     *
     * @return bool Whether to allow a name in the email address.
     *
     * @see $allowName
     */
    public function isNameAllowed(): bool
    {
        return $this->allowName;
    }

    /**
     * Whether to check email's domain exists and has either an A or MX record.
     *
     * @return bool Whether to check email's domain exists and has either an A or MX record.
     *
     * @see $checkDns
     */
    public function shouldCheckDns(): bool
    {
        return $this->checkDns;
    }

    /**
     * Whether validation process should take IDN (internationalized domain names) into account.
     *
     * @return bool Whether validation process should take IDN (internationalized domain names) into account.
     *
     * @see $enableIdn
     */
    public function isIdnEnabled(): bool
    {
        return $this->enableIdn;
    }

    /**
     * Get a message used when the input is incorrect.
     *
     * @return string A message used when the input is incorrect.
     *
     * @see $incorrectInputMessage
     */
    public function getIncorrectInputMessage(): string
    {
        return $this->incorrectInputMessage;
    }

    /**
     * Get a message used when the value is not valid.
     *
     * @return string A message used when the value is not valid.
     *
     * @see $message
     */
    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' => [
                'template' => $this->incorrectInputMessage,
                'parameters' => [],
            ],
            'message' => [
                'template' => $this->message,
                'parameters' => [],
            ],
            'skipOnEmpty' => $this->getSkipOnEmptyOption(),
            'skipOnError' => $this->skipOnError,
        ];
    }

    public function getHandler(): 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\RuleWithOptionsInterface;
14		use Yiisoft\Validator\SkipOnEmptyInterface;
15		use Yiisoft\Validator\SkipOnErrorInterface;
16		use Yiisoft\Validator\WhenInterface;
17
18		use function function_exists;
19
20		/**
21		* Validates that the value is a valid email address.
22		*
23		* @psalm-import-type WhenType from WhenInterface
24		*/
25		#[Attribute(Attribute::TARGET_PROPERTY \| Attribute::IS_REPEATABLE)]
26		final class Email implements RuleWithOptionsInterface, SkipOnErrorInterface, WhenInterface, SkipOnEmptyInterface
27		{
28		use SkipOnEmptyTrait;
29		use SkipOnErrorTrait;
30		use WhenTrait;
31
32	3	/**
33		* @param string $pattern The regular expression used to validate the value. See {@link https://www.regular-expressions.info/email.html}.
34		* @param string $fullPattern The regular expression used to validate email addresses with the name part.
35		* This property is used only when {@see $allowName} is `true`.
36		* @param string $idnEmailPattern The regular expression used to validate complex emails when {@see $enableIdn} is `true`.
37		* @param bool $allowName bool Whether to allow a name in the email address (e.g. "John Smith <[email protected]>").
38		* Defaults to `false`. See {@see $fullPattern}.
39		* @param bool $checkDns bool Whether to check email's domain exists and has either an A or MX record.
40		* Be aware that this check can fail due to temporary DNS problems even if the email address is
41		* valid and an email would be deliverable. Defaults to `false`.
42		* @param bool $enableIdn Whether validation process should take IDN (internationalized domain names) into account.
43		* Defaults to false meaning that validation of emails containing IDN will always fail.
44		* Note that in order to use IDN validation you have to install and enable `intl` PHP extension,
45		* otherwise an exception would be thrown.
46		* @param string $incorrectInputMessage A message used when the input is incorrect.
47		*
48		* You may use the following placeholders in the message:
49		*
50		* - `{attribute}`: the label of the attribute being validated.
51		* - `{type}`: the type of the attribute being validated.
52		* @param string $message A message used when the value is not valid.
53		*
54		* You may use the following placeholders in the message:
55		*
56		* - `{attribute}`: the label of the attribute being validated.
57		* - `{value}`: the value of the attribute being validated.
58		* @param bool\|callable\|null $skipOnEmpty Whether to skip this rule if the value validated is empty. See {@see SkipOnEmptyInterface}.
59		* @param bool $skipOnError Whether to skip this rule if any of the previous rules gave an error. See {@see SkipOnErrorInterface}.
60		* @param Closure\|null $when A callable to define a condition for applying the rule. See {@see WhenInterface}.
61		* @psalm-param WhenType $when
62		*/
63		public function __construct(
64		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])?$/',
65		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])?>$/',
66		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})(\]?)$/',
67		private bool $allowName = false,
68		private bool $checkDns = false,
69		private bool $enableIdn = false,
70		private string $incorrectInputMessage = 'The value must have a string type.',
71		private string $message = 'This value is not a valid email address.',
72		private $skipOnEmpty = null,
73		private bool $skipOnError = false,
74		private Closure\|null $when = null,
75		) {
76		if ($enableIdn && !function_exists('idn_to_ascii')) {
77		// Tested via separate CI configuration (see ".github/workflows/build.yml").
78		// @codeCoverageIgnoreStart
79		throw new RuntimeException('In order to use IDN validation intl extension must be installed and enabled.');
80		// @codeCoverageIgnoreEnd
81		}
82		}
83
84		public function getName(): string
85		{
86	3	return 'email';
87		}
88
89		/**
90		* Get the regular expression used to validate the value.
91		*
92		* @return string The regular expression.
93		*
94	1	* @see $pattern
95		*/
96	1	public function getPattern(): string
97		{
98		return $this->pattern;
99	83	}
100
101	83	/**
102		* Get the regular expression used to validate email addresses with the name part.
103		*
104	20	* @return string The regular expression.
105		*
106	20	* @see $fullPattern
107		*/
108		public function getFullPattern(): string
109	10	{
110		return $this->fullPattern;
111	10	}
112
113		/**
114	48	* Get the regular expression used to validate complex emails when {@see $enableIdn} is `true`.
115		*
116	48	* @return string The regular expression.
117		*
118		* @see $idnEmailPattern
119	48	*/
120		public function getIdnEmailPattern(): string
121	48	{
122		return $this->idnEmailPattern;
123		}
124	94
125		/**
126	94	* Whether to allow a name in the email address (e.g. "John Smith <[email protected]>").
127		*
128		* @return bool Whether to allow a name in the email address.
129	5	*
130		* @see $allowName
131	5	*/
132		public function isNameAllowed(): bool
133		{
134	49	return $this->allowName;
135		}
136	49
137		/**
138		* Whether to check email's domain exists and has either an A or MX record.
139	4	*
140		* @return bool Whether to check email's domain exists and has either an A or MX record.
141		*
142	4	* @see $checkDns
143	4	*/
144	4	public function shouldCheckDns(): bool
145	4	{
146	4	return $this->checkDns;
147	4	}
148
149	4	/**
150		* Whether validation process should take IDN (internationalized domain names) into account.
151		*
152		* @return bool Whether validation process should take IDN (internationalized domain names) into account.
153	4	*
154		* @see $enableIdn
155		*/
156	4	public function isIdnEnabled(): bool
157	4	{
158		return $this->enableIdn;
159		}
160
161	99	/**
162		* Get a message used when the input is incorrect.
163	99	*
164		* @return string A message used when the input is incorrect.
165		*
166		* @see $incorrectInputMessage
167		*/
168		public function getIncorrectInputMessage(): string
169		{
170		return $this->incorrectInputMessage;
171		}
172
173		/**
174		* Get a message used when the value is not valid.
175		*
176		* @return string A message used when the value is not valid.
177		*
178		* @see $message
179		*/
180		public function getMessage(): string
181		{
182		return $this->message;
183		}
184
185		public function getOptions(): array
186		{
187		return [
188		'pattern' => $this->pattern,
189		'fullPattern' => $this->fullPattern,
190		'idnEmailPattern' => $this->idnEmailPattern,
191		'allowName' => $this->allowName,
192		'checkDns' => $this->checkDns,
193		'enableIdn' => $this->enableIdn,
194		'incorrectInputMessage' => [
195		'template' => $this->incorrectInputMessage,
196		'parameters' => [],
197		],
198		'message' => [
199		'template' => $this->message,
200		'parameters' => [],
201		],
202		'skipOnEmpty' => $this->getSkipOnEmptyOption(),
203		'skipOnError' => $this->skipOnError,
204		];
205		}
206
207		public function getHandler(): string
208		{
209		return EmailHandler::class;
210		}
211		}
212

yiisoft / validator

Pull Request — master (#477)

Email::getOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like