yiisoft /
validator
| Conditions | 3 |
| Paths | 2 |
| Total Lines | 58 |
| Code Lines | 2 |
| Lines | 0 |
| Ratio | 0 % |
| Tests | 1 |
| CRAP Score | 3 |
| Changes | 0 | ||
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
Methods with many parameters are not only hard to understand, but their parameters also often become inconsistent when you need more, or different data.
There are several approaches to avoid long parameter lists:
| 1 | <?php |
||
| 33 | public function __construct( |
||
| 34 | #[Language('RegExp')] |
||
| 35 | /** |
||
| 36 | * @var string the regular expression used to validate value. |
||
| 37 | * |
||
| 38 | * @link https://www.regular-expressions.info/email.html |
||
| 39 | */ |
||
| 40 | 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])?$/', |
||
| 41 | #[Language('RegExp')] |
||
| 42 | /** |
||
| 43 | * @var string the regular expression used to validate email addresses with the name part. This property is used |
||
| 44 | * only when {@see $allowName} is `true`. |
||
| 45 | * |
||
| 46 | * @see $allowName |
||
| 47 | */ |
||
| 48 | 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])?>$/', |
||
| 49 | #[Language('RegExp')] |
||
| 50 | /** |
||
| 51 | * @var string the regular expression used to validate complex emails when {@see $enableIDN} is `true`. |
||
| 52 | */ |
||
| 53 | 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})(\]?)$/', |
||
| 54 | /** |
||
| 55 | * @var bool whether to allow name in the email address (e.g. "John Smith <[email protected]>"). Defaults |
||
| 56 | * to `false`. |
||
| 57 | * |
||
| 58 | * @see $fullPattern |
||
| 59 | */ |
||
| 60 | private bool $allowName = false, |
||
| 61 | /** |
||
| 62 | * @var bool whether to check whether the email's domain exists and has either an A or MX record. |
||
| 63 | * Be aware that this check can fail due to temporary DNS problems even if the email address is |
||
| 64 | * valid and an email would be deliverable. Defaults to `false`. |
||
| 65 | */ |
||
| 66 | private bool $checkDNS = false, |
||
| 67 | /** |
||
| 68 | * @var bool whether validation process should take into account IDN (internationalized domain |
||
| 69 | * names). Defaults to false meaning that validation of emails containing IDN will always fail. |
||
| 70 | * Note that in order to use IDN validation you have to install and enable `intl` PHP extension, |
||
| 71 | * otherwise an exception would be thrown. |
||
| 72 | */ |
||
| 73 | private bool $enableIDN = false, |
||
| 74 | private string $incorrectInputMessage = 'The value must have a string type.', |
||
| 75 | private string $message = 'This value is not a valid email address.', |
||
| 76 | |||
|
Coding Style
introduced
by
|
|||
| 77 | /** |
||
| 78 | * @var bool|callable|null |
||
| 79 | */ |
||
| 80 | private $skipOnEmpty = null, |
||
| 81 | private bool $skipOnError = false, |
||
| 82 | /** |
||
| 83 | * @var WhenType |
||
| 84 | */ |
||
| 85 | private Closure|null $when = null, |
||
| 86 | 3 | ) { |
|
| 87 | if ($enableIDN && !function_exists('idn_to_ascii')) { |
||
| 88 | // Tested via separate CI configuration (see ".github/workflows/build.yml"). |
||
| 89 | // @codeCoverageIgnoreStart |
||
| 90 | throw new RuntimeException('In order to use IDN validation intl extension must be installed and enabled.'); |
||
| 91 | // @codeCoverageIgnoreEnd |
||
| 167 |
Loading history...