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:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 

<?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\Select`
 *    - `\MvcCore\Ext\Forms\Fields\CountrySelect`
 * - `\MvcCore\Ext\Forms\CheckboxGroup`
 * - `\MvcCore\Ext\Forms\Validators\MinMaxOptions`
 */
trait MinMaxOptions {

    /**
     * Minimum options count to select. 
     * Default value is `NULL` to not limit anything.
     * @var int|NULL
     */
    protected $minOptions = NULL;

    /**
     * Maximum options count to select. 
     * Default value is `NULL` to not limit anything.
     * @var int|NULL
     */
    protected $maxOptions = NULL;

    /**
     * Field is required bubble message for javascript.
     * @var string|NULL
     */
    protected $requiredBubbleMessage = NULL;

    /**
     * Minimum options bubble message for javascript.
     * @var string|NULL
     */
    protected $minOptionsBubbleMessage = NULL;

    /**
     * Maximum options bubble message for javascript.
     * @var string|NULL
     */
    protected $maxOptionsBubbleMessage = NULL;
    
    /**
     * Get minimum options count to select. 
     * Default value is `NULL` to not limit anything.
     * @return int|NULL
     */
    public function GetMinOptions () {
        return $this->minOptions;
    }
    
    /**
     * Set minimum options count to select. 
     * Default value is `NULL` to not limit anything.
     * @param int|NULL $minOptions
     * @return \MvcCore\Ext\Forms\Field
     */
    public function SetMinOptions ($minOptions) {
        /** @var $this \MvcCore\Ext\Forms\Field */
        $this->minOptions = $minOptions;
        return $this;
    }

    /**
     * Get maximum options count to select. 
     * Default value is `NULL` to not limit anything.
     * @return int|NULL
     */
    public function GetMaxOptions () {
        return $this->maxOptions;
    }
    
    /**
     * Set maximum options count to select. 
     * Default value is `NULL` to not limit anything.
     * @param int|NULL $maxOptions
     * @return \MvcCore\Ext\Forms\Field
     */
    public function SetMaxOptions ($maxOptions) {
        /** @var $this \MvcCore\Ext\Forms\Field */
        $this->maxOptions = $maxOptions;
        return $this;
    }

    /**
     * Get field is required bubble message for javascript.
     * This method could be used only for checkbox group control.
     * @return string
     */
    public function GetRequiredBubbleMessage () {
        return $this->requiredBubbleMessage;
    }

    /**
     * Set field is required bubble message for javascript.
     * This method could be used only for checkbox group control.
     * @param string $requiredBubbleMessage 
     * @return \MvcCore\Ext\Forms\Field
     */
    public function SetRequiredBubbleMessage ($requiredBubbleMessage) {
        /** @var $this \MvcCore\Ext\Forms\Field */
        $this->requiredBubbleMessage = $requiredBubbleMessage;
        return $this;
    }

    /**
     * Get minimum options bubble message for javascript.
     * @return string
     */
    public function GetMinOptionsBubbleMessage () {
        return $this->minOptionsBubbleMessage;
    }

    /**
     * Set minimum options bubble message for javascript.
     * @param string $minOptionsBubbleMessage 
     * @return \MvcCore\Ext\Forms\Field
     */
    public function SetMinOptionsBubbleMessage ($minOptionsBubbleMessage) {
        /** @var $this \MvcCore\Ext\Forms\Field */
        $this->minOptionsBubbleMessage = $minOptionsBubbleMessage;
        return $this;
    }

    /**
     * Get maximum options bubble message for javascript.
     * @return string
     */
    public function GetMaxOptionsBubbleMessage () {
        return $this->maxOptionsBubbleMessage;
    }

    /**
     * Set maximum options bubble message for javascript.
     * @param string $minOptionsBubbleMessage 
     * @return \MvcCore\Ext\Forms\Field
     */
    public function SetMaxOptionsBubbleMessage ($maxOptionsBubbleMessage) {
        /** @var $this \MvcCore\Ext\Forms\Field */
        $this->maxOptionsBubbleMessage = $maxOptionsBubbleMessage;
        return $this;
    }
    
    /**
     * Check if field has proper min/max validator if any value for minimum 
     * or maximum options count is set. Process this check immediately
     * when field is added into form instance.
     * @return void
     */
    protected function setFormMinMaxOptions () {
        if (
            ($this->minOptions !== NULL || $this->maxOptions !== NULL) &&
            !isset($this->validators['MinMaxOptions'])
        )
            $this->validators['MinMaxOptions'] = 'MinMaxOptions';
    }
}