SuggestedSolution.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\TestQuestionPool\Questions\SuggestedSolution;

abstract class SuggestedSolution
{
    public const TYPE_LM = 'lm';
    public const TYPE_LM_CHAPTER = 'st';
    public const TYPE_LM_PAGE = 'pg';
    public const TYPE_GLOSARY_TERM = 'git';
    public const TYPE_FILE = 'file';

    public const TYPES = [
        self::TYPE_LM => 'obj_lm',
        self::TYPE_LM_CHAPTER => 'obj_st',
        self::TYPE_LM_PAGE => 'obj_pg',
        self::TYPE_GLOSARY_TERM => 'glossary_term',
        self::TYPE_FILE => 'fileDownload'
    ];

    protected int $id;
    protected int $question_id;
    protected int $subquestion_index;
    protected string $import_id;
    protected \DateTimeImmutable $last_update;

    public function __construct(
        int $id,
        int $question_id,
        int $subquestion_index,
        string $import_id,
        \DateTimeImmutable $last_update
    ) {
        $this->id = $id;
        $this->question_id = $question_id;
        $this->subquestion_index = $subquestion_index;
        $this->import_id = $import_id;
        $this->last_update = $last_update;
    }

    abstract public function getType(): string;
    abstract public function getStorableValue(): string;

    public function getId(): int
    {
        return $this->id;
    }
    public function withId(int $id): static
    {
        $clone = clone $this;
        $clone->id = $id;
        return $clone;
    }

    public function getQuestionId(): int
    {
        return $this->question_id;
    }
    public function withQuestionId(int $question_id): static
    {
        $clone = clone $this;
        $clone->question_id = $question_id;
        return $clone;
    }

    public function getImportId(): string
    {
        return $this->import_id;
    }
    public function withImportId(string $import_id): static
    {
        $clone = clone $this;
        $clone->import_id = $import_id;
        return $clone;
    }

    public function getSubquestionIndex(): int
    {
        return $this->subquestion_index;
    }
    public function withSubquestionIndex(int $subquestion_index): static
    {
        $clone = clone $this;
        $clone->subquestion_index = $subquestion_index;
        return $clone;
    }

    public function getLastUpdate(): \DateTimeImmutable
    {
        return $this->last_update;
    }

    public function isOfTypeFile(): bool
    {
        return $this->getType() === self::TYPE_FILE;
    }

    public function isOfTypeLink(): bool
    {
        return in_array(
            $this->getType(),
            [
                self::TYPE_LM,
                self::TYPE_LM_CHAPTER,
                self::TYPE_LM_PAGE,
                self::TYPE_GLOSARY_TERM,
            ]
        );
    }
}