class MultipleValidationWithAnd
Hierarchy
- class \Egulias\EmailValidator\Validation\MultipleValidationWithAnd implements \Egulias\EmailValidator\Validation\EmailValidation
Expanded class hierarchy of MultipleValidationWithAnd
File
-
vendor/
egulias/ email-validator/ src/ Validation/ MultipleValidationWithAnd.php, line 11
Namespace
Egulias\EmailValidator\ValidationView source
class MultipleValidationWithAnd implements EmailValidation {
/**
* If one of validations fails, the remaining validations will be skipped.
* This means MultipleErrors will only contain a single error, the first found.
*/
public const STOP_ON_ERROR = 0;
/**
* All of validations will be invoked even if one of them got failure.
* So MultipleErrors will contain all causes.
*/
public const ALLOW_ALL_ERRORS = 1;
/**
* @var Warning[]
*/
private $warnings = [];
/**
* @var MultipleErrors|null
*/
private $error;
/**
* @param EmailValidation[] $validations The validations.
* @param int $mode The validation mode (one of the constants).
*/
public function __construct(array $validations, int $mode = self::ALLOW_ALL_ERRORS) {
if (count($validations) == 0) {
throw new EmptyValidationList();
}
}
/**
* {@inheritdoc}
*/
public function isValid(string $email, EmailLexer $emailLexer) : bool {
$result = true;
foreach ($this->validations as $validation) {
$emailLexer->reset();
$validationResult = $validation->isValid($email, $emailLexer);
$result = $result && $validationResult;
$this->warnings = [
$this->warnings,
$validation->getWarnings(),
];
if (!$validationResult) {
$this->processError($validation);
}
if ($this->shouldStop($result)) {
break;
}
}
return $result;
}
private function initErrorStorage() : void {
if (null === $this->error) {
$this->error = new MultipleErrors();
}
}
private function processError(EmailValidation $validation) : void {
if (null !== $validation->getError()) {
$this->initErrorStorage();
/** @psalm-suppress PossiblyNullReference */
$this->error
->addReason($validation->getError()
->reason());
}
}
private function shouldStop(bool $result) : bool {
return !$result && $this->mode === self::STOP_ON_ERROR;
}
/**
* Returns the validation errors.
*/
public function getError() : ?InvalidEmail {
return $this->error;
}
/**
* @return Warning[]
*/
public function getWarnings() : array {
return $this->warnings;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
MultipleValidationWithAnd::$error | private | property | ||
MultipleValidationWithAnd::$warnings | private | property | ||
MultipleValidationWithAnd::ALLOW_ALL_ERRORS | public | constant | All of validations will be invoked even if one of them got failure. So MultipleErrors will contain all causes. |
|
MultipleValidationWithAnd::getError | public | function | Returns the validation errors. | Overrides EmailValidation::getError |
MultipleValidationWithAnd::getWarnings | public | function | Overrides EmailValidation::getWarnings | |
MultipleValidationWithAnd::initErrorStorage | private | function | ||
MultipleValidationWithAnd::isValid | public | function | Returns true if the given email is valid. | Overrides EmailValidation::isValid |
MultipleValidationWithAnd::processError | private | function | ||
MultipleValidationWithAnd::shouldStop | private | function | ||
MultipleValidationWithAnd::STOP_ON_ERROR | public | constant | If one of validations fails, the remaining validations will be skipped. This means MultipleErrors will only contain a single error, the first found. |
|
MultipleValidationWithAnd::__construct | public | function |