1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view 
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
 * @license     https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
 */

namespace MvcCore\Ext\Forms\Validators;

/**
 * Responsibility: Validate single email format or multiple emails formats, 
 *                 if field has defined `multiple` boolean attribute.
 */
class       Email 
extends     \MvcCore\Ext\Forms\Validator
implements  \MvcCore\Ext\Forms\Fields\IMultiple {

    use \MvcCore\Ext\Forms\Field\Props\Multiple;

    /**
     * Error message index(es).
     * @var int
     */
    const ERROR_EMAIL = 0;

    /**
     * Validation failure message template definitions.
     * @var array
     */
    protected static $errorMessages = [
        self::ERROR_EMAIL   => "Field '{0}' requires a valid email address.",
    ];

    /**
     * Field specific values (camel case) and their validator default values.
     * @var array
     */
    protected static $fieldSpecificProperties = [
        'multiple'  => NULL,
    ];

    /**
     * Validate URI string by regular expression.
     * @see https://github.com/nette/utils/blob/72d8f087e7d750521a15e0b25b7a4f6d20ed45dc/src/Utils/Validators.php#L308
     * @param string|array $rawSubmittedValue Raw submitted value from user.
     * @return string|\string[]|NULL Safe submitted string value or array of string for `multiple` attribute defined or `NULL` if not possible to return safe value.
     */
    public function Validate ($rawSubmittedValue) {
        $rawSubmittedValue = trim((string) $rawSubmittedValue);
        if ($rawSubmittedValue === '') return NULL;
        if ($this->multiple) {
            $result = [];
            $rawValues = explode(',', $rawSubmittedValue);
        } else {
            $result = NULL;
            $rawValues = [$rawSubmittedValue];
        }
        $errorReported = FALSE;
        foreach ($rawValues as $rawValue) {
            $atom = "[-a-z0-9!#$%&'*+/=?^_`{|}~]"; // RFC 5322 unquoted characters in local-part
            $alpha = "a-z\x80-\xFF"; // superset of IDN
            $emailIsValid = (bool) preg_match(<<<XX
            (^
                ("([ !#-[\\]-~]*|\\\\[ -~])+"|{$atom}+(\\.{$atom}+)*)    # quoted or unquoted
                @
                ([0-9{$alpha}]([-0-9{$alpha}]{0,61}[0-9{$alpha}])?\\.)+  # domain - RFC 1034
                [{$alpha}]([-0-9{$alpha}]{0,17}[{$alpha}])?              # top domain
            $)Dix
XX
            , $rawValue);
            if ($emailIsValid) {
                if ($this->multiple) {
                    $result[] = $rawValue;
                } else {
                    $result = $rawValue;
                }
            } else {
                if (!$errorReported) {
                    $errorReported = TRUE;
                    $this->field->AddValidationError(
                        static::GetErrorMessage(self::ERROR_EMAIL)
                    );
                }
            }
        }
        return $result;
    }
}