Checkbox.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Input\Field;

use ILIAS\UI\Component as C;
use ILIAS\UI\Implementation\Component\JavaScriptBindable;
use ILIAS\UI\Implementation\Component\Triggerer;
use ILIAS\UI\Implementation\Component\Input\InputData;
use ILIAS\Refinery\Constraint;
use Closure;
use LogicException;
use InvalidArgumentException;

class Checkbox extends FormInput implements C\Input\Field\Checkbox, C\Changeable, C\Onloadable
{
    use JavaScriptBindable;

    protected function getConstraintForRequirement(): ?Constraint
    {
        if ($this->requirement_constraint !== null) {
            return $this->requirement_constraint;
        }

        return null;
    }

    protected function isClientSideValueOk($value): bool
    {
        if ($value == "checked" || $value === "" || is_bool($value)) {
            return true;
        } else {
            return false;
        }
    }


    public function withValue($value): C\Input\Field\Input
    {
        $value = $value ?? false;

        if (!is_bool($value)) {
            throw new InvalidArgumentException(
                "Unknown value type for checkbox: " . gettype($value)
            );
        }

        return parent::withValue($value);
    }


    public function withInput(InputData $input): C\Input\Field\Input
    {
        if ($this->getName() === null) {
            throw new LogicException("Can only collect if input has a name.");
        }

        if (!$this->isDisabled()) {
            $value = $input->getOr($this->getName(), "");
            $clone = $this->withValue($value === "checked");
        } else {
            $clone = $this;
        }

        $clone->content = $this->applyOperationsTo($clone->getValue());
        if ($clone->content->isError()) {
            return $clone->withError("" . $clone->content->error());
        }

        return $clone;
    }

    public function appendOnLoad(C\Signal $signal): C\Onloadable
    {
        return $this->appendTriggeredSignal($signal, 'load');
    }

    public function withOnChange(C\Signal $signal): C\Changeable
    {
        return $this->withTriggeredSignal($signal, 'change');
    }

    public function appendOnChange(C\Signal $signal): C\Changeable
    {
        return $this->appendTriggeredSignal($signal, 'change');
    }

    public function withOnLoad(C\Signal $signal): C\Onloadable
    {
        return $this->withTriggeredSignal($signal, 'load');
    }

    public function getUpdateOnLoadCode(): Closure
    {
        return fn ($id) => "$('#$id').on('input', function(event) {
                            il.UI.input.onFieldUpdate(event, '$id', $('#$id').prop('checked').toString());
                    });
                    il.UI.input.onFieldUpdate(event, '$id', $('#$id').prop('checked').toString());";
    }
}