Inheritance diagram for ilAssQuestionHintGUI:

Collaboration diagram for ilAssQuestionHintGUI:

Public Member Functions
	__construct (assQuestionGUI $questionGUI)

	executeCommand ()

Public Member Functions inherited from ilAssQuestionHintAbstractGUI
	__construct (assQuestionGUI $question_gui)
	Constructor. More...

Data Fields
const	CMD_SHOW_FORM = 'showForm'

const	CMD_SAVE_FORM = 'saveForm'

const	CMD_CANCEL_FORM = 'cancelForm'

Private Member Functions
	showFormCmd (?ilPropertyFormGUI $form=null)

	saveFormCmd ()

	cancelFormCmd ()

	buildForm (?ilAssQuestionHint $questionHint=null)

Private Attributes
ilGlobalTemplateInterface	$main_tpl

GeneralQuestionPropertiesRepository	$questionrepository

Additional Inherited Members
Protected Attributes inherited from ilAssQuestionHintAbstractGUI
RequestDataCollector	$request_data_collector

assQuestionGUI	$question_gui = null

assQuestion	$question_obj = null

ilTabsGUI	$tabs

ilLanguage	$lng

ilCtrl	$ctrl

Detailed Description

Author: Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de; Grégory Saive gsaiv.nosp@m.e@da.nosp@m.tabay.nosp@m..de

Version: $Id$

ilAssQuestionHintGUI: ilAssHintPageGUI

Definition at line 32 of file class.ilAssQuestionHintGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilAssQuestionHintGUI::__construct ( assQuestionGUI $questionGUI )

Definition at line 40 of file class.ilAssQuestionHintGUI.php.

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

     {
         parent::__construct($questionGUI);
         global $DIC;
         $this->main_tpl = $DIC->ui()->mainTemplate();
 
         $local_dic = QuestionPoolDIC::dic();
         $this->questionrepository = $local_dic['question.general_properties.repository'];
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildForm()

ilAssQuestionHintGUI::buildForm ( ?ilAssQuestionHint $questionHint = null )

private

Definition at line 156 of file class.ilAssQuestionHintGUI.php.

References ilObjAdvancedEditing\_getUsedHTMLTags(), ilNumberInputGUI\allowDecimals(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setRequired().

Referenced by saveFormCmd(), and showFormCmd().

                                                                        : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $form->setTableWidth('100%');
 
         if (!$this->question_obj->isAdditionalContentEditingModePageObject()) {
             // form input: hint text
 
             $areaInp = new ilTextAreaInputGUI($this->lng->txt('tst_question_hints_form_label_hint_text'), 'hint_text');
             $areaInp->setRequired(true);
             $areaInp->setRows(10);
             $areaInp->setCols(80);
 
             if (!$this->question_obj->getPreventRteUsage()) {
                 $areaInp->setUseRte(true);
             }
 
             $areaInp->setRteTags(ilObjAdvancedEditing::_getUsedHTMLTags("assessment"));
 
             $areaInp->setRTESupport($this->question_obj->getId(), 'qpl', 'assessment');
 
             $form->addItem($areaInp);
         }
 
         // form input: hint points
 
         $numInp = new ilNumberInputGUI($this->lng->txt('tst_question_hints_form_label_hint_points'), 'hint_points');
         $numInp->allowDecimals(true);
         $numInp->setRequired(true);
         $numInp->setSize(3);
 
         $form->addItem($numInp);
 
         if ($questionHint instanceof ilAssQuestionHint) {
             // build form title for an existing hint
 
             $form->setTitle(sprintf(
                 $this->lng->txt('tst_question_hints_form_header_edit'),
                 $questionHint->getIndex(),
                 $this->question_obj->getTitleForHTMLOutput()
             ));
 
             $hiddenInp = new ilHiddenInputGUI('hint_id');
             $form->addItem($hiddenInp);
 
             if (!$this->question_obj->isAdditionalContentEditingModePageObject()) {
                 $areaInp->setValue($questionHint->getText());
             }
 
             $numInp->setValue((string) $questionHint->getPoints());
 
             $hiddenInp->setValue((string) $questionHint->getId());
         } else {
             // build form title for a new hint
             $form->setTitle(sprintf(
                 $this->lng->txt('tst_question_hints_form_header_create'),
                 $this->question_obj->getTitleForHTMLOutput()
             ));
         }
 
         if ($this->question_obj->isAdditionalContentEditingModePageObject()) {
             if ($questionHint instanceof ilAssQuestionHint) {
                 $saveCmdLabel = $this->lng->txt('tst_question_hints_form_cmd_save_points');
             } else {
                 $saveCmdLabel = $this->lng->txt('tst_question_hints_form_cmd_save_points_and_edit_page');
             }
         } else {
             $saveCmdLabel = $this->lng->txt('tst_question_hints_form_cmd_save');
         }
 
         $form->setFormAction($this->ctrl->getFormAction($this));
 
         $form->addCommandButton(self::CMD_SAVE_FORM, $saveCmdLabel);
         $form->addCommandButton(self::CMD_CANCEL_FORM, $this->lng->txt('cancel'));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cancelFormCmd()

ilAssQuestionHintGUI::cancelFormCmd ( )

private

Definition at line 150 of file class.ilAssQuestionHintGUI.php.

References ILIAS\Repository\ctrl().

                                     : void
     {
 
         $this->ctrl->redirectByClass(ilAssQuestionHintsGUI::class);
     }

Here is the call graph for this function:

◆ executeCommand()

ilAssQuestionHintGUI::executeCommand ( )

Definition at line 50 of file class.ilAssQuestionHintGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilAssQuestionHintPageObjectCommandForwarder\PRESENTATION_MODE_AUTHOR, and ILIAS\Repository\tabs().

     {
         $cmd = $this->ctrl->getCmd(self::CMD_SHOW_FORM);
         $nextClass = $this->ctrl->getNextClass($this);
 
         switch ($nextClass) {
             case 'ilasshintpagegui':
                 $forwarder = new ilAssQuestionHintPageObjectCommandForwarder(
                     $this->question_obj,
                     $this->ctrl,
                     $this->tabs,
                     $this->lng
                 );
                 $forwarder->setPresentationMode(ilAssQuestionHintPageObjectCommandForwarder::PRESENTATION_MODE_AUTHOR);
                 $forwarder->forward();
                 break;
 
             default:
                 $this->tabs->setTabActive('tst_question_hints_tab');
                 $cmd .= 'Cmd';
                 $this->$cmd();
                 break;
         }
 
         return true;
     }

Here is the call graph for this function:

◆ saveFormCmd()

ilAssQuestionHintGUI::saveFormCmd ( )

private

Definition at line 101 of file class.ilAssQuestionHintGUI.php.

References buildForm(), ilAssQuestionHintsGUI\CMD_CONFIRM_SYNC, ilAssQuestionHintsGUI\CMD_SHOW_LIST, ILIAS\Repository\ctrl(), ilAssQuestionHintList\getNextIndexByQuestionId(), ILIAS\Repository\lng(), and showFormCmd().

                                   : void
     {
         $questionHint = new ilAssQuestionHint();
         if ($this->request_data_collector->isset('hint_id')) {
             $questionHint->load((int) $this->request_data_collector->int('hint_id'));
 
             $hintJustCreated = false;
             $form = $this->buildForm($questionHint);
         } else {
             $questionHint->setQuestionId($this->question_obj->getId());
 
             $questionHint->setIndex(
                 ilAssQuestionHintList::getNextIndexByQuestionId($this->question_obj->getId())
             );
 
             $hintJustCreated = true;
             $form = $this->buildForm();
         }
 
         if ($form->checkInput()) {
             $questionHint->setText($form->getInput('hint_text'));
             $questionHint->setPoints($form->getInput('hint_points'));
 
             $questionHint->save();
             $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('tst_question_hints_form_saved_msg'), true);
 
             if (!$this->question_obj->isAdditionalContentEditingModePageObject()) {
                 $this->question_obj->updateTimestamp();
             }
 
             if ($this->question_gui->needsSyncQuery()) {
                 $this->ctrl->redirectByClass(
                     ilAssQuestionHintsGUI::class,
                     ilAssQuestionHintsGUI::CMD_CONFIRM_SYNC
                 );
             }
 
             if ($hintJustCreated && $this->question_obj->isAdditionalContentEditingModePageObject()) {
                 $this->ctrl->setParameterByClass(ilAssHintPageGUI::class, 'hint_id', $questionHint->getId());
                 $this->ctrl->redirectByClass(ilAssHintPageGUI::class, 'edit');
             } else {
                 $this->ctrl->redirectByClass(ilAssQuestionHintsGUI::class, ilAssQuestionHintsGUI::CMD_SHOW_LIST);
             }
         }
 
         $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('tst_question_hints_form_invalid_msg'));
         $this->showFormCmd($form);
     }

Here is the call graph for this function:

◆ showFormCmd()

ilAssQuestionHintGUI::showFormCmd ( ?ilPropertyFormGUI $form = null )

private

Definition at line 77 of file class.ilAssQuestionHintGUI.php.

References buildForm(), ilAssQuestionHintsGUI\CMD_SHOW_LIST, ILIAS\Repository\ctrl(), and ILIAS\Repository\int().

Referenced by saveFormCmd().

                                                                  : void
     {
         if ($form instanceof ilPropertyFormGUI) {
             $form->setValuesByPost();
         } elseif ($this->request_data_collector->isset('hint_id') && (int) $this->request_data_collector->raw('hint_id')) {
             $questionHint = new ilAssQuestionHint();
 
             if (!$questionHint->load((int) $this->request_data_collector->raw('hint_id'))) {
                 $this->main_tpl->setOnScreenMessage(
                     'failure',
                     'invalid hint id given: ' . $this->request_data_collector->string('hint_id'),
                     true
                 );
                 $this->ctrl->redirectByClass(ilAssQuestionHintsGUI::class, ilAssQuestionHintsGUI::CMD_SHOW_LIST);
             }
 
             $form = $this->buildForm($questionHint);
         } else {
             $form = $this->buildForm();
         }
 
         $this->main_tpl->setContent($form->getHTML());
     }