Online.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\ILIASObject\Properties\CoreProperties;

use ILIAS\ILIASObject\Properties\Property;
use ILIAS\UI\Component\Input\Field\Checkbox;
use ILIAS\UI\Component\Input\Field\Factory as FieldFactory;
use ILIAS\Refinery\Factory as Refinery;

class Online implements Property
{
    private const DEFAULT_IS_ONLINE = false;
    private const INPUT_LABEL = 'online';
    private const INPUT_BYLINE = 'online_input_byline';

    public function __construct(
        private bool $is_online = self::DEFAULT_IS_ONLINE
    ) {
    }

    public function getIsOnline(): bool
    {
        return $this->is_online;
    }

    public function withOnline(): self
    {
        $clone = clone $this;
        $clone->is_online = true;
        return $clone;
    }

    public function withOffline(): self
    {
        $clone = clone $this;
        $clone->is_online = false;
        return $clone;
    }

    public function toForm(
        \ilLanguage $language,
        FieldFactory $field_factory,
        Refinery $refinery
    ): Checkbox {
        $trafo = $refinery->custom()->transformation(
            function ($v): Property {
                return new self($v);
            }
        );
        return $field_factory->checkbox($language->txt(self::INPUT_LABEL))
            ->withByline($language->txt(self::INPUT_BYLINE))
            ->withAdditionalTransformation($trafo)
            ->withValue($this->getIsOnline());
    }
}