class.ilGlossaryFlashcardBoxGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI;
use ILIAS\Glossary\Presentation;
use ILIAS\Glossary\Flashcard;

class ilGlossaryFlashcardBoxGUI
{
    protected ilCtrl $ctrl;
    protected ilLanguage $lng;
    protected ilGlobalTemplateInterface $tpl;
    protected UI\Factory $ui_fac;
    protected UI\Renderer $ui_ren;
    protected Presentation\PresentationGUIRequest $request;
    protected Flashcard\FlashcardManager $manager;
    protected int $box_nr = 0;
    protected array $initial_terms_in_box = [];
    protected array $terms_in_box = [];
    protected ?Flashcard\Term $current_term;
    protected ilObjGlossary $glossary;

    public function __construct()
    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ui_fac = $DIC->ui()->factory();
        $this->ui_ren = $DIC->ui()->renderer();
        $this->request = $DIC->glossary()
                             ->internal()
                             ->gui()
                             ->presentation()
                             ->request();
        $gs = $DIC->glossary()->internal();
        $this->manager = $gs->domain()->flashcard($this->request->getRefId());

        $this->ctrl->saveParameter($this, ["box_id"]);
        $this->box_nr = $this->request->getBoxId();
        $this->initial_terms_in_box = $this->manager->getSessionInitialTerms($this->box_nr);
        $this->terms_in_box = $this->manager->getSessionTerms($this->box_nr);
        $this->current_term = $this->terms_in_box[0] ?? null;
        $this->glossary = new ilObjGlossary($this->request->getRefId());
    }

    public function executeCommand(): void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        switch ($next_class) {
            default:
                $cmd = $this->ctrl->getCmd("show");
                $ret = $this->$cmd();
                break;
        }
    }

    public function show(): void
    {
        if ($this->box_nr === Flashcard\FlashcardBox::FIRST_BOX) {
            $cnt_all = count($this->manager->getUserTermsForBox($this->box_nr))
                + count($this->manager->getAllTermsWithoutEntry());
            $cnt_remaining = count($this->manager->getNonTodayUserTermsForBox($this->box_nr))
                + count($this->manager->getAllTermsWithoutEntry());
        } else {
            $cnt_all = count($this->manager->getUserTermsForBox($this->box_nr));
            $cnt_remaining = count($this->manager->getNonTodayUserTermsForBox($this->box_nr));
        }
        $cnt_today = count($this->manager->getTodayUserTermsForBox($this->box_nr));

        if (($this->box_nr === Flashcard\FlashcardBox::FIRST_BOX
                && !$this->manager->getAllTermsWithoutEntry()
                && !$this->manager->getNonTodayUserTermsForBox($this->box_nr)
                && $this->manager->getTodayUserTermsForBox($this->box_nr))
            || ($this->box_nr !== Flashcard\FlashcardBox::FIRST_BOX
                && !$this->manager->getNonTodayUserTermsForBox($this->box_nr)
                && $this->manager->getTodayUserTermsForBox($this->box_nr))) {
            $all_button = $this->ui_fac->button()->standard(
                sprintf($this->lng->txt("glo_use_all_flashcards"), $cnt_all),
                $this->ctrl->getLinkTarget($this, "showAllItems")
            );
            $cbox = $this->ui_fac->messageBox()->info(
                sprintf($this->lng->txt("glo_flashcards_from_today_only_info"), $cnt_all)
            )->withButtons([$all_button]);
            $this->tpl->setContent($this->ui_ren->render($cbox));
        } elseif ($this->manager->getTodayUserTermsForBox($this->box_nr)) {
            $remaining_button = $this->ui_fac->button()->standard(
                sprintf($this->lng->txt("glo_use_remaining_flashcards"), $cnt_remaining),
                $this->ctrl->getLinkTarget($this, "showRemainingItems")
            );
            $all_button = $this->ui_fac->button()->standard(
                sprintf($this->lng->txt("glo_use_all_flashcards"), $cnt_all),
                $this->ctrl->getLinkTarget($this, "showAllItems")
            );
            $cbox = $this->ui_fac->messageBox()->info(
                sprintf($this->lng->txt("glo_flashcards_from_today_confirmation"), $cnt_today, $cnt_remaining, $cnt_all)
            )->withButtons([$remaining_button, $all_button]);
            $this->tpl->setContent($this->ui_ren->render($cbox));
        } else {
            $this->showAllItems();
        }
    }

    public function showAllItems(): void
    {
        $this->showItems(true);
    }

    public function showRemainingItems(): void
    {
        $this->showItems(false);
    }

    public function showItems(bool $all): void
    {
        if ($all) {
            $terms = $this->manager->getUserTermsForBox($this->box_nr);
        } else {
            $terms = $this->manager->getNonTodayUserTermsForBox($this->box_nr);
        }
        if ($this->box_nr === Flashcard\FlashcardBox::FIRST_BOX) {
            $terms_without_entry = $this->manager->getAllTermsWithoutEntry();
            $terms = array_merge($terms_without_entry, $terms);
        }
        $this->manager->setSessionInitialTerms($this->box_nr, $terms);
        $this->manager->setSessionTerms($this->box_nr, $terms);
        $this->manager->createOrUpdateBoxAccessEntry($this->box_nr);
        $this->ctrl->redirect($this, "showHidden");
    }

    public function showHidden(): void
    {
        $this->setFlashcardTitleAndDescription();

        if ($this->glossary->getFlashcardsMode() === "term") {
            $flashcard = $this->ui_fac->panel()->standard(
                sprintf($this->lng->txt("glo_what_means_term"), $this->getTermText()),
                $this->ui_fac->legacy()->content("???")
            );
        } else {
            $flashcard = $this->ui_fac->panel()->standard(
                $this->lng->txt("glo_what_means_definition"),
                $this->ui_fac->legacy()->content($this->getDefinitionPage())
            );
        }

        $btn_show = $this->ui_fac->button()->standard(
            $this->lng->txt("glo_check"),
            $this->ctrl->getLinkTarget($this, "showRevealed")
        );

        $btn_quit = $this->ui_fac->button()->standard(
            $this->lng->txt("glo_quit_box"),
            $this->ctrl->getLinkTargetByClass("ilglossarypresentationgui", "showFlashcards")
        );

        $html = $this->ui_ren->render($flashcard)
            . $this->ui_ren->render($btn_show)
            . $this->ui_ren->render($btn_quit);
        $this->tpl->setContent($html);
    }

    public function showRevealed(): void
    {
        $this->setFlashcardTitleAndDescription();

        $flashcard = $this->ui_fac->panel()->standard(
            $this->getTermText(),
            $this->ui_fac->legacy()->content($this->getDefinitionPage())
        );

        $btn_correct = $this->ui_fac->button()->standard(
            $this->lng->txt("glo_answered_correctly"),
            $this->ctrl->getLinkTarget($this, "answerCorrectly")
        );

        $btn_not_correct = $this->ui_fac->button()->standard(
            $this->lng->txt("glo_answered_not_correctly"),
            $this->ctrl->getLinkTarget($this, "answerIncorrectly")
        );

        $html = $this->ui_ren->render($flashcard)
            . $this->ui_ren->render($btn_correct)
            . $this->ui_ren->render($btn_not_correct);
        $this->tpl->setContent($html);
    }

    protected function setFlashcardTitleAndDescription(): void
    {
        $this->tpl->setTitle($this->glossary->getTitle() . ": " . $this->lng->txt("glo_box") . " " . $this->box_nr);

        $current_cnt = (count($this->initial_terms_in_box) - count($this->terms_in_box)) + 1;
        $all_cnt = count($this->initial_terms_in_box);
        $progress_txt = sprintf($this->lng->txt("glo_flashcards_progress"), $current_cnt, $all_cnt);
        $this->tpl->setDescription($progress_txt);
    }

    public function answerCorrectly(): void
    {
        $this->answer(true);
    }

    public function answerIncorrectly(): void
    {
        $this->answer(false);
    }

    public function answer(bool $correct): void
    {
        $this->manager->createOrUpdateUserTermEntry($this->current_term?->getTermId(), $correct);
        array_shift($this->terms_in_box);
        $this->manager->setSessionTerms($this->box_nr, $this->terms_in_box);
        if ($this->terms_in_box) {
            $this->ctrl->redirect($this, "showHidden");
        }
        $this->tpl->setOnScreenMessage("success", $this->lng->txt("glo_box_completed"), true);
        $this->ctrl->redirectByClass("ilglossarypresentationgui", "showFlashcards");
    }

    protected function getTermText(): string
    {
        $text = ilGlossaryTerm::_lookGlossaryTerm($this->current_term?->getTermId());
        return $text;
    }

    protected function getDefinitionPage(): string
    {
        $page_gui = new ilGlossaryDefPageGUI($this->current_term?->getTermId());
        return $page_gui->showPage();
    }
}