Inheritance diagram for ilAssQuestionHintPageObjectCommandForwarder:

Collaboration diagram for ilAssQuestionHintPageObjectCommandForwarder:

Public Member Functions
	__construct (assQuestion $questionOBJ, ilCtrl $ctrl, ilTabsGUI $tabs, ilLanguage $lng)
	Constructor. More...

	forward ()
	forward method More...

	getPresentationMode ()
	getter for presentation mode More...

	setPresentationMode ($presentationMode)
	setter for presentation mode More...

Public Member Functions inherited from ilAssQuestionAbstractPageObjectCommandForwarder
	__construct (protected assQuestion $questionOBJ, protected readonly ilCtrl $ctrl, protected readonly ilTabsGUI $tabs, protected ilLanguage $lng)
	Constructor. More...

	forward ()
	this is the actual forward method that is to be implemented by derived forwarder classes More...

Data Fields
const	PRESENTATION_MODE_AUTHOR = 'PRESENTATION_MODE_AUTHOR'
	presentation mode for authoring More...

const	PRESENTATION_MODE_PREVIEW = 'PRESENTATION_MODE_PREVIEW'
	presentation mode for authoring More...

const	PRESENTATION_MODE_REQUEST = 'PRESENTATION_MODE_REQUEST'
	presentation mode for requesting More...

Protected Member Functions
	getPageObjectGUI ($pageObjectType, $pageObjectId)
	instantiates, initialises and returns a page object gui object More...

	ensurePageObjectExists ($pageObjectType, $pageObjectId)
	ensures an existing page object with giben type/id More...

Protected Member Functions inherited from ilAssQuestionAbstractPageObjectCommandForwarder
	ensurePageObjectExists ($pageObjectType, $pageObjectId)
	ensures an existing page object with giben type/id More...

	getPageObjectGUI ($pageObjectType, $pageObjectId)
	instantiates, initialises and returns a page object gui object More...

Protected Attributes
	$presentationMode

	$questionHint

Protected Attributes inherited from ilAssQuestionAbstractPageObjectCommandForwarder
RequestDataCollector	$request

Private Member Functions
	buildPreviewPresentationPageObjectGUI ()
	forwards the command to page object gui for author presentation More...

	buildRequestPresentationPageObjectGUI ()
	forwards the command to page object gui for author presentation More...

	buildAuthorPresentationPageObjectGUI ()
	forwards the command to page object gui for author presentation More...

Detailed Description

Definition at line 27 of file class.ilAssQuestionHintPageObjectCommandForwarder.php.

Constructor & Destructor Documentation

◆ __construct()

ilAssQuestionHintPageObjectCommandForwarder::__construct	(	assQuestion	$questionOBJ,
		ilCtrl	$ctrl,
		ilTabsGUI	$tabs,
		ilLanguage	$lng
	)

Constructor.

public

Parameters

assQuestion	$questionOBJ
ilCtrl	$ctrl
ilTabsGUI	$tabs
ilLanguage	$lng

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilAssQuestionHintsGUI\CMD_SHOW_LIST, ILIAS\Repository\ctrl(), and ILIAS\Repository\int().

     {
         global $DIC;
         $main_tpl = $DIC->ui()->mainTemplate();
         parent::__construct($questionOBJ, $ctrl, $tabs, $lng);
 
         $this->questionHint = new ilAssQuestionHint();
 
         if (!$this->request->isset('hint_id') || !(int) $this->request->raw('hint_id') || !$this->questionHint->load((int) $this->request->raw('hint_id'))) {
             $main_tpl->setOnScreenMessage('failure', 'invalid hint id given: ' . (int) $this->request->raw('hint_id'), true);
             $this->ctrl->redirectByClass('ilAssQuestionHintsGUI', ilAssQuestionHintsGUI::CMD_SHOW_LIST);
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildAuthorPresentationPageObjectGUI()

ilAssQuestionHintPageObjectCommandForwarder::buildAuthorPresentationPageObjectGUI ( )

private

forwards the command to page object gui for author presentation

Definition at line 165 of file class.ilAssQuestionHintPageObjectCommandForwarder.php.

References ilAssQuestionHintsGUI\CMD_SHOW_LIST, ILIAS\Repository\ctrl(), ensurePageObjectExists(), getPageObjectGUI(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Referenced by forward().

                                                            : ilAssHintPageGUI
     {
         $this->tabs->setBackTarget(
             $this->lng->txt('tst_question_hints_back_to_hint_list'),
             $this->ctrl->getLinkTargetByClass('ilAssQuestionHintsGUI', ilAssQuestionHintsGUI::CMD_SHOW_LIST)
         );
 
         $this->ensurePageObjectExists(
             $this->questionHint->getPageObjectType(),
             $this->questionHint->getId()
         );
 
         $pageObjectGUI = $this->getPageObjectGUI(
             $this->questionHint->getPageObjectType(),
             $this->questionHint->getId()
         );
         $pageObjectGUI->setTemplateTargetVar('ADM_CONTENT');
         $pageObjectGUI->setTemplateOutput(true);
         $pageObjectGUI->setEnabledTabs(true);
 
         return $pageObjectGUI;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildPreviewPresentationPageObjectGUI()

ilAssQuestionHintPageObjectCommandForwarder::buildPreviewPresentationPageObjectGUI ( )

private

forwards the command to page object gui for author presentation

Definition at line 114 of file class.ilAssQuestionHintPageObjectCommandForwarder.php.

References ilAssQuestionHintsGUI\CMD_SHOW_LIST, ILIAS\Repository\ctrl(), ilAssQuestionHint\getHintIndexLabel(), getPageObjectGUI(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Referenced by forward().

                                                             : ilAssHintPageGUI
     {
         $this->tabs->setBackTarget(
             $this->lng->txt('tst_question_hints_back_to_hint_list'),
             $this->ctrl->getLinkTargetByClass('ilAssQuestionHintsGUI', ilAssQuestionHintsGUI::CMD_SHOW_LIST)
         );
 
         $pageObjectGUI = $this->getPageObjectGUI(
             $this->questionHint->getPageObjectType(),
             $this->questionHint->getId()
         );
 
         $pageObjectGUI->setEnabledTabs(false);
 
         $pageObjectGUI->setPresentationTitle(
             ilAssQuestionHint::getHintIndexLabel($this->lng, $this->questionHint->getIndex())
         );
 
         return $pageObjectGUI;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildRequestPresentationPageObjectGUI()

ilAssQuestionHintPageObjectCommandForwarder::buildRequestPresentationPageObjectGUI ( )

private

forwards the command to page object gui for author presentation

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

References ilAssQuestionHintRequestGUI\CMD_SHOW_LIST, ILIAS\Repository\ctrl(), ilAssQuestionHint\getHintIndexLabel(), getPageObjectGUI(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Referenced by forward().

                                                             : ilAssHintPageGUI
     {
         $this->tabs->setBackTarget(
             $this->lng->txt('tst_question_hints_back_to_hint_list'),
             $this->ctrl->getLinkTargetByClass('ilAssQuestionHintRequestGUI', ilAssQuestionHintRequestGUI::CMD_SHOW_LIST)
         );
 
         $pageObjectGUI = $this->getPageObjectGUI(
             $this->questionHint->getPageObjectType(),
             $this->questionHint->getId()
         );
 
         $pageObjectGUI->setEnabledTabs(false);
         $pageObjectGUI->setEnableEditing(false);
         $pageObjectGUI->setTemplateTargetVar('ADM_CONTENT');
         $pageObjectGUI->setTemplateOutput(true);
 
         $pageObjectGUI->setPresentationTitle(
             ilAssQuestionHint::getHintIndexLabel($this->lng, $this->questionHint->getIndex())
         );
 
         return $pageObjectGUI;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ensurePageObjectExists()

ilAssQuestionHintPageObjectCommandForwarder::ensurePageObjectExists	(	$pageObjectType,
		$pageObjectId
	)

protected

ensures an existing page object with giben type/id

protected

Definition at line 236 of file class.ilAssQuestionHintPageObjectCommandForwarder.php.

References ilPageObject\_exists().

Referenced by buildAuthorPresentationPageObjectGUI().

                                                                              : void
     {
         if (!ilAssHintPage::_exists($pageObjectType, $pageObjectId, '', true)) {
             $pageObject = new ilAssHintPage();
             $pageObject->setParentId($this->questionOBJ->getId());
             $pageObject->setId($pageObjectId);
             $pageObject->createFromXML();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ forward()

ilAssQuestionHintPageObjectCommandForwarder::forward ( )

forward method

Exceptions

ilTestQuestionPoolException

Definition at line 87 of file class.ilAssQuestionHintPageObjectCommandForwarder.php.

References buildAuthorPresentationPageObjectGUI(), buildPreviewPresentationPageObjectGUI(), buildRequestPresentationPageObjectGUI(), ILIAS\Repository\ctrl(), and getPresentationMode().

                              : void
     {
         switch ($this->getPresentationMode()) {
             case self::PRESENTATION_MODE_AUTHOR:
 
                 $pageObjectGUI = $this->buildAuthorPresentationPageObjectGUI();
                 break;
 
             case self::PRESENTATION_MODE_PREVIEW:
 
                 $pageObjectGUI = $this->buildPreviewPresentationPageObjectGUI();
                 break;
 
             case self::PRESENTATION_MODE_REQUEST:
 
                 $pageObjectGUI = $this->buildRequestPresentationPageObjectGUI();
                 break;
         }
 
         $this->ctrl->setParameter($pageObjectGUI, 'hint_id', $this->questionHint->getId());
 
         $this->ctrl->forwardCommand($pageObjectGUI);
     }

Here is the call graph for this function:

◆ getPageObjectGUI()

ilAssQuestionHintPageObjectCommandForwarder::getPageObjectGUI	(	$pageObjectType,
		$pageObjectId
	)

protected

instantiates, initialises and returns a page object gui object

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

Referenced by buildAuthorPresentationPageObjectGUI(), buildPreviewPresentationPageObjectGUI(), and buildRequestPresentationPageObjectGUI().

                                                                        : ilAssHintPageGUI
     {
         $pageObjectGUI = new ilAssHintPageGUI($pageObjectId);
         $pageObjectGUI->obj->addUpdateListener(
             $this->questionOBJ,
             'updateTimestamp'
         );
         return $pageObjectGUI;
     }

Here is the caller graph for this function:

◆ getPresentationMode()

ilAssQuestionHintPageObjectCommandForwarder::getPresentationMode ( )

getter for presentation mode

Returns: string

Definition at line 193 of file class.ilAssQuestionHintPageObjectCommandForwarder.php.

References $presentationMode.

Referenced by forward().

                                          : ?string
     {
         return $this->presentationMode;
     }

Here is the caller graph for this function:

◆ setPresentationMode()

ilAssQuestionHintPageObjectCommandForwarder::setPresentationMode ( $presentationMode )

setter for presentation mode

Parameters

string $presentationMode

Exceptions

ilTestQuestionPoolException

Definition at line 204 of file class.ilAssQuestionHintPageObjectCommandForwarder.php.

References $presentationMode.

                                                           : void
     {
         switch ($presentationMode) {
             case self::PRESENTATION_MODE_AUTHOR:
             case self::PRESENTATION_MODE_PREVIEW:
             case self::PRESENTATION_MODE_REQUEST:
 
                 $this->presentationMode = $presentationMode;
                 break;
 
             default: throw new ilTestQuestionPoolException('invalid presentation mode given: ' . $presentationMode);
         }
     }