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: 

<?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 minimum or maximum characters length in submitted
 *                 value by configured field `minlength` and `maxlength` HTML
 *                 attributes. To measure characters length in submitted value,
 *                 validator uses multi-byte string function `mb_strlen()`.
 */
class       MinMaxLength
extends     \MvcCore\Ext\Forms\Validator
implements  \MvcCore\Ext\Forms\Fields\IMinMaxLength {

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

    /**
     * Valid email address error message index.
     * @var int
     */
    const ERROR_MIN_LENGTH = 0;
    const ERROR_MAX_LENGTH = 1;

    /**
     * Validation failure message template definitions.
     * @var array
     */
    protected static $errorMessages = [
        self::ERROR_MIN_LENGTH  => "Field '{0}' requires at least {1} characters.",
        self::ERROR_MAX_LENGTH  => "Field '{0}' requires no more than {1} characters.",
    ];

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

    /**
     * Validate raw user input with maximum string length check.
     * @param string|array $submitValue Raw submitted value from user.
     * @return string|NULL Safe submitted value or `NULL` if not possible to return safe value.
     */
    public function Validate ($rawSubmittedValue) {
        $rawSubmittedValue = trim((string) $rawSubmittedValue);
        $resultLength = mb_strlen($rawSubmittedValue);
        if ($resultLength === 0) return NULL;
        $result = $rawSubmittedValue;
        if (
            $this->minLength !== NULL &&
            $this->minLength > 0 &&
            $resultLength < $this->minLength
        ) {
            $this->field->AddValidationError(
                static::GetErrorMessage(self::ERROR_MIN_LENGTH), [$this->minLength]
            );
        }
        if (
            $this->maxLength !== NULL &&
            $this->maxLength > 0 &&
            $resultLength > $this->maxLength
        ) {
            $this->field->AddValidationError(
                static::GetErrorMessage(self::ERROR_MAX_LENGTH), [$this->maxLength]
            );
        }
        return $result;
    }
}