Concerns
3 years ago
Conditions
4 years ago
Contracts
3 years ago
Exceptions
3 years ago
Facades
4 years ago
Checkbox.php
4 years ago
Date.php
4 years ago
Element.php
3 years ago
Email.php
4 years ago
Factory.php
4 years ago
Field.php
3 years ago
File.php
3 years ago
Form.php
3 years ago
Group.php
3 years ago
Hidden.php
4 years ago
Html.php
4 years ago
Option.php
3 years ago
Phone.php
4 years ago
Radio.php
4 years ago
Section.php
3 years ago
Select.php
4 years ago
Text.php
4 years ago
Textarea.php
4 years ago
Types.php
4 years ago
Url.php
4 years ago
Checkbox.php
50 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Framework\FieldsAPI; |
| 4 | |
| 5 | /** |
| 6 | * @since 2.12.0 |
| 7 | */ |
| 8 | class Checkbox extends Field |
| 9 | { |
| 10 | |
| 11 | use Concerns\HasEmailTag; |
| 12 | use Concerns\HasHelpText; |
| 13 | use Concerns\HasLabel; |
| 14 | use Concerns\HasOptions; |
| 15 | use Concerns\HasPlaceholder; |
| 16 | use Concerns\ShowInReceipt; |
| 17 | use Concerns\StoreAsMeta; |
| 18 | |
| 19 | const TYPE = 'checkbox'; |
| 20 | |
| 21 | /** |
| 22 | * Helper for marking the checkbox as checked by default |
| 23 | * |
| 24 | * @since 2.12.0 |
| 25 | * |
| 26 | * @param bool|callable $isChecked |
| 27 | * |
| 28 | * @return $this |
| 29 | */ |
| 30 | public function checked($isChecked = true) |
| 31 | { |
| 32 | $default = is_callable($isChecked) ? $isChecked() : $isChecked; |
| 33 | $this->defaultValue((bool)$default); |
| 34 | |
| 35 | return $this; |
| 36 | } |
| 37 | |
| 38 | /** |
| 39 | * Returns whether the checkbox is checked by default |
| 40 | * |
| 41 | * @since 2.12.0 |
| 42 | * |
| 43 | * @return bool |
| 44 | */ |
| 45 | public function isChecked() |
| 46 | { |
| 47 | return (bool)$this->defaultValue; |
| 48 | } |
| 49 | } |
| 50 |