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...

	__construct (assQuestion $questionOBJ, ilCtrl $ctrl, ilTabsGUI $tabs, 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...

	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
ILIAS TestQuestionPool InternalRequestService	$request

	$questionOBJ = null

	$ctrl = null

	$tabs = null

	$lng = null

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.

@access public

Parameters

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

Reimplemented from ilAssQuestionAbstractPageObjectCommandForwarder.

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

    {
        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);
        }
    }

References ilAssQuestionAbstractPageObjectCommandForwarder\$ctrl, $DIC, ilAssQuestionAbstractPageObjectCommandForwarder\$lng, ilAssQuestionAbstractPageObjectCommandForwarder\$questionOBJ, ilAssQuestionAbstractPageObjectCommandForwarder\$tabs, ILIAS\GlobalScreen\Provider\__construct(), ilAssQuestionHintsGUI\CMD_SHOW_LIST, and ILIAS\Repository\ctrl().

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 163 of file class.ilAssQuestionHintPageObjectCommandForwarder.php.

                                                           : 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->setEnabledTabs(true);
 
        return $pageObjectGUI;
    }

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

Referenced by forward().

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.

                                                            : 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;
    }

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

Referenced by forward().

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.

                                                            : 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->setPresentationTitle(
            ilAssQuestionHint::getHintIndexLabel($this->lng, $this->questionHint->getIndex())
        );
 
        return $pageObjectGUI;
    }

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

Referenced by forward().

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

@access protected

Reimplemented from ilAssQuestionAbstractPageObjectCommandForwarder.

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

                                                                             : void
    {
        include_once("./Modules/TestQuestionPool/classes/class.ilAssHintPage.php");
        if (!ilAssHintPage::_exists($pageObjectType, $pageObjectId, '', true)) {
            $pageObject = new ilAssHintPage();
            $pageObject->setParentId($this->questionOBJ->getId());
            $pageObject->setId($pageObjectId);
            $pageObject->createFromXML();
        }
    }

References ilPageObject\_exists().

Referenced by buildAuthorPresentationPageObjectGUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ forward()

ilAssQuestionHintPageObjectCommandForwarder::forward ( )

forward method

Exceptions

ilTestQuestionPoolException

Reimplemented from ilAssQuestionAbstractPageObjectCommandForwarder.

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

                             : 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);
    }

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

Here is the call graph for this function:

◆ getPageObjectGUI()

ilAssQuestionHintPageObjectCommandForwarder::getPageObjectGUI	(	$pageObjectType,
		$pageObjectId
	)

protected

instantiates, initialises and returns a page object gui object

Reimplemented from ilAssQuestionAbstractPageObjectCommandForwarder.

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

                                                                       : ilAssHintPageGUI
    {
        include_once("./Modules/TestQuestionPool/classes/class.ilAssHintPageGUI.php");
        $pageObjectGUI = new ilAssHintPageGUI($pageObjectId);
        $pageObjectGUI->obj->addUpdateListener(
            $this->questionOBJ,
            'updateTimestamp'
        );
        return $pageObjectGUI;
    }

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

Here is the caller graph for this function:

◆ getPresentationMode()

ilAssQuestionHintPageObjectCommandForwarder::getPresentationMode ( )

getter for presentation mode

Returns: string

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

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

References $presentationMode.

Referenced by forward().

Here is the caller graph for this function:

◆ setPresentationMode()

ilAssQuestionHintPageObjectCommandForwarder::setPresentationMode ( $presentationMode )

setter for presentation mode

Parameters

string $presentationMode

Exceptions

ilTestQuestionPoolException

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

                                                          : 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);
        }
    }