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: 

<?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 phone number only by removing all other characters 
 *                 than digits and plus. To validate phone number really deeply
 *                 by local conventions, use Zend validator instead.
 * @see https://github.com/zendframework/zend-i18n
 * @see https://github.com/zendframework/zend-i18n/blob/master/src/Validator/PhoneNumber.php
 * @see https://olegkrivtsov.github.io/using-zend-framework-3-book/html/en/Checking_Input_Data_with_Validators/Validator_Usage_Examples.html#Example
 */
class Tel extends \MvcCore\Ext\Forms\Validator {

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

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

    /**
     * Validate phone number only by removing all other characters than digits and plus.
     * To validate phone number really deeply - use Zend validator instead:
     * @see https://github.com/zendframework/zend-i18n
     * @see https://github.com/zendframework/zend-i18n/blob/master/src/Validator/PhoneNumber.php
     * @see https://olegkrivtsov.github.io/using-zend-framework-3-book/html/en/Checking_Input_Data_with_Validators/Validator_Usage_Examples.html#Example
     * @param string|array          $rawSubmittedValue
     * @return string|array|NULL    Safe submitted value or `NULL` if not possible to return safe value.
     */
    public function Validate ($rawSubmittedValue) {
        // remove spaces
        $rawSubmittedValue = str_replace(' ', '', (string) $rawSubmittedValue);
        // eliminate every char except 0-9 and +
        $result = preg_replace("#[^0-9\+]#", '', $rawSubmittedValue);
        $resultLength = mb_strlen($result);
        if ($resultLength === 0) return NULL;
        // add error if result is an empty string or if there was any other characters than numbers and plus.
        if ($resultLength && $resultLength !== mb_strlen($rawSubmittedValue)) 
            $this->field->AddValidationError(
                 static::GetErrorMessage(self::ERROR_PHONE) 
            );
        return $result;
    }
}