class.ilLSPostCondition.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilLSPostCondition
{
    public const OPERATOR_LP = 'learning_progress';
    public const OPERATOR_ALWAYS = 'always';
    public const OPERATOR_FAILED = 'failed';
    public const OPERATOR_FINISHED = 'finished';
    public const OPERATOR_NOT_FINISHED = 'not_finished';
    public const OPERATOR_PASSED = 'passed';

    protected static $known_operators = [
        self::OPERATOR_ALWAYS,
        self::OPERATOR_FAILED,
        self::OPERATOR_FINISHED,
        self::OPERATOR_NOT_FINISHED,
        self::OPERATOR_PASSED,
        self::OPERATOR_LP
    ];

    protected int $ref_id;
    protected string $operator;
    protected ?string $value;

    public function __construct(
        int $ref_id,
        string $operator,
        ?string $value = null
    ) {
        if (!in_array($operator, self::$known_operators)) {
            throw new \InvalidArgumentException(
                "Unknown operator: $operator"
            );
        }

        $this->ref_id = $ref_id;
        $this->operator = $operator;
        $this->value = $value;
    }

    public function getRefId(): int
    {
        return $this->ref_id;
    }

    public function withRefId(int $ref_id): self
    {
        $clone = clone $this;
        $clone->ref_id = $ref_id;
        return $clone;
    }

    public function getConditionOperator(): string
    {
        return $this->operator;
    }

    public function withConditionOperator(string $operator): ilLSPostCondition
    {
        if (!in_array($operator, self::$known_operators)) {
            throw new \InvalidArgumentException(
                "Unknown operator: $operator"
            );
        }

        $clone = clone $this;
        $clone->operator = $operator;
        return $clone;
    }

    public function getValue(): ?string
    {
        return $this->value;
    }

    public function withValue(string $value): ilLSPostCondition
    {
        $clone = clone $this;
        $clone->value = $value;
        return $clone;
    }
}