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:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 

<?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\Number`
 *    - \MvcCore\Ext\Forms\Fields\Range`
 * - `\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`
 */
trait InputMode {

    protected static $fieldTypesAndInputModes = [
        'text'      => 'text',
        'password'  => 'text',
        // decided by value | min | max | step
        //'decimal' => 'decimal',
        //'numeric' => 'numeric',
        'tel'       => 'tel',
        'search'    => 'search',
        'email'     => 'email',
        'url'       => 'url'
    ];

    /**
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-inputmode
     * @var string|NULL
     */
    protected $inputMode = NULL;

    /**
     * A hint to browsers for which virtual keyboard to display. 
     * This attribute applies when the type attribute is 
     * `text`, `password`, `email`, or `url`. Possible values:
     *  `none`      : No virtual keyboard should be displayed.
     *  `text`      : Text input in the user's locale.
     *  `decimal`   : Fractional numeric input.
     *  `numeric`   : Numeric input.
     *  `tel`       : Telephone input, including asterisk and 
     *                pound key. Prefer `<input type="tel">`.
     *  `search`    : A virtual keyboard optimized for search input.
     *  `email`     : Email input. Prefer `<input type="email">`.
     *  `url`       : URL input. Prefer `<input type="url">`.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-inputmode
     * @return string|NULL
     */
    public function GetInputMode () {
        return $this->inputMode;
    }

    /**
     * A hint to browsers for which virtual keyboard to display. 
     * This attribute applies when the type attribute is 
     * `text`, `password`, `email`, or `url`. Possible values:
     *  `none`      : No virtual keyboard should be displayed.
     *  `text`      : Text input in the user's locale.
     *  `decimal`   : Fractional numeric input.
     *  `numeric`   : Numeric input.
     *  `tel`       : Telephone input, including asterisk and 
     *                pound key. Prefer `<input type="tel">`.
     *  `search`    : A virtual keyboard optimized for search input.
     *  `email`     : Email input. Prefer `<input type="email">`.
     *  `url`       : URL input. Prefer `<input type="url">`.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-inputmode
     * @param string|NULL $inputMode
     * @return \MvcCore\Ext\Forms\Field
     */
    public function SetInputMode ($inputMode) {
        /** @var $this \MvcCore\Ext\Forms\Field */
        $this->inputMode = $inputMode;
        return $this;
    }

    /**
     * Automatically set up `inputmode` attribute (if it is still `NULL`) 
     * by field type in `PreDispatch()` field rendering moment.
     * @return void
     */
    protected function preDispatchInputMode () {
        /** @var $this \MvcCore\Ext\Forms\Field */
        if ($this->inputMode !== NULL) return;
        if ($this->type === 'number') {
            if (
                (is_numeric($this->value) && floor($this->value) !== $this->value) ||
                (is_numeric($this->step) && floor($this->step) !== $this->step) ||
                (is_numeric($this->min) && floor($this->min) !== $this->min) ||
                (is_numeric($this->max) && floor($this->max) !== $this->max)
            ) {
                $this->inputMode = 'decimal';
            } else {
                $this->inputMode = 'numeric';
            }
        } else if (isset(static::$fieldTypesAndInputModes[$this->type])) {
            $this->inputMode = static::$fieldTypesAndInputModes[$this->type];
        }
    }
}