| 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\HasOptions; |
| 14 |
use Concerns\HasPlaceholder; |
| 15 |
use Concerns\ShowInReceipt; |
| 16 |
use Concerns\StoreAsMeta; |
| 17 |
|
| 18 |
const TYPE = 'checkbox'; |
| 19 |
|
| 20 |
/** |
| 21 |
* Helper for marking the checkbox as checked by default |
| 22 |
* |
| 23 |
* @since 2.12.0 |
| 24 |
* |
| 25 |
* @param bool|callable $isChecked |
| 26 |
* |
| 27 |
* @return $this |
| 28 |
*/ |
| 29 |
public function checked( $isChecked = true ) { |
| 30 |
$default = is_callable( $isChecked ) ? $isChecked() : $isChecked; |
| 31 |
$this->defaultValue( (bool) $default ); |
| 32 |
|
| 33 |
return $this; |
| 34 |
} |
| 35 |
|
| 36 |
/** |
| 37 |
* Returns whether the checkbox is checked by default |
| 38 |
* |
| 39 |
* @since 2.12.0 |
| 40 |
* |
| 41 |
* @return bool |
| 42 |
*/ |
| 43 |
public function isChecked() { |
| 44 |
return (bool) $this->defaultValue; |
| 45 |
} |
| 46 |
} |
| 47 |
|
