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: 

<?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\Color`
 * - `\MvcCore\Ext\Forms\Fields\Number`
 *    - `\MvcCore\Ext\Forms\Fields\Range`
 * - `\MvcCore\Ext\Forms\Fields\Select`
 *    - `\MvcCore\Ext\Forms\Fields\CountrySelect`
 * - `\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`
 * - `\MvcCore\Ext\Forms\Fields\Hidden`
 */
trait AutoComplete {

    /**
     * Attribute indicates if the input can be automatically completed 
     * by the browser, usually by remembering previous values the user has entered.
     * Possible values: `off`, `on`, `name`, `email`, `username`, `country`, `postal-code` and many more...
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-autocomplete
     * @var string|NULL
     */
    protected $autoComplete = NULL;

    /**
     * Get attribute indicates if the input can be automatically completed 
     * by the browser, usually by remembering previous values the user has entered.
     * Possible values: `off`, `on`, `name`, `email`, `username`, `country`, `postal-code` and many more...
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-autocomplete
     * @return string|NULL
     */
    public function GetAutoComplete () {
        return $this->autoComplete;
    }

    /**
     * Set attribute indicates if the input can be automatically completed 
     * by the browser, usually by remembering previous values the user has entered.
     * Possible values: `off`, `on`, `name`, `email`, `username`, `country`, `postal-code` and many more...
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-autocomplete
     * @param bool|string $autoComplete Possible values are `'on' | TRUE | 'off' | FALSE | 'anything' | NULL`.
     * @return \MvcCore\Ext\Forms\Field
     */
    public function SetAutoComplete ($autoComplete = FALSE) {
        /** @var $this \MvcCore\Ext\Forms\Field */
        if ($autoComplete === FALSE) {
            $this->autoComplete = 'off';
        } else if ($autoComplete === TRUE) {
            $this->autoComplete = 'on';
        } else {
            $this->autoComplete = $autoComplete;
        }
        return $this;
    }
}