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: 

<?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\Fields;

/**
 * Responsibility: init, pre-dispatch and render `<input type="radio">` HTML 
 *                 element as radio buttons menu for single option selection.
 *                 `RadioGroup` field has it's own validator to check if 
 *                 submitted value is presented in configured options by default.
 */
class RadioGroup extends \MvcCore\Ext\Forms\FieldsGroup {

    /**
     * Possible values: `radio`.
     * @var string
     */
    protected $type = 'radio';

    /**
     * Value type for `RadioGroup` is always `string` or `NULL`, not any array type.
     * So it's necessary to change back the `value` property type
     * defined in parent class `FieldsGroup` from `array` to `string|NULL`.
     * @var string|NULL
     */
    protected $value = NULL;

    /**
     * Validators: 
     * - `ValueInOptions` - to validate if submitted string is presented in radio options keys.
     * @var string[]|\Closure[]
     */
    protected $validators = ['ValueInOptions'];

    /**
     * Radio group is always not marked as multiple value control. This function 
     * always return `FALSE` for radio group instance.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-multiple
     * @return bool
     */
    public function GetMultiple () {
        return FALSE;
    }

    /**
     * Field group is always not marked as multiple value control. This function 
     * does nothing, because multiple option has to be `FALSE` for radio group instance all time.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-multiple
     * @return \MvcCore\Ext\Forms\FieldsGroup
     */
    public function SetMultiple ($multiple = TRUE) {
        /** @var $this \MvcCore\Ext\Forms\Field */
        return $this;
    }

    /**
     * Return field specific data for validator.
     * @param array $fieldPropsDefaultValidValues 
     * @return array
     */
    public function & GetValidatorData ($fieldPropsDefaultValidValues = []) {
        $result = [
            'multiple'      => FALSE, 
            'options'       => & $this->options, 
        ];
        return $result;
    }

    /**
     * Create new form `<input type="radio">` control instance.
     * @param array $cfg Config array with public properties and it's 
     *                   values which you want to configure, presented 
     *                   in camel case properties names syntax.
     * @throws \InvalidArgumentException
     * @return void
     */
    public function __construct(array $cfg = []) {
        parent::__construct($cfg);
        static::$templates = (object) array_merge(
            (array) parent::$templates, 
            (array) self::$templates
        );
    }
}