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\Fields\Textarea`
 */
trait SpellCheck {

    /**
     * Setting the value of this attribute to `TRUE` indicates that the element needs
     * to have its spelling and grammar checked. The value `default` indicates that 
     * the element is to act according to a default behaviour, possibly based on the 
     * parent element's own spellcheck value. The value `FALSE indicates that the 
     * element should not be checked. Possible values are strings: `default`, `true` or `false`. 
     * Value `NULL` means to not render any attribute in HTML.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-spellcheck
     * @var string|NULL
     */
    protected $spellCheck = NULL;
    
    /**
     * Setting the value of this attribute to `TRUE` indicates that the element needs
     * to have its spelling and grammar checked. The value `default` indicates that 
     * the element is to act according to a default behaviour, possibly based on the 
     * parent element's own spellcheck value. The value `FALSE indicates that the 
     * element should not be checked. Possible values are strings: `default`, `true` or `false`. 
     * Value `NULL` means to not render any attribute in HTML.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-spellcheck
     * @return string|NULL Values could be `default`, `true` or `false`. Value `NULL` means to not render any attribute in HTML.
     */
    public function GetSpellCheck () {
        return $this->spellCheck;
    }

    /**
     * Setting the value of this attribute to `TRUE` indicates that the element needs
     * to have its spelling and grammar checked. The value `default` indicates that 
     * the element is to act according to a default behaviour, possibly based on the 
     * parent element's own spellcheck value. The value `FALSE indicates that the 
     * element should not be checked. Possible values are strings: `default`, `true` or `false`. 
     * Value `NULL` means to not render any attribute in HTML.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-spellcheck
     * @param string|bool|NULL $spellCheck Values could be strings: `default`, `true` or `false` or boolean values `TRUE` or `FALSE`. Value `NULL` means to not render any attribute in HTML.
     * @return \MvcCore\Ext\Forms\Field
     */
    public function SetSpellCheck ($spellCheck) {
        /** @var $this \MvcCore\Ext\Forms\Field */
        if ($spellCheck === TRUE) {
            $spellCheck = 'true';
        } else if ($spellCheck === FALSE) {
            $spellCheck = 'false';
        }
        $this->spellCheck = $spellCheck;
        return $this;
    }
}