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: <?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: define getters and setters for field property `checked`
* and method `GetCheckedByValue()` to automatically get
* `checked` boolean from any field value.
* Interface for classes:
* - `\MvcCore\Ext\Forms\Fields\Checkbox`
*/
interface IChecked {
/**
* Set `TRUE` to rendered field as checked, `FALSE` otherwise.
* If not set, checked flag will be automatically resolved by field value
* with method `static::GetCheckedByValue($checkbox->GetValue());`
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-checked
* @param bool $checked
* @return \MvcCore\Ext\Forms\Field
*/
public function SetChecked ($checked = TRUE);
/**
* Get `TRUE` if field is rendered as checked, `FALSE` otherwise.
* If not set, checked flag will be automatically resolved by field value
* with method `static::GetCheckedByValue($checkbox->GetValue());`
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-checked
* @return bool|NULL
*/
public function GetChecked ();
/**
* Return `TRUE` for any `array`, `object`, `resource` or `unknown type`,
* `TRUE` for `boolean` `TRUE`, for `string` not equal to `no`,
* for `integer` not equal to `0` and `TRUE` for `float` not equal to `0.0`.
* @param mixed $value
* @return bool
*/
public static function GetCheckedByValue ($value);
}