Checkbox.php
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Framework\FieldsAPI; |
| 4 | |
| 5 | /** |
| 6 | * @since 2.12.0 |
| 7 | */ |
| 8 | class Checkbox extends Field { |
| 9 | |
| 10 | use Concerns\HasEmailTag; |
| 11 | use Concerns\HasHelpText; |
| 12 | use Concerns\HasLabel; |
| 13 | use Concerns\HasPlaceholder; |
| 14 | use Concerns\ShowInReceipt; |
| 15 | use Concerns\StoreAsMeta; |
| 16 | |
| 17 | const TYPE = 'checkbox'; |
| 18 | |
| 19 | /** |
| 20 | * Helper for marking the checkbox as checked by default |
| 21 | * |
| 22 | * @since 2.12.0 |
| 23 | * |
| 24 | * @param bool|callable $isChecked |
| 25 | * |
| 26 | * @return $this |
| 27 | */ |
| 28 | public function checked( $isChecked = true ) { |
| 29 | $default = is_callable( $isChecked ) ? $isChecked() : $isChecked; |
| 30 | $this->defaultValue( (bool) $default ); |
| 31 | |
| 32 | return $this; |
| 33 | } |
| 34 | |
| 35 | /** |
| 36 | * Returns whether the checkbox is checked by default |
| 37 | * |
| 38 | * @since 2.12.0 |
| 39 | * |
| 40 | * @return bool |
| 41 | */ |
| 42 | public function isChecked() { |
| 43 | return (bool) $this->defaultValue; |
| 44 | } |
| 45 | } |
| 46 |