Inheritance diagram for ilAssQuestionHintRequestGUI:

Collaboration diagram for ilAssQuestionHintRequestGUI:

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

	executeCommand ()
	Execute Command. More...

	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
	$questionGUI = null

	$questionOBJ = null

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

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

	confirmRequestCmd ()
	shows a confirmation screen for a hint request 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)
	populates the rendered questin hint relating output content to global template depending on possibly active kiosk mode More...

	isQuestionPreview ()

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

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

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

References $parentCMD, $parentGUI, ilAssQuestionHintAbstractGUI\$questionGUI, and $questionHintTracking.

Member Function Documentation

◆ backToQuestionCmd()

ilAssQuestionHintRequestGUI::backToQuestionCmd ( )

private

gateway command method to jump back to test session output

@access private @global ilCtrl $ilCtrl

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

        {
                global $ilCtrl;
                
                $ilCtrl->redirect($this->parentGUI, $this->parentCMD);
        }

References $ilCtrl.

◆ confirmRequestCmd()

ilAssQuestionHintRequestGUI::confirmRequestCmd ( )

private

shows a confirmation screen for a hint request

@access private @global ilCtrl $ilCtrl @global ilTemplate $tpl @global ilLanguage $lng

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

        {
                global $ilCtrl, $tpl, $lng;
 
                try
                {
                        $nextRequestableHint = $this->questionHintTracking->getNextRequestableHint();
                }
                catch(ilTestNoNextRequestableHintExistsException $e)
                {
                        $ilCtrl->redirect($this, self::CMD_BACK_TO_QUESTION);
                }
                
                require_once 'Services/Utilities/classes/class.ilConfirmationGUI.php';
                
                $confirmation = new ilConfirmationGUI();
                
                $formAction = ilUtil::appendUrlParameterString(
                                $ilCtrl->getFormAction($this), "hintId={$nextRequestableHint->getId()}"
                );
                                
                $confirmation->setFormAction($formAction);
                
                $confirmation->setConfirm($lng->txt('tst_question_hints_confirm_request'), self::CMD_PERFORM_REQUEST);
                $confirmation->setCancel($lng->txt('tst_question_hints_cancel_request'), self::CMD_BACK_TO_QUESTION);
                
                $confirmation->setHeaderText(sprintf(
                                $lng->txt('tst_question_hints_request_confirmation'),
                                $nextRequestableHint->getIndex(),
                                $nextRequestableHint->getPoints()
                ));
                
                $this->populateContent( $ilCtrl->getHtml($confirmation) );
        }

References $ilCtrl, $lng, $tpl, ilUtil\appendUrlParameterString(), and populateContent().

Here is the call graph for this function:

◆ executeCommand()

ilAssQuestionHintRequestGUI::executeCommand ( )

Execute Command.

@access public @global ilCtrl $ilCtrl

Returns: mixed

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

        {
                global $ilCtrl, $ilTabs, $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;
                }
        }

References $cmd, $ilCtrl, $lng, and ilAssQuestionHintPageObjectCommandForwarder\PRESENTATION_MODE_REQUEST.

◆ getHintPresentationLinkTarget()

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

returns the link target for hint request presentation

@global ilCtrl $ilCtrl

Parameters

integer	$hintId
boolean	$xmlStyle

Returns: string $linkTarget

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

        {
                global $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;
        }

References $ilCtrl.

Referenced by performRequestCmd().

Here is the caller graph for this function:

◆ isQuestionPreview()

ilAssQuestionHintRequestGUI::isQuestionPreview ( )

private

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

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

Referenced by populateContent().

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

@access private @global ilCtrl $ilCtrl

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

        {
                global $ilCtrl;
                
                if( !isset($_GET['hintId']) || !(int)$_GET['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)$_GET['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);
        }

References $_GET, $ilCtrl, getHintPresentationLinkTarget(), and ilUtil\redirect().

Here is the call graph for this function:

◆ populateContent()

ilAssQuestionHintRequestGUI::populateContent ( $content )

private

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

@global ilTemplate $tpl

Parameters

string $content

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

        {
                global $tpl;
                
                if( !$this->isQuestionPreview() && $this->parentGUI->object->getKioskMode() )
                {
                        $tpl->setBodyClass('kiosk');
                        $tpl->setAddFooter(false);
 
                        $tpl->addBlockFile(
                                        'CONTENT', '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);
                }
        }

References $tpl, and isQuestionPreview().

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

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

@access private @global ilCtrl $ilCtrl @global ilTemplate $tpl @global ilLanguage $lng

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

        {
                global $ilCtrl, $tpl, $lng;
                
                if( !isset($_GET['hintId']) || !(int)$_GET['hintId'] )
                {
                        throw new ilTestException('no hint id given');
                }
                
                $isRequested = $this->questionHintTracking->isRequested((int)$_GET['hintId']);
                
                if( !$isRequested )
                {
                        throw new ilTestException('hint with given id is not yet requested for given testactive and testpass');
                }
                
                $questionHint = ilAssQuestionHint::getInstanceById((int)$_GET['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';
 
                // build form
                
                $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->getTitle()
                ));
                
                $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('button_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( ilUtil::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) );
        }

References $_GET, $ilCtrl, $lng, $tpl, ilAssQuestionHint\getInstanceById(), populateContent(), and ilUtil\prepareTextareaOutput().

Here is the call graph for this function:

◆ showListCmd()

ilAssQuestionHintRequestGUI::showListCmd ( )

private

shows the list of allready requested hints

@access private

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

        {
                global $ilCtrl, $tpl;
                
                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) );
        }