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: 

<?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\Field\Props;

/**
 * Trait for classes:
 * - `\MvcCore\Ext\Forms\Fields\Text`
 *    - `\MvcCore\Ext\Forms\Fields\Email`
 *    - `\MvcCore\Ext\Forms\Fields\Password`
 *    - `\MvcCore\Ext\Forms\Fields\Search`
 *    - `\MvcCore\Ext\Forms\Fields\Tel`
 *    - `\MvcCore\Ext\Forms\Fields\Url`
 * - `\MvcCore\Ext\Forms\Validators\Pattern`
 */
trait Pattern {

    /**
     * RegExp match pattern for HTML attribute `pattern` and
     * RegExp match pattern for build in `Pattern` validator
     * added automatically after field is added into form, if any 
     * RegExp pattern value defined.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-pattern
     * @var string|NULL
     */
    protected $pattern = NULL;

    /**
     * Get RegExp match pattern for HTML attribute `pattern`
     * and RegExp match pattern for build in `Pattern` validator
     * added automatically after field is added into form, if any 
     * RegExp pattern value defined.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-pattern
     * @return string RegExp pattern without border characters for javascript and PHP.
     */
    public function GetPattern () {
        return $this->pattern;
    }

    /**
     * Set RegExp match pattern for HTML attribute `pattern`
     * and RegExp match pattern for build in `Pattern` validator
     * added automatically after field is added into form, if any 
     * RegExp pattern value defined.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-pattern
     * @param string $pattern RegExp pattern without border characters for javascript and PHP.
     * @return \MvcCore\Ext\Forms\Field
     */
    public function SetPattern ($pattern) {
        /** @var $this \MvcCore\Ext\Forms\Field */
        $this->pattern = $pattern;
        return $this;
    }

    /**
     * Check after field is added into form, if field 
     * has defined any value for pattern property and if it does,
     * add automatically build in pattern validator.
     * @return void
     */
    protected function setFormPattern () {
        if ($this->pattern && !isset($this->validators['Pattern']))
            $this->validators['Pattern'] = 'Pattern';
    }
}