GUI class for glossary flashcard boxes. More...

Collaboration diagram for ilGlossaryFlashcardBoxGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	show ()

	showAllItems ()

	showRemainingItems ()

	showItems (bool $all)

	showHidden ()

	showRevealed ()

	answerCorrectly ()

	answerIncorrectly ()

	answer (bool $correct)

Protected Member Functions
	setFlashcardTitleAndDescription ()

	getTermText ()

	getDefinitionPage ()

Protected Attributes
ilCtrl	$ctrl

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

UI Factory	$ui_fac

UI Renderer	$ui_ren

Presentation PresentationGUIRequest	$request

Flashcard FlashcardManager	$manager

int	$box_nr = 0

array	$initial_terms_in_box = []

array	$terms_in_box = []

Flashcard Term	$current_term

ilObjGlossary	$glossary

Detailed Description

GUI class for glossary flashcard boxes.

Author: Thomas Famula famul.nosp@m.a@le.nosp@m.ifos..nosp@m.de

Definition at line 29 of file class.ilGlossaryFlashcardBoxGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilGlossaryFlashcardBoxGUI::__construct ( )

Definition at line 44 of file class.ilGlossaryFlashcardBoxGUI.php.

References $DIC, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

     {
         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());
     }

Here is the call graph for this function:

Member Function Documentation

◆ answer()

ilGlossaryFlashcardBoxGUI::answer ( bool $correct )

Definition at line 232 of file class.ilGlossaryFlashcardBoxGUI.php.

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by answerCorrectly(), and answerIncorrectly().

                                          : 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");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ answerCorrectly()

ilGlossaryFlashcardBoxGUI::answerCorrectly ( )

Definition at line 222 of file class.ilGlossaryFlashcardBoxGUI.php.

References answer().

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

Here is the call graph for this function:

◆ answerIncorrectly()

ilGlossaryFlashcardBoxGUI::answerIncorrectly ( )

Definition at line 227 of file class.ilGlossaryFlashcardBoxGUI.php.

References answer().

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

Here is the call graph for this function:

◆ executeCommand()

ilGlossaryFlashcardBoxGUI::executeCommand ( )

Definition at line 69 of file class.ilGlossaryFlashcardBoxGUI.php.

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ getDefinitionPage()

ilGlossaryFlashcardBoxGUI::getDefinitionPage ( )

protected

Definition at line 250 of file class.ilGlossaryFlashcardBoxGUI.php.

Referenced by showHidden().

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

Here is the caller graph for this function:

◆ getTermText()

ilGlossaryFlashcardBoxGUI::getTermText ( )

protected

Definition at line 244 of file class.ilGlossaryFlashcardBoxGUI.php.

References $text, and ilGlossaryTerm\_lookGlossaryTerm().

Referenced by showHidden(), and showRevealed().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFlashcardTitleAndDescription()

ilGlossaryFlashcardBoxGUI::setFlashcardTitleAndDescription ( )

protected

Definition at line 212 of file class.ilGlossaryFlashcardBoxGUI.php.

References $box_nr, and ILIAS\Repository\lng().

Referenced by showHidden(), and showRevealed().

                                                         : 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);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ show()

ilGlossaryFlashcardBoxGUI::show ( )

Definition at line 82 of file class.ilGlossaryFlashcardBoxGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and showAllItems().

                           : 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();
         }
     }

Here is the call graph for this function:

◆ showAllItems()

ilGlossaryFlashcardBoxGUI::showAllItems ( )

Definition at line 128 of file class.ilGlossaryFlashcardBoxGUI.php.

References showItems().

Referenced by show().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showHidden()

ilGlossaryFlashcardBoxGUI::showHidden ( )

Definition at line 155 of file class.ilGlossaryFlashcardBoxGUI.php.

References ILIAS\Repository\ctrl(), getDefinitionPage(), getTermText(), ILIAS\Repository\lng(), and setFlashcardTitleAndDescription().

                                 : 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("???")
             );
         } else {
             $flashcard = $this->ui_fac->panel()->standard(
                 $this->lng->txt("glo_what_means_definition"),
                 $this->ui_fac->legacy($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);
     }

Here is the call graph for this function:

◆ showItems()

ilGlossaryFlashcardBoxGUI::showItems ( bool $all )

Definition at line 138 of file class.ilGlossaryFlashcardBoxGUI.php.

References ILIAS\Repository\ctrl().

Referenced by showAllItems(), and showRemainingItems().

                                         : 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");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showRemainingItems()

ilGlossaryFlashcardBoxGUI::showRemainingItems ( )

Definition at line 133 of file class.ilGlossaryFlashcardBoxGUI.php.

References showItems().

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

Here is the call graph for this function:

◆ showRevealed()

ilGlossaryFlashcardBoxGUI::showRevealed ( )

Definition at line 187 of file class.ilGlossaryFlashcardBoxGUI.php.

References ILIAS\Repository\ctrl(), getTermText(), ILIAS\Repository\lng(), and setFlashcardTitleAndDescription().

                                   : void
     {
         $this->setFlashcardTitleAndDescription();
 
         $flashcard = $this->ui_fac->panel()->standard(
             $this->getTermText(),
             $this->ui_fac->legacy($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);
     }