Inheritance diagram for ilAssQuestionHintRequestGUI:

Collaboration diagram for ilAssQuestionHintRequestGUI:

Public Member Functions
	__construct ($parentGUI, $parentCMD, assQuestionGUI $questionGUI, $questionHintTracking)
	Constructor. More...

	executeCommand ()

	getHintPresentationLinkTarget ($hintId, $xmlStyle=true)
	returns the link target for hint request presentation More...

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

Data Fields
const	CMD_SHOW_LIST = 'showList'
	command constants More...

const	CMD_SHOW_HINT = 'showHint'

const	CMD_CONFIRM_REQUEST = 'confirmRequest'

const	CMD_PERFORM_REQUEST = 'performRequest'

const	CMD_BACK_TO_QUESTION = 'backToQuestion'

Protected Attributes
	$parentGUI = null

	$parentCMD = null

	$questionHintTracking = null

Protected Attributes inherited from ilAssQuestionHintAbstractGUI
ILIAS TestQuestionPool InternalRequestService	$request

assQuestionGUI	$questionGUI = null

assQuestion	$questionOBJ = null

ilTabsGUI	$tabs

Private Member Functions
	showListCmd ()
	shows the list of allready requested hints More...

	showHintCmd ()
	shows an allready requested hint More...

	performRequestCmd ()
	Performs a hint request and invokes the (re-)saving the question solution. More...

	backToQuestionCmd ()
	gateway command method to jump back to test session output More...

	populateContent ($content, $tpl)
	populates the rendered questin hint relating output content to global template depending on possibly active kiosk mode More...

	isQuestionPreview ()

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilAssQuestionHintRequestGUI::__construct	(		$parentGUI,
			$parentCMD,
		assQuestionGUI	$questionGUI,
			$questionHintTracking
	)

Constructor.

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

References $parentCMD, $parentGUI, $questionHintTracking, and ILIAS\GlobalScreen\Provider\__construct().

     {
         $this->parentGUI = $parentGUI;
         $this->parentCMD = $parentCMD;
         $this->questionHintTracking = $questionHintTracking;
 
         parent::__construct($questionGUI);
     }

Here is the call graph for this function:

Member Function Documentation

◆ backToQuestionCmd()

ilAssQuestionHintRequestGUI::backToQuestionCmd ( )

private

gateway command method to jump back to test session output

private ilCtrl $ilCtrl

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

References $DIC.

                                         : void
     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
 
         $ilCtrl->redirect($this->parentGUI, $this->parentCMD);
     }

◆ executeCommand()

ilAssQuestionHintRequestGUI::executeCommand ( )

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

References $DIC, $lng, and ilAssQuestionHintPageObjectCommandForwarder\PRESENTATION_MODE_REQUEST.

     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
         $ilTabs = $DIC['ilTabs'];
         $lng = $DIC['lng'];
 
         $cmd = $ilCtrl->getCmd(self::CMD_SHOW_LIST);
         $nextClass = $ilCtrl->getNextClass($this);
 
         switch ($nextClass) {
             case 'ilasshintpagegui':
 
                 require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionHintPageObjectCommandForwarder.php';
                 $forwarder = new ilAssQuestionHintPageObjectCommandForwarder($this->questionOBJ, $ilCtrl, $ilTabs, $lng);
                 $forwarder->setPresentationMode(ilAssQuestionHintPageObjectCommandForwarder::PRESENTATION_MODE_REQUEST);
                 $forwarder->forward();
                 break;
 
             default:
 
                 $cmd .= 'Cmd';
                 return $this->$cmd();
                 break;
         }
         return '';
     }

◆ getHintPresentationLinkTarget()

ilAssQuestionHintRequestGUI::getHintPresentationLinkTarget	(	$hintId,
		$xmlStyle = `true`
	)

returns the link target for hint request presentation

ilCtrl $ilCtrl

Parameters

integer	$hintId
boolean	$xmlStyle

Returns: string $linkTarget

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

References $DIC.

Referenced by performRequestCmd().

                                                                             : string
     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
 
         if ($this->questionOBJ->isAdditionalContentEditingModePageObject()) {
             $ilCtrl->setParameterByClass('ilasshintpagegui', 'hint_id', $hintId);
             $linkTarget = $ilCtrl->getLinkTargetByClass('ilAssHintPageGUI', '', '', false, $xmlStyle);
         } else {
             $ilCtrl->setParameter($this, 'hintId', $hintId);
             $linkTarget = $ilCtrl->getLinkTarget($this, self::CMD_SHOW_HINT, '', false, $xmlStyle);
         }
 
         return $linkTarget;
     }

Here is the caller graph for this function:

◆ isQuestionPreview()

ilAssQuestionHintRequestGUI::isQuestionPreview ( )

private

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

Referenced by populateContent().

                                         : bool
     {
         if ($this->questionHintTracking instanceof ilAssQuestionPreviewHintTracking) {
             return true;
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ performRequestCmd()

ilAssQuestionHintRequestGUI::performRequestCmd ( )

private

Performs a hint request and invokes the (re-)saving the question solution.

Redirects to local showHint command

private ilCtrl $ilCtrl

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

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

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

Here is the call graph for this function:

◆ populateContent()

ilAssQuestionHintRequestGUI::populateContent	(	$content,
		$tpl
	)

private

populates the rendered questin hint relating output content to global template depending on possibly active kiosk mode

ilTemplate $tpl

Parameters

string $content

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

References $DIC, $tpl, and isQuestionPreview().

Referenced by showHintCmd(), and showListCmd().

                                                     : void
     {
         global $DIC;
         $tpl = $DIC['tpl'];
 
         if (!$this->isQuestionPreview() && $this->parentGUI->object->getKioskMode()) {
             $tpl->hideFooter();
 
             $tpl->addBlockFile(
                 'CONTENT',
                 'kiosk_content',
                 'tpl.il_tst_question_hints_kiosk_page.html',
                 'Modules/TestQuestionPool'
             );
 
             $tpl->setVariable('KIOSK_HEAD', $this->parentGUI->getKioskHead());
 
             $tpl->setVariable('KIOSK_CONTENT', $content);
         } else {
             $tpl->setContent($content);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showHintCmd()

ilAssQuestionHintRequestGUI::showHintCmd ( )

private

shows an allready requested hint

private ilCtrl $ilCtrl ilTemplate $tpl ilLanguage $lng

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

References $DIC, Vendor\Package\$e, $lng, $tpl, ilUtil\appendUrlParameterString(), ilAssQuestionHint\getInstanceById(), ILIAS\Repository\int(), populateContent(), ilLegacyFormElementsUtil\prepareTextareaOutput(), ilNonEditableValueGUI\setValue(), and ilTestPlayerLayoutProvider\TEST_PLAYER_TITLE.

                                   : void
     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
         $tpl = $DIC['tpl'];
         $lng = $DIC['lng'];
 
         if (!$this->request->isset('hintId') || !(int) $this->request->raw('hintId')) {
             throw new ilTestException('no hint id given');
         }
 
         $isRequested = $this->questionHintTracking->isRequested((int) $this->request->raw('hintId'));
 
         if (!$isRequested) {
             throw new ilTestException('hint with given id is not yet requested for given testactive and testpass');
         }
 
         $questionHint = ilAssQuestionHint::getInstanceById((int) $this->request->raw('hintId'));
 
         require_once 'Services/Utilities/classes/class.ilUtil.php';
         require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
         require_once 'Services/Form/classes/class.ilNonEditableValueGUI.php';
 
         if ($DIC->globalScreen()->tool()->context()->current()->getAdditionalData()
             ->exists(ilTestPlayerLayoutProvider::TEST_PLAYER_TITLE)) {
             $DIC->globalScreen()->tool()->context()->current()->getAdditionalData()->replace(
                 ilTestPlayerLayoutProvider::TEST_PLAYER_TITLE,
                 $this->parentGUI->getObject()->getTitle() . ' - ' . sprintf(
                     $lng->txt('tst_question_hints_form_header_edit'),
                     $questionHint->getIndex(),
                     $this->request->int('sequence') ?? 0
                 )
             );
         }
 
         $form = new ilPropertyFormGUI();
 
         $form->setFormAction($ilCtrl->getFormAction($this));
 
         $form->setTableWidth('100%');
 
         $form->setTitle(sprintf(
             $lng->txt('tst_question_hints_form_header_edit'),
             $questionHint->getIndex(),
             $this->questionOBJ->getTitleForHTMLOutput()
         ));
 
         $form->addCommandButton(self::CMD_BACK_TO_QUESTION, $lng->txt('tst_question_hints_back_to_question'));
 
         $numExistingRequests = $this->questionHintTracking->getNumExistingRequests();
 
         if ($numExistingRequests > 1) {
             $form->addCommandButton(self::CMD_SHOW_LIST, $lng->txt('show_requested_question_hints'));
         }
 
         // form input: hint text
 
         $nonEditableHintText = new ilNonEditableValueGUI($lng->txt('tst_question_hints_form_label_hint_text'), 'hint_text', true);
         $nonEditableHintText->setValue(ilLegacyFormElementsUtil::prepareTextareaOutput($questionHint->getText(), true));
         $form->addItem($nonEditableHintText);
 
         // form input: hint points
 
         $nonEditableHintPoints = new ilNonEditableValueGUI($lng->txt('tst_question_hints_form_label_hint_points'), 'hint_points');
         $nonEditableHintPoints->setValue($questionHint->getPoints());
         $form->addItem($nonEditableHintPoints);
 
         $this->populateContent($ilCtrl->getHtml($form), $tpl);
     }

Here is the call graph for this function:

◆ showListCmd()

ilAssQuestionHintRequestGUI::showListCmd ( )

private

shows the list of allready requested hints

private

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

References $DIC, $lng, $tpl, populateContent(), and ilTestPlayerLayoutProvider\TEST_PLAYER_TITLE.

                                   : void
     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
         $tpl = $DIC['tpl'];
         $lng = $DIC['lng'];
 
         if ($DIC->globalScreen()->tool()->context()->current()->getAdditionalData()
             ->exists(ilTestPlayerLayoutProvider::TEST_PLAYER_TITLE)) {
             $DIC->globalScreen()->tool()->context()->current()->getAdditionalData()->replace(
                 ilTestPlayerLayoutProvider::TEST_PLAYER_TITLE,
                 $this->parentGUI->getObject()->getTitle() . ' - ' . $lng->txt('show_requested_question_hints')
             );
         }
 
         require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionHintsTableGUI.php';
 
         $questionHintList = $this->questionHintTracking->getRequestedHintsList();
 
         $table = new ilAssQuestionHintsTableGUI(
             $this->questionOBJ,
             $questionHintList,
             $this,
             self::CMD_SHOW_LIST
         );
 
         $this->populateContent($ilCtrl->getHtml($table), $tpl);
     }