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: 

<?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`
 * - `\MvcCore\Ext\Forms\Fields\Textarea`
 */
trait PlaceHolder {

    /**
     * A hint to the user of what can be entered in the control, typically in the form 
     * of an example of the type of information that should be entered. The placeholder
     * text must not contain carriage returns or line-feeds. `NULL` value means no 
     * placeholder attribute will bee rendered.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-placeholder
     * @var string|NULL
     */
    protected $placeHolder = NULL;

    /**
     * Boolean to translate placeholder text, `TRUE` by default.
     * @var boolean
     */
    protected $translatePlaceholder = TRUE;

    /**
     * Automatically translate `placeHolder` attribute if necessary
     * in `PreDispatch()` field rendering moment.
     * @return void
     */
    protected function preDispatchPlaceHolder () {
        if ($this->translate && $this->placeHolder !== NULL && $this->translatePlaceholder)
            $this->placeHolder = $this->form->Translate($this->placeHolder);
    }

    /**
     * A hint to the user of what can be entered in the control, typically in the form 
     * of an example of the type of information that should be entered. The placeholder
     * text must not contain carriage returns or line-feeds. `NULL` value means no 
     * placeholder attribute will bee rendered.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-placeholder
     * @return string|NULL
     */
    public function GetPlaceHolder () {
        return $this->placeHolder;
    }

    /**
     * A hint to the user of what can be entered in the control, typically in the form 
     * of an example of the type of information that should be entered. The placeholder
     * text must not contain carriage returns or line-feeds. `NULL` value means no 
     * placeholder attribute will bee rendered.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-placeholder
     * @param string|NULL  $placeHolder 
     * @param boolean|NULL $translatePlaceholder 
     * @return \MvcCore\Ext\Forms\Field
     */
    public function SetPlaceHolder ($placeHolder, $translatePlaceholder = NULL) {
        /** @var $this \MvcCore\Ext\Forms\Field */
        $this->placeHolder = $placeHolder;
        if ($translatePlaceholder !== NULL)
            $this->translatePlaceholder = $translatePlaceholder;
        return $this;
    }
}