Inheritance diagram for ilAssQuestionHintRequestGUI:

Collaboration diagram for ilAssQuestionHintRequestGUI:

Public Member Functions
	__construct (private ilTestPlayerAbstractGUI\|ilAssQuestionPreviewGUI $parent_gui, private string $parent_cmd, assQuestionGUI $question_gui, private $question_hint_tracking, protected ilCtrl $ctrl, protected ilLanguage $lng, private ilGlobalTemplateInterface $tpl, protected ilTabsGUI $tabs, private GlobalScreen $global_screen)

	executeCommand ()

	getHintPresentationLinkTarget ($hint_id, $xml_style=true)

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

Data Fields
const	CMD_SHOW_LIST = 'showList'

const	CMD_SHOW_HINT = 'showHint'

const	CMD_CONFIRM_REQUEST = 'confirmRequest'

const	CMD_PERFORM_REQUEST = 'performRequest'

const	CMD_BACK_TO_QUESTION = 'backToQuestion'

Private Member Functions
	showListCmd ()

	showHintCmd ()

	confirmRequestCmd ()

	performRequestCmd ()

	backToQuestionCmd ()

	populateContent ($content, $tpl)

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

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

Constructor & Destructor Documentation

◆ __construct()

ilAssQuestionHintRequestGUI::__construct	(	private ilTestPlayerAbstractGUI\|ilAssQuestionPreviewGUI	$parent_gui,
		private string	$parent_cmd,
		assQuestionGUI	$question_gui,
		private	$question_hint_tracking,
		protected ilCtrl	$ctrl,
		protected ilLanguage	$lng,
		private ilGlobalTemplateInterface	$tpl,
		protected ilTabsGUI	$tabs,
		private GlobalScreen	$global_screen
	)

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

References ILIAS\GlobalScreen\Provider\__construct().

       {
 
         parent::__construct($question_gui);
     }

Here is the call graph for this function:

Member Function Documentation

◆ backToQuestionCmd()

ilAssQuestionHintRequestGUI::backToQuestionCmd ( )

private

Definition at line 221 of file class.ilAssQuestionHintRequestGUI.php.

References ILIAS\Repository\ctrl().

                                         : void
     {
         $this->ctrl->redirect($this->parent_gui, $this->parent_cmd);
     }

Here is the call graph for this function:

◆ confirmRequestCmd()

ilAssQuestionHintRequestGUI::confirmRequestCmd ( )

private

Definition at line 157 of file class.ilAssQuestionHintRequestGUI.php.

References Vendor\Package\$e, ilUtil\appendUrlParameterString(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), populateContent(), and ilTestPlayerLayoutProvider\TEST_PLAYER_VIEW_TITLE.

                                         : void
     {
         if ($this->global_screen->tool()->context()->current()->getAdditionalData()
             ->exists(ilTestPlayerLayoutProvider::TEST_PLAYER_VIEW_TITLE)) {
             $this->global_screen->tool()->context()->current()->getAdditionalData()->replace(
                 ilTestPlayerLayoutProvider::TEST_PLAYER_VIEW_TITLE,
                 $this->parent_gui->getObject()->getTitle() . ' - ' . $this->lng->txt('tst_question_hints_confirm_request')
             );
         }
 
         try {
             $next_requestable_hint = $this->question_hint_tracking->getNextRequestableHint();
         } catch (ilTestNoNextRequestableHintExistsException $e) {
             $this->ctrl->redirect($this, self::CMD_BACK_TO_QUESTION);
         }
 
         $confirmation = new ilConfirmationGUI();
 
         $form_action = ilUtil::appendUrlParameterString(
             $this->ctrl->getFormAction($this),
             "hintId={$next_requestable_hint->getId()}"
         );
 
         $confirmation->setFormAction($form_action);
 
         $confirmation->setConfirm($this->lng->txt('tst_question_hints_confirm_request'), self::CMD_PERFORM_REQUEST);
         $confirmation->setCancel($this->lng->txt('tst_question_hints_cancel_request'), self::CMD_BACK_TO_QUESTION);
 
         if ($next_requestable_hint->getPoints() == 0.0) {
             $confirmation->setHeaderText($this->lng->txt('tst_question_hints_request_confirmation_no_deduction'));
         } else {
             $confirmation->setHeaderText(sprintf(
                 $this->lng->txt('tst_question_hints_request_confirmation'),
                 $next_requestable_hint->getIndex(),
                 $next_requestable_hint->getPoints()
             ));
         }
 
         $this->populateContent($this->ctrl->getHtml($confirmation), $this->tpl);
     }

Here is the call graph for this function:

◆ executeCommand()

ilAssQuestionHintRequestGUI::executeCommand ( )

Definition at line 55 of file class.ilAssQuestionHintRequestGUI.php.

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

     {
         $cmd = $this->ctrl->getCmd(self::CMD_SHOW_LIST);
         $next_class = $this->ctrl->getNextClass($this);
 
         switch ($next_class) {
             case 'ilasshintpagegui':
                 $forwarder = new ilAssQuestionHintPageObjectCommandForwarder(
                     $this->question_obj,
                     $this->ctrl,
                     $this->tabs,
                     $this->lng
                 );
                 $forwarder->setPresentationMode(ilAssQuestionHintPageObjectCommandForwarder::PRESENTATION_MODE_REQUEST);
                 $forwarder->forward();
                 return '';
 
             default:
                 $cmd .= 'Cmd';
                 return $this->$cmd();
         }
     }

Here is the call graph for this function:

◆ getHintPresentationLinkTarget()

ilAssQuestionHintRequestGUI::getHintPresentationLinkTarget	(	$hint_id,
		$xml_style = `true`
	)

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

References ILIAS\Repository\ctrl().

Referenced by performRequestCmd().

                                                                               : string
     {
         if ($this->question_obj->isAdditionalContentEditingModePageObject()) {
             $this->ctrl->setParameterByClass('ilasshintpagegui', 'hint_id', $hint_id);
             return $this->ctrl->getLinkTargetByClass('ilAssHintPageGUI', '', '', false, $xml_style);
         }
 
         $this->ctrl->setParameter($this, 'hintId', $hint_id);
         return $this->ctrl->getLinkTarget($this, self::CMD_SHOW_HINT, '', false, $xml_style);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ performRequestCmd()

ilAssQuestionHintRequestGUI::performRequestCmd ( )

private

Definition at line 198 of file class.ilAssQuestionHintRequestGUI.php.

References Vendor\Package\$e, ILIAS\Repository\ctrl(), getHintPresentationLinkTarget(), ILIAS\Repository\int(), and ilUtil\redirect().

                                         : void
     {
         if (!$this->request_data_collector->isset('hintId') || !(int) $this->request_data_collector->raw('hintId')) {
             throw new ilTestException('no hint id given');
         }
 
         try {
             $next_requestable_hint = $this->question_hint_tracking->getNextRequestableHint();
         } catch (ilTestNoNextRequestableHintExistsException $e) {
             $this->ctrl->redirect($this, self::CMD_BACK_TO_QUESTION);
         }
 
         if ($next_requestable_hint->getId() != (int) $this->request_data_collector->raw('hintId')) {
             throw new ilTestException('given hint id does not relate to the next requestable hint');
         }
 
         $this->question_hint_tracking->storeRequest($next_requestable_hint);
 
         $redirectTarget = $this->getHintPresentationLinkTarget($next_requestable_hint->getId(), false);
 
         ilUtil::redirect($redirectTarget);
     }

Here is the call graph for this function:

◆ populateContent()

ilAssQuestionHintRequestGUI::populateContent	(	$content,
		$tpl
	)

private

Definition at line 226 of file class.ilAssQuestionHintRequestGUI.php.

Referenced by confirmRequestCmd(), showHintCmd(), and showListCmd().

                                                     : void
     {
         $tpl->setContent($content);
         return;
     }

Here is the caller graph for this function:

◆ showHintCmd()

ilAssQuestionHintRequestGUI::showHintCmd ( )

private

Definition at line 100 of file class.ilAssQuestionHintRequestGUI.php.

References ILIAS\Repository\ctrl(), ilAssQuestionHint\getInstanceById(), ILIAS\Repository\lng(), populateContent(), ilLegacyFormElementsUtil\prepareTextareaOutput(), and ilTestPlayerLayoutProvider\TEST_PLAYER_VIEW_TITLE.

                                   : void
     {
         if (!$this->request_data_collector->isset('hintId') || $this->request_data_collector->int('hintId') === 0) {
             throw new ilTestException('no hint id given');
         }
 
         $is_requested = $this->question_hint_tracking->isRequested($this->request_data_collector->int('hintId'));
 
         if (!$is_requested) {
             throw new ilTestException('hint with given id is not yet requested for given testactive and testpass');
         }
 
         $question_hint = ilAssQuestionHint::getInstanceById((int) $this->request_data_collector->raw('hintId'));
 
         if ($this->global_screen->tool()->context()->current()->getAdditionalData()
             ->exists(ilTestPlayerLayoutProvider::TEST_PLAYER_VIEW_TITLE)) {
             $this->global_screen->tool()->context()->current()->getAdditionalData()->replace(
                 ilTestPlayerLayoutProvider::TEST_PLAYER_VIEW_TITLE,
                 $this->parent_gui->getObject()->getTitleForHTMLOutput() . ' - ' . sprintf(
                     $this->lng->txt('tst_question_hints_form_header_edit'),
                     $question_hint->getIndex(),
                     $this->request_data_collector->int('sequence') ?? 0
                 )
             );
         }
 
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this));
         $form->setTableWidth('100%');
         $form->setTitle(sprintf(
             $this->lng->txt('tst_question_hints_form_header_edit'),
             $question_hint->getIndex(),
             $this->question_obj->getTitleForHTMLOutput()
         ));
         $form->addCommandButton(self::CMD_BACK_TO_QUESTION, $this->lng->txt('tst_question_hints_back_to_question'));
 
         $num_existing_requests = $this->question_hint_tracking->getNumExistingRequests();
 
         if ($num_existing_requests > 1) {
             $form->addCommandButton(self::CMD_SHOW_LIST, $this->lng->txt('show_requested_question_hints'));
         }
 
         // form input: hint text
 
         $non_editable_hint_text = new ilNonEditableValueGUI($this->lng->txt('tst_question_hints_form_label_hint_text'), 'hint_text', true);
         $non_editable_hint_text->setValue(ilLegacyFormElementsUtil::prepareTextareaOutput($question_hint->getText(), true));
         $form->addItem($non_editable_hint_text);
 
         // form input: hint points
 
         $non_editable_hint_point = new ilNonEditableValueGUI($this->lng->txt('tst_question_hints_form_label_hint_points'), 'hint_points');
         $non_editable_hint_point->setValue($question_hint->getPoints());
         $form->addItem($non_editable_hint_point);
 
         $this->populateContent($this->ctrl->getHtml($form), $this->tpl);
     }

Here is the call graph for this function:

◆ showListCmd()

ilAssQuestionHintRequestGUI::showListCmd ( )

private

Definition at line 78 of file class.ilAssQuestionHintRequestGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), populateContent(), and ilTestPlayerLayoutProvider\TEST_PLAYER_VIEW_TITLE.

                                   : void
     {
         if ($this->global_screen->tool()->context()->current()->getAdditionalData()
             ->exists(ilTestPlayerLayoutProvider::TEST_PLAYER_VIEW_TITLE)) {
             $this->global_screen->tool()->context()->current()->getAdditionalData()->replace(
                 ilTestPlayerLayoutProvider::TEST_PLAYER_VIEW_TITLE,
                 $this->parent_gui->getObject()->getTitleForHTMLOutput() . ' - ' . $this->lng->txt('show_requested_question_hints')
             );
         }
 
         $question_hint_list = $this->question_hint_tracking->getRequestedHintsList();
 
         $table = new ilAssQuestionHintsTableGUI(
             $this->question_obj,
             $question_hint_list,
             $this,
             self::CMD_SHOW_LIST
         );
 
         $this->populateContent($this->ctrl->getHtml($table), $this->tpl);
     }