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: 

<?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 all visible fields, for classes:
 * - `\MvcCore\Ext\Forms\Fields\Button`
 *    - `\MvcCore\Ext\Forms\Fields\SubmitButton`
 *    - `\MvcCore\Ext\Forms\Fields\ResetButton`
 * - `\MvcCore\Ext\Forms\Fields\Color`
 * - `\MvcCore\Ext\Forms\Fields\Date`
 *    - `\MvcCore\Ext\Forms\Fields\DateTime`
 *    - `\MvcCore\Ext\Forms\Fields\Month`
 *    - `\MvcCore\Ext\Forms\Fields\Time`
 *    - `\MvcCore\Ext\Forms\Fields\Week`
 * - `\MvcCore\Ext\Forms\Fields\File`
 * - `\MvcCore\Ext\Forms\Fields\Checkbox`
 * - `\MvcCore\Ext\Forms\Fields\Image`
 * - `\MvcCore\Ext\Forms\Fields\Number`
 *    - `\MvcCore\Ext\Forms\Fields\Range`
 * - `\MvcCore\Ext\Forms\Fields\ResetInput`
 * - `\MvcCore\Ext\Forms\Fields\Select`
 *    - `\MvcCore\Ext\Forms\Fields\CountrySelect`
 * - `\MvcCore\Ext\Forms\Fields\SubmitInput`
 * - `\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\FieldsGroup`
 *    - `\MvcCore\Ext\Forms\CheckboxGroup`
 *    - `\MvcCore\Ext\Forms\RadioGroup`
 */
trait Required {

    /**
     * Form field attribute `required`, determination
     * if control will be required to complete any value by user.
     * This flag is also used for submit checking. Default value is `NULL`
     * to not require any field value. If form has configured it's property
     * `$form->GetDefaultRequired()` to `TRUE` and this value is `NULL`, field
     * will be automatically required by default form configuration.
     * @var bool|NULL
     */
    protected $required = NULL;

    /**
     * Get form field attribute required, determination
     * if field will be required to complete any value by user.
     * This flag is also used for submit checking. Default value is `NULL`
     * to not require any field value. If form has configured it's property
     * `$form->GetDefaultRequired()` to `TRUE` and this value is `NULL`, field
     * will be automatically considered as required by default form configuration.
     * But this method return only value stored inside this field instance.
     * @return bool|NULL
     */
    public function GetRequired () {
        return $this->required;
    }

    /**
     * Set form field attribute required, determination
     * if field will be required to complete any value by user.
     * This flag is also used for submit checking. Default value is `NULL`
     * to not require any field value. If form has configured it's property
     * `$form->GetDefaultRequired()` to `TRUE` and this value is `NULL`, field
     * will be automatically considered required by default form configuration.
     * @param bool|NULL $required
     * @return \MvcCore\Ext\Form
     */
    public function SetRequired ($required = TRUE) {
        /** @var $this \MvcCore\Ext\Forms\Field */
        $this->required = $required;
        return $this;
    }
}