# give/4.16.8.1/src/Framework/FieldsAPI/Checkbox.php

GiveWP – Donation Plugin and Fundraising Platform, version 4.16.8.1. 87 lines.

- Page: https://pluginprobe.com/plugins/give/4.16.8.1/code/src/Framework/FieldsAPI/Checkbox.php
- Raw: https://pluginprobe.com/plugins/give/4.16.8.1/raw/src/Framework/FieldsAPI/Checkbox.php
- Modified: 2023-08-11T21:18:48+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/give/4.16.8.1/code/src/Framework/FieldsAPI/Checkbox.php#L10-L20`.

```php
<?php

namespace Give\Framework\FieldsAPI;

use Give\Framework\Exceptions\Primitives\RuntimeException;

/**
 * @since 2.32.0 added description
 * @since 2.28.0
 */
class Checkbox extends Field
{
    use Concerns\HasHelpText;
    use Concerns\HasLabel;
    use Concerns\HasDescription;

    const TYPE = 'checkbox';

    /**
     * @var bool whether the checkbox is checked by default
     */
    protected $checked = false;

    /**
     * @var mixed the value of the checkbox when checked
     */
    protected $value;

    /**
     * Sets the value the checkbox returns when checked.
     *
     * The default value is also set because the getDefaultMethod() method is not called during serialization.
     *
     * @since 2.28.0
     */
    public function value($value): self
    {
        $this->value = $value;
        $this->defaultValue = $this->checked ? $value : null;

        return $this;
    }

    /**
     * @since 2.28.0
     */
    public function getValue()
    {
        return $this->value;
    }

    /**
     * Since the default value needs to reflect the value of the checkbox, this method is not supported.
     *
     * @since 2.28.0
     */
    public function defaultValue($defaultValue)
    {
        throw new RuntimeException(
            'Do not set the default value. Instead, set the value and use the checked() method.'
        );
    }

    /**
     * Sets the checkbox as checked by default
     *
     * The default value is also set because the getDefaultMethod() method is not called during serialization.
     *
     * @since 2.28.0
     */
    public function checked(bool $checked = true): self
    {
        $this->checked = $checked;
        $this->defaultValue = $this->checked ? $this->value : null;

        return $this;
    }

    /**
     * @since 2.28.0
     */
    public function isChecked(): bool
    {
        return $this->checked;
    }
}

```