Merge pull request #20 from daveearley/more-php7.4-updates

php 7.4 updates

Author: daveearley

src/EmailValidator.php

@@ -66,7 +66,7 @@ public function getValidationResults(): ValidationResults
         return $this->validationResults;
     }
 
-    public function runValidation()
+    public function runValidation(): void
     {
         foreach ($this->registeredValidators as $validator) {
             $this->validationResults->addResult($validator->getValidatorName(), $validator->getResultResponse());

src/EmailValidatorFactory.php

@@ -16,7 +16,7 @@
 class EmailValidatorFactory
 {
     /** @var Validator[] */
-    private static array $defaultValidators = [
+    protected static array $defaultValidators = [
         ValidFormatValidator::class,
         MxRecordsValidator::class,
         MisspelledEmailValidator::class,

src/Validations/MisspelledEmailValidator.php

@@ -9,20 +9,14 @@
  */
 class MisspelledEmailValidator extends Validator implements ValidatorInterface
 {
-    const MINIMUM_WORD_DISTANCE_DOMAIN = 2;
-    const MINIMUM_WORD_DISTANCE_TLD = 1;
+    private const MINIMUM_WORD_DISTANCE_DOMAIN = 2;
+    private const MINIMUM_WORD_DISTANCE_TLD = 1;
 
-    /**
-     * @return string
-     */
     public function getValidatorName(): string
     {
         return 'possible_email_correction'; // @codeCoverageIgnore
     }
 
-    /**
-     * @return string
-     */
     public function getResultResponse(): string
     {
         if (!$this->getEmailAddress()->isValidEmailAddressFormat()) {
@@ -76,12 +70,6 @@ private function findDomainSuggestion()
         return $domain === $possibleMatch ? null : $possibleMatch;
     }
 
-    /**
-     * @param string $stringToCheck
-     * @param array $wordsToCheck
-     * @param int $minimumDistance
-     * @return string|bool
-     */
     private function findClosestWord(string $stringToCheck, array $wordsToCheck, int $minimumDistance): string
     {
         if (in_array($stringToCheck, $wordsToCheck)) {

src/Validations/Validator.php

@@ -10,53 +10,33 @@
 
 abstract class Validator
 {
-    /** @var EmailAddress */
-    private $emailAddress;
+    private ?EmailAddress $emailAddress;
 
-    /** @var EmailDataProvider|null */
-    private $emailDataProvider;
+    private ?EmailDataProvider $emailDataProvider;
 
-    /**
-     * @param EmailAddress $emailAddress
-     * @param EmailDataProviderInterface $emailDataProvider
-     */
     public function __construct(EmailAddress $emailAddress = null, EmailDataProviderInterface $emailDataProvider = null)
     {
         $this->emailAddress = $emailAddress;
         $this->emailDataProvider = $emailDataProvider;
     }
 
-    /**
-     * @return EmailAddress
-     */
     public function getEmailAddress(): EmailAddress
     {
         return $this->emailAddress;
     }
 
-    /**
-     * @param EmailAddress $emailAddress
-     * @return $this
-     */
-    public function setEmailAddress(EmailAddress $emailAddress)
+    public function setEmailAddress(EmailAddress $emailAddress): Validator
     {
         $this->emailAddress = $emailAddress;
         return $this;
     }
 
-    /**
-     * @return EmailDataProviderInterface
-     */
     public function getEmailDataProvider(): EmailDataProviderInterface
     {
         return $this->emailDataProvider;
     }
 
-    /**
-     * @param EmailDataProviderInterface|null $emailDataProvider
-     * @return $this
-     */
-    public function setEmailDataProvider(EmailDataProviderInterface $emailDataProvider)
+    public function setEmailDataProvider(EmailDataProviderInterface $emailDataProvider): Validator
     {
         $this->emailDataProvider = $emailDataProvider;
         return $this;