ilAssQuestionHintsGUI Class Reference

Inheritance diagram for ilAssQuestionHintsGUI:

Collaboration diagram for ilAssQuestionHintsGUI:

Public Member Functions
	__construct (assQuestionGUI $questionGUI)
	isEditingEnabled ()
	setEditingEnabled (bool $editingEnabled)
	executeCommand ()
	confirmSyncCmd ()
	syncCmd ()
	getHintPresentationLinkTarget (int $hint_id, bool $xml_style=true)
Public Member Functions inherited from ilAssQuestionHintAbstractGUI
	__construct (assQuestionGUI $question_gui)
	Constructor. More...

Data Fields
const	CMD_SHOW_LIST = 'showList'
	command constants More...
const	CMD_SHOW_HINT = 'showHint'
const	CMD_CONFIRM_DELETE = 'confirmDelete'
const	CMD_PERFORM_DELETE = 'performDelete'
const	CMD_SAVE_LIST_ORDER = 'saveListOrder'
const	CMD_CUT_TO_ORDERING_CLIPBOARD = 'cutToOrderingClipboard'
const	CMD_PASTE_FROM_ORDERING_CLIPBOARD_BEFORE = 'pasteFromOrderingClipboardBefore'
const	CMD_PASTE_FROM_ORDERING_CLIPBOARD_AFTER = 'pasteFromOrderingClipboardAfter'
const	CMD_RESET_ORDERING_CLIPBOARD = 'resetOrderingClipboard'
const	CMD_CONFIRM_SYNC = 'confirmSync'
const	CMD_SYNC = 'sync'

Protected Attributes
bool	$editingEnabled = false
Protected Attributes inherited from ilAssQuestionHintAbstractGUI
RequestDataCollector	$request_data_collector
assQuestionGUI	$question_gui = null
assQuestion	$question_obj = null
ilTabsGUI	$tabs
ilLanguage	$lng
ilCtrl	$ctrl

Private Member Functions
	showListCmd (string $additional_content='')
	confirmDeleteCmd ()
	performDeleteCmd ()
	saveListOrderCmd ()
	cutToOrderingClipboardCmd ()
	pasteFromOrderingClipboardBeforeCmd ()
	pasteFromOrderingClipboardAfterCmd ()
	pastes a hint from ordering clipboard after the selected one More...
	resetOrderingClipboardCmd ()
	resets the ordering clipboard More...
	initHintOrderingClipboardNotification ()
	inits the notification telling the user, that a hint is stored to hint ordering clipboard More...
	checkForExistingHintRelatingToCurrentQuestionAndRedirectOnFailure ($hintId)
	checks for an existing hint relating to current question and redirects with corresponding failure message on failure More...
	getQuestionHintListWithoutHintStoredInOrderingClipboard (ilAssQuestionHintList $questionHintList)
	checkForSingleHintIdAndRedirectOnFailure (array $hint_ids)
	fetchHintIdsParameter ()
	fetchHintIndexesParameter ()
	showHintCmd ()

Private Attributes
ilAssQuestionHintsOrderingClipboard	$hintOrderingClipboard = null
GeneralQuestionPropertiesRepository	$questionrepository
ilGlobalTemplateInterface	$main_tpl

Detailed Description

Definition at line 36 of file class.ilAssQuestionHintsGUI.php.

Constructor & Destructor Documentation

__construct()

ilAssQuestionHintsGUI::__construct

(

assQuestionGUI

$questionGUI

)

Definition at line 58 of file class.ilAssQuestionHintsGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), and assQuestionGUI\getObject().

    {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();

        $local_dic = QuestionPoolDIC::dic();
        $this->questionrepository = $local_dic['question.general_properties.repository'];

        parent::__construct($questionGUI);

        $this->hintOrderingClipboard = new ilAssQuestionHintsOrderingClipboard($questionGUI->getObject());
    }

Here is the call graph for this function:

Member Function Documentation

checkForExistingHintRelatingToCurrentQuestionAndRedirectOnFailure()

ilAssQuestionHintsGUI::checkForExistingHintRelatingToCurrentQuestionAndRedirectOnFailure (   $hintId )

private

checks for an existing hint relating to current question and redirects with corresponding failure message on failure

private

Parameters

integer

$hintId

Definition at line 475 of file class.ilAssQuestionHintsGUI.php.

References ILIAS\Repository\ctrl(), ilAssQuestionHintList\getListByQuestionId(), and ILIAS\Repository\lng().

Referenced by cutToOrderingClipboardCmd(), pasteFromOrderingClipboardAfterCmd(), and pasteFromOrderingClipboardBeforeCmd().

                                                                                               : void
    {
        $questionHintList = ilAssQuestionHintList::getListByQuestionId($this->question_obj->getId());

        if (!$questionHintList->hintExists($hintId)) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('tst_question_hints_invalid_hint_id'), true);
            $this->ctrl->redirect($this, self::CMD_SHOW_LIST);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkForSingleHintIdAndRedirectOnFailure()

ilAssQuestionHintsGUI::checkForSingleHintIdAndRedirectOnFailure ( array  $hint_ids )

private

Definition at line 499 of file class.ilAssQuestionHintsGUI.php.

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by cutToOrderingClipboardCmd(), pasteFromOrderingClipboardAfterCmd(), and pasteFromOrderingClipboardBeforeCmd().

                                                                              : void
    {
        if ($hint_ids === []) {
            $this->main_tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('tst_question_hints_cut_hints_missing_selection_msg'),
                true
            );
            $this->ctrl->redirect($this, self::CMD_SHOW_LIST);
        }

        if (count($hint_ids) > 1) {
            $this->main_tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('tst_question_hints_cut_hints_single_selection_msg'),
                true
            );
            $this->ctrl->redirect($this, self::CMD_SHOW_LIST);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmDeleteCmd()

ilAssQuestionHintsGUI::confirmDeleteCmd ( )

private

Definition at line 170 of file class.ilAssQuestionHintsGUI.php.

References ILIAS\Repository\ctrl(), fetchHintIdsParameter(), ilAssQuestionHintList\getListByQuestionId(), and ILIAS\Repository\lng().

                                       : void
    {
        $hint_ids = $this->fetchHintIdsParameter();

        if (!count($hint_ids)) {
            $this->main_tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('tst_question_hints_delete_hints_missing_selection_msg'),
                true
            );
            $this->ctrl->redirectByClass(self::class);
        }

        $confirmation = new ilConfirmationGUI();

        $confirmation->setHeaderText($this->lng->txt('tst_question_hints_delete_hints_confirm_header'));
        $confirmation->setFormAction($this->ctrl->getFormAction($this));
        $confirmation->setConfirm($this->lng->txt('tst_question_hints_delete_hints_confirm_cmd'), self::CMD_PERFORM_DELETE);
        $confirmation->setCancel($this->lng->txt('cancel'), self::CMD_SHOW_LIST);

        $questionHintList = ilAssQuestionHintList::getListByQuestionId($this->question_obj->getId());

        foreach ($questionHintList as $questionHint) {
            /* @var $questionHint ilAssQuestionHint */

            if (in_array($questionHint->getId(), $hint_ids)) {
                $confirmation->addItem('hint_ids[]', $questionHint->getId(), sprintf(
                    $this->lng->txt('tst_question_hints_delete_hints_confirm_item'),
                    $questionHint->getIndex(),
                    $questionHint->getText()
                ));
            }
        }

        $this->main_tpl->setContent($this->ctrl->getHtml($confirmation));
    }

Here is the call graph for this function:

confirmSyncCmd()

ilAssQuestionHintsGUI::confirmSyncCmd

(

)

Definition at line 537 of file class.ilAssQuestionHintsGUI.php.

References showListCmd().

                                    : void
    {
        $modal = $this->question_gui->getQuestionSyncModal(self::CMD_SYNC, self::class);
        $this->showListCmd($modal);
    }

Here is the call graph for this function:

cutToOrderingClipboardCmd()

ilAssQuestionHintsGUI::cutToOrderingClipboardCmd ( )

private

Definition at line 298 of file class.ilAssQuestionHintsGUI.php.

References checkForExistingHintRelatingToCurrentQuestionAndRedirectOnFailure(), checkForSingleHintIdAndRedirectOnFailure(), ILIAS\Repository\ctrl(), fetchHintIdsParameter(), and isEditingEnabled().

                                                : void
    {
        if (!$this->isEditingEnabled()) {
            return;
        }

        $moveHintIds = $this->fetchHintIdsParameter();
        $this->checkForSingleHintIdAndRedirectOnFailure($moveHintIds);

        $moveHintId = current($moveHintIds);

        $this->checkForExistingHintRelatingToCurrentQuestionAndRedirectOnFailure($moveHintId);

        $this->hintOrderingClipboard->setStored($moveHintId);

        $this->ctrl->redirect($this, self::CMD_SHOW_LIST);
    }

Here is the call graph for this function:

executeCommand()

ilAssQuestionHintsGUI::executeCommand

(

)

Definition at line 82 of file class.ilAssQuestionHintsGUI.php.

References $DIC, ILIAS\Repository\ctrl(), ilObjStyleSheet\getContentStylePath(), isEditingEnabled(), ILIAS\Repository\lng(), ilAssQuestionHintPageObjectCommandForwarder\PRESENTATION_MODE_AUTHOR, ilAssQuestionHintPageObjectCommandForwarder\PRESENTATION_MODE_PREVIEW, and ILIAS\Repository\tabs().

                                    : void
    {
        global $DIC;
        $ilHelp = $DIC['ilHelp'];
        $ilHelp->setScreenIdComponent('qpl');

        $DIC->ui()->mainTemplate()->setCurrentBlock("ContentStyle");
        $DIC->ui()->mainTemplate()->setVariable("LOCATION_CONTENT_STYLESHEET", ilObjStyleSheet::getContentStylePath(0));
        $DIC->ui()->mainTemplate()->parseCurrentBlock();

        $cmd = $this->ctrl->getCmd(self::CMD_SHOW_LIST);
        $nextClass = $this->ctrl->getNextClass($this);

        switch ($nextClass) {
            case 'ilassquestionhintgui':
                if (!$this->isEditingEnabled()) {
                    return;
                }

                $gui = new ilAssQuestionHintGUI($this->question_gui);
                $this->ctrl->forwardCommand($gui);
                break;

            case 'ilasshintpagegui':
                if ($this->isEditingEnabled()) {
                    $presentationMode = ilAssQuestionHintPageObjectCommandForwarder::PRESENTATION_MODE_AUTHOR;
                } else {
                    $presentationMode = ilAssQuestionHintPageObjectCommandForwarder::PRESENTATION_MODE_PREVIEW;
                }

                $forwarder = new ilAssQuestionHintPageObjectCommandForwarder(
                    $this->question_obj,
                    $this->ctrl,
                    $this->tabs,
                    $this->lng
                );
                $forwarder->setPresentationMode($presentationMode);
                $forwarder->forward();
                break;

            default:
                $this->tabs->setTabActive('tst_question_hints_tab');
                $cmd .= 'Cmd';
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

fetchHintIdsParameter()

ilAssQuestionHintsGUI::fetchHintIdsParameter ( )

private

Definition at line 520 of file class.ilAssQuestionHintsGUI.php.

Referenced by confirmDeleteCmd(), cutToOrderingClipboardCmd(), pasteFromOrderingClipboardAfterCmd(), pasteFromOrderingClipboardBeforeCmd(), and performDeleteCmd().

                                            : array
    {
        $hint_ids = [$this->request_data_collector->int('hint_id')];
        if ($hint_ids[0] !== 0) {
            return $hint_ids;
        }

        return $this->request_data_collector->intArray('hint_ids');
    }

Here is the caller graph for this function:

fetchHintIndexesParameter()

ilAssQuestionHintsGUI::fetchHintIndexesParameter ( )

private

Definition at line 530 of file class.ilAssQuestionHintsGUI.php.

Referenced by saveListOrderCmd().

                                                : array
    {
        $hint_indexes = $this->request_data_collector->intArray('hint_indexes');
        asort($hint_indexes);
        return $hint_indexes;
    }

Here is the caller graph for this function:

getHintPresentationLinkTarget()

ilAssQuestionHintsGUI::getHintPresentationLinkTarget	(	int	$hint_id,
		bool	$xml_style = true
	)

Definition at line 549 of file class.ilAssQuestionHintsGUI.php.

References ILIAS\Repository\ctrl().

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

getQuestionHintListWithoutHintStoredInOrderingClipboard()

ilAssQuestionHintsGUI::getQuestionHintListWithoutHintStoredInOrderingClipboard ( ilAssQuestionHintList  $questionHintList )

private

Definition at line 485 of file class.ilAssQuestionHintsGUI.php.

Referenced by showListCmd().

     : ilAssQuestionHintList {
        $filteredQuestionHintList = new ilAssQuestionHintList();

        foreach ($questionHintList as $questionHint) {
            if ($questionHint->getId() !== $this->hintOrderingClipboard->getStored()) {
                $filteredQuestionHintList->addHint($questionHint);
            }
        }

        return $filteredQuestionHintList;
    }

Here is the caller graph for this function:

initHintOrderingClipboardNotification()

ilAssQuestionHintsGUI::initHintOrderingClipboardNotification ( )

private

inits the notification telling the user, that a hint is stored to hint ordering clipboard

private ilLanguage $lng

Definition at line 451 of file class.ilAssQuestionHintsGUI.php.

References $DIC, ilAssQuestionHintAbstractGUI\$lng, ilAssQuestionHint\getInstanceById(), and ilLanguage\txt().

Referenced by showListCmd().

                                                            : void
    {
        global $DIC;
        $lng = $DIC['lng'];

        if (!$this->hintOrderingClipboard->hasStored()) {
            return;
        }

        $questionHint = ilAssQuestionHint::getInstanceById($this->hintOrderingClipboard->getStored());

        $this->main_tpl->setOnScreenMessage('info', sprintf(
            $lng->txt('tst_question_hints_item_stored_in_ordering_clipboard'),
            $questionHint->getIndex()
        ));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isEditingEnabled()

ilAssQuestionHintsGUI::isEditingEnabled

(

)

Definition at line 72 of file class.ilAssQuestionHintsGUI.php.

References $editingEnabled.

Referenced by cutToOrderingClipboardCmd(), executeCommand(), pasteFromOrderingClipboardAfterCmd(), pasteFromOrderingClipboardBeforeCmd(), performDeleteCmd(), saveListOrderCmd(), and showListCmd().

                                      : bool
    {
        return $this->editingEnabled;
    }

Here is the caller graph for this function:

pasteFromOrderingClipboardAfterCmd()

ilAssQuestionHintsGUI::pasteFromOrderingClipboardAfterCmd ( )

private

pastes a hint from ordering clipboard after the selected one

private ilCtrl $ilCtrl ilLanguage $lng

Definition at line 372 of file class.ilAssQuestionHintsGUI.php.

References $DIC, ilAssQuestionHintAbstractGUI\$lng, ilAssQuestionHintList\addHint(), checkForExistingHintRelatingToCurrentQuestionAndRedirectOnFailure(), checkForSingleHintIdAndRedirectOnFailure(), fetchHintIdsParameter(), ilAssQuestionHint\getInstanceById(), ilAssQuestionHintList\getListByQuestionId(), isEditingEnabled(), and ilLanguage\txt().

                                                         : void
    {
        if (!$this->isEditingEnabled()) {
            return;
        }

        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];

        $targetHintIds = $this->fetchHintIdsParameter();
        $this->checkForSingleHintIdAndRedirectOnFailure($targetHintIds);

        $targetHintId = current($targetHintIds);

        $this->checkForExistingHintRelatingToCurrentQuestionAndRedirectOnFailure($targetHintId);

        $curQuestionHintList = ilAssQuestionHintList::getListByQuestionId($this->question_obj->getId());
        $newQuestionHintList = new ilAssQuestionHintList($this->question_obj->getId());

        foreach ($curQuestionHintList as $questionHint) {
            /* @var $questionHint ilAssQuestionHint */

            if ($questionHint->getId() == $this->hintOrderingClipboard->getStored()) {
                continue;
            }

            $newQuestionHintList->addHint($questionHint);

            if ($questionHint->getId() == $targetHintId) {
                $targetQuestionHint = $questionHint;

                $pasteQuestionHint = ilAssQuestionHint::getInstanceById($this->hintOrderingClipboard->getStored());

                $newQuestionHintList->addHint($pasteQuestionHint);
            }
        }

        $successMsg = sprintf(
            $lng->txt('tst_question_hints_paste_after_success_msg'),
            $pasteQuestionHint->getIndex(),
            $targetQuestionHint->getIndex()
        );

        $newQuestionHintList->reIndex();

        $this->hintOrderingClipboard->resetStored();

        $this->main_tpl->setOnScreenMessage('success', $successMsg, true);

        $ilCtrl->redirect($this, self::CMD_SHOW_LIST);
    }

Here is the call graph for this function:

pasteFromOrderingClipboardBeforeCmd()

ilAssQuestionHintsGUI::pasteFromOrderingClipboardBeforeCmd ( )

private

Definition at line 316 of file class.ilAssQuestionHintsGUI.php.

References checkForExistingHintRelatingToCurrentQuestionAndRedirectOnFailure(), checkForSingleHintIdAndRedirectOnFailure(), ILIAS\Repository\ctrl(), fetchHintIdsParameter(), ilAssQuestionHint\getInstanceById(), ilAssQuestionHintList\getListByQuestionId(), isEditingEnabled(), and ILIAS\Repository\lng().

                                                          : void
    {
        if (!$this->isEditingEnabled()) {
            return;
        }

        $targetHintIds = $this->fetchHintIdsParameter();
        $this->checkForSingleHintIdAndRedirectOnFailure($targetHintIds);

        $targetHintId = current($targetHintIds);

        $this->checkForExistingHintRelatingToCurrentQuestionAndRedirectOnFailure($targetHintId);

        $curQuestionHintList = ilAssQuestionHintList::getListByQuestionId($this->question_obj->getId());
        $newQuestionHintList = new ilAssQuestionHintList($this->question_obj->getId());

        foreach ($curQuestionHintList as $questionHint) {
            /* @var $questionHint ilAssQuestionHint */

            if ($questionHint->getId() == $this->hintOrderingClipboard->getStored()) {
                continue;
            }

            if ($questionHint->getId() == $targetHintId) {
                $targetQuestionHint = $questionHint;

                $pasteQuestionHint = ilAssQuestionHint::getInstanceById($this->hintOrderingClipboard->getStored());

                $newQuestionHintList->addHint($pasteQuestionHint);
            }

            $newQuestionHintList->addHint($questionHint);
        }

        $successMsg = sprintf(
            $this->lng->txt('tst_question_hints_paste_before_success_msg'),
            $pasteQuestionHint->getIndex(),
            $targetQuestionHint->getIndex()
        );

        $newQuestionHintList->reIndex();

        $this->hintOrderingClipboard->resetStored();

        $this->main_tpl->setOnScreenMessage('success', $successMsg, true);

        $this->ctrl->redirect($this, self::CMD_SHOW_LIST);
    }

Here is the call graph for this function:

performDeleteCmd()

ilAssQuestionHintsGUI::performDeleteCmd ( )

private

Definition at line 207 of file class.ilAssQuestionHintsGUI.php.

References CMD_CONFIRM_SYNC, ILIAS\Repository\ctrl(), fetchHintIdsParameter(), ilAssQuestionHintList\getListByQuestionId(), isEditingEnabled(), and ILIAS\Repository\lng().

                                       : void
    {
        if (!$this->isEditingEnabled()) {
            return;
        }

        $hintIds = $this->fetchHintIdsParameter();

        if (!count($hintIds)) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('tst_question_hints_delete_hints_missing_selection_msg'), true);
            $this->ctrl->redirectByClass(self::class);
        }

        $questionCompleteHintList = ilAssQuestionHintList::getListByQuestionId($this->question_obj->getId());

        $questionRemainingHintList = new ilAssQuestionHintList();

        foreach ($questionCompleteHintList as $questionHint) {
            /* @var $questionHint ilAssQuestionHint */

            if (in_array($questionHint->getId(), $hintIds)) {
                $questionHint->delete();
            } else {
                $questionRemainingHintList->addHint($questionHint);
            }
        }

        $questionRemainingHintList->reIndex();

        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('tst_question_hints_delete_success_msg'), true);

        if ($this->question_gui->needsSyncQuery()) {
            $this->ctrl->redirectByClass(
                ilAssQuestionHintsGUI::class,
                ilAssQuestionHintsGUI::CMD_CONFIRM_SYNC
            );
        }

        $this->ctrl->redirectByClass(self::class);
    }

Here is the call graph for this function:

resetOrderingClipboardCmd()

ilAssQuestionHintsGUI::resetOrderingClipboardCmd ( )

private

resets the ordering clipboard

private ilCtrl $ilCtrl ilLanguage $lng

Definition at line 432 of file class.ilAssQuestionHintsGUI.php.

References $DIC, ilAssQuestionHintAbstractGUI\$lng, and ilLanguage\txt().

                                                : void
    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];

        $this->hintOrderingClipboard->resetStored();

        $this->main_tpl->setOnScreenMessage('info', $lng->txt('tst_question_hints_ordering_clipboard_resetted'), true);
        $ilCtrl->redirect($this, self::CMD_SHOW_LIST);
    }

Here is the call graph for this function:

saveListOrderCmd()

ilAssQuestionHintsGUI::saveListOrderCmd ( )

private

Definition at line 248 of file class.ilAssQuestionHintsGUI.php.

References CMD_CONFIRM_SYNC, ILIAS\Repository\ctrl(), fetchHintIndexesParameter(), ilAssQuestionHintList\getListByQuestionId(), isEditingEnabled(), and ILIAS\Repository\lng().

                                       : void
    {
        if (!$this->isEditingEnabled()) {
            return;
        }

        $hintIndexes = $this->fetchHintIndexesParameter();

        if (!count($hintIndexes)) {
            $this->main_tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('tst_question_hints_save_order_unkown_failure_msg'),
                true
            );
            $this->ctrl->redirectByClass(self::class);
        }

        $curQuestionHintList = ilAssQuestionHintList::getListByQuestionId($this->question_obj->getId());

        $newQuestionHintList = new ilAssQuestionHintList();

        foreach (array_keys($hintIndexes) as $hintId) {
            if (!$curQuestionHintList->hintExists($hintId)) {
                $this->main_tpl->setOnScreenMessage(
                    'failure',
                    $this->lng->txt('tst_question_hints_save_order_unkown_failure_msg'),
                    true
                );
                $this->ctrl->redirectByClass(self::class);
            }

            $questionHint = $curQuestionHintList->getHint($hintId);

            $newQuestionHintList->addHint($questionHint);
        }

        $newQuestionHintList->reIndex();

        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('tst_question_hints_save_order_success_msg'), true);

        if ($this->question_gui->needsSyncQuery()) {
            $this->ctrl->redirectByClass(
                ilAssQuestionHintsGUI::class,
                ilAssQuestionHintsGUI::CMD_CONFIRM_SYNC
            );
        }

        $this->ctrl->redirectByClass(self::class);
    }

Here is the call graph for this function:

setEditingEnabled()

ilAssQuestionHintsGUI::setEditingEnabled

(

bool

$editingEnabled

)

Definition at line 77 of file class.ilAssQuestionHintsGUI.php.

References $editingEnabled.

                                                           : void
    {
        $this->editingEnabled = $editingEnabled;
    }

showHintCmd()

ilAssQuestionHintsGUI::showHintCmd ( )

private

Definition at line 562 of file class.ilAssQuestionHintsGUI.php.

References ILIAS\Repository\ctrl(), ilAssQuestionHint\getInstanceById(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ilLegacyFormElementsUtil\prepareTextareaOutput(), and ILIAS\Repository\tabs().

                                  : void
    {
        if (!$this->request_data_collector->isset('hintId') || !(int) $this->request_data_collector->raw('hintId')) {
            throw new ilTestException('no hint id given');
        }

        $this->tabs->clearTargets();
        $this->tabs->clearSubTabs();

        $this->tabs->setBackTarget(
            $this->lng->txt('tst_question_hints_back_to_hint_list'),
            $this->ctrl->getLinkTargetByClass(self::class, self::CMD_SHOW_LIST)
        );

        $questionHint = ilAssQuestionHint::getInstanceById((int) $this->request_data_collector->raw('hintId'));

        // build form

        $form = new ilPropertyFormGUI();

        $form->setFormAction($this->ctrl->getFormAction($this));

        $form->setTableWidth('100%');

        $form->setTitle(sprintf(
            $this->lng->txt('tst_question_hints_form_header_edit'),
            $questionHint->getIndex(),
            $this->question_obj->getTitleForHTMLOutput()
        ));

        // form input: hint text

        $nonEditableHintText = new ilNonEditableValueGUI(
            $this->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(
            $this->lng->txt('tst_question_hints_form_label_hint_points'),
            'hint_points'
        );
        $nonEditableHintPoints->setValue($questionHint->getPoints());
        $form->addItem($nonEditableHintPoints);

        $this->main_tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

showListCmd()

ilAssQuestionHintsGUI::showListCmd ( string  $additional_content = '' )

private

Definition at line 130 of file class.ilAssQuestionHintsGUI.php.

References ilAssQuestionHintGUI\CMD_SHOW_FORM, ILIAS\Repository\ctrl(), ilAssQuestionHintList\getListByQuestionId(), getQuestionHintListWithoutHintStoredInOrderingClipboard(), initHintOrderingClipboardNotification(), isEditingEnabled(), ILIAS\Repository\lng(), ilAssQuestionHintsTableGUI\TBL_MODE_ADMINISTRATION, and ilAssQuestionHintsTableGUI\TBL_MODE_TESTOUTPUT.

Referenced by confirmSyncCmd(), and syncCmd().

                                                                 : void
    {
        $this->initHintOrderingClipboardNotification();

        $toolbar = new ilToolbarGUI();

        $questionHintList = ilAssQuestionHintList::getListByQuestionId($this->question_obj->getId());

        if ($this->isEditingEnabled()) {
            if ($this->hintOrderingClipboard->hasStored()) {
                $questionHintList = $this->getQuestionHintListWithoutHintStoredInOrderingClipboard($questionHintList);

                $toolbar->addButton(
                    $this->lng->txt('tst_questions_hints_toolbar_cmd_reset_ordering_clipboard'),
                    $this->ctrl->getLinkTarget($this, self::CMD_RESET_ORDERING_CLIPBOARD)
                );
            } else {
                $toolbar->addButton(
                    $this->lng->txt('tst_questions_hints_toolbar_cmd_add_hint'),
                    $this->ctrl->getLinkTargetByClass('ilAssQuestionHintGUI', ilAssQuestionHintGUI::CMD_SHOW_FORM)
                );
            }

            $tableMode = ilAssQuestionHintsTableGUI::TBL_MODE_ADMINISTRATION;
        } else {
            $tableMode = ilAssQuestionHintsTableGUI::TBL_MODE_TESTOUTPUT;
        }

        $table = new ilAssQuestionHintsTableGUI(
            $this->question_obj,
            $questionHintList,
            $this,
            self::CMD_SHOW_LIST,
            $tableMode,
            $this->hintOrderingClipboard
        );

        $this->main_tpl->setContent($toolbar->getHTML() . $table->getHTML() . $additional_content);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

syncCmd()

ilAssQuestionHintsGUI::syncCmd

(

)

Definition at line 543 of file class.ilAssQuestionHintsGUI.php.

References showListCmd().

                             : void
    {
        $this->question_obj->syncWithOriginal();
        $this->showListCmd();
    }

Here is the call graph for this function:

Field Documentation

$editingEnabled

bool ilAssQuestionHintsGUI::$editingEnabled = false

protected

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

Referenced by isEditingEnabled(), and setEditingEnabled().

$hintOrderingClipboard

ilAssQuestionHintsOrderingClipboard ilAssQuestionHintsGUI::$hintOrderingClipboard = null

private

Definition at line 53 of file class.ilAssQuestionHintsGUI.php.

$main_tpl

ilGlobalTemplateInterface ilAssQuestionHintsGUI::$main_tpl

private

Definition at line 56 of file class.ilAssQuestionHintsGUI.php.

$questionrepository

GeneralQuestionPropertiesRepository ilAssQuestionHintsGUI::$questionrepository

private

Definition at line 54 of file class.ilAssQuestionHintsGUI.php.

CMD_CONFIRM_DELETE

const ilAssQuestionHintsGUI::CMD_CONFIRM_DELETE = 'confirmDelete'

Definition at line 43 of file class.ilAssQuestionHintsGUI.php.

Referenced by ilAssQuestionHintsTableGUI\fillRow(), and ilAssQuestionHintsTableGUI\initAdministrationCommands().

CMD_CONFIRM_SYNC

const ilAssQuestionHintsGUI::CMD_CONFIRM_SYNC = 'confirmSync'

Definition at line 50 of file class.ilAssQuestionHintsGUI.php.

Referenced by performDeleteCmd(), ilAssQuestionHintGUI\saveFormCmd(), and saveListOrderCmd().

CMD_CUT_TO_ORDERING_CLIPBOARD

const ilAssQuestionHintsGUI::CMD_CUT_TO_ORDERING_CLIPBOARD = 'cutToOrderingClipboard'

Definition at line 46 of file class.ilAssQuestionHintsGUI.php.

Referenced by ilAssQuestionHintsTableGUI\initAdministrationCommands().

CMD_PASTE_FROM_ORDERING_CLIPBOARD_AFTER

const ilAssQuestionHintsGUI::CMD_PASTE_FROM_ORDERING_CLIPBOARD_AFTER = 'pasteFromOrderingClipboardAfter'

Definition at line 48 of file class.ilAssQuestionHintsGUI.php.

Referenced by ilAssQuestionHintsTableGUI\initAdministrationCommands().

CMD_PASTE_FROM_ORDERING_CLIPBOARD_BEFORE

const ilAssQuestionHintsGUI::CMD_PASTE_FROM_ORDERING_CLIPBOARD_BEFORE = 'pasteFromOrderingClipboardBefore'

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

Referenced by ilAssQuestionHintsTableGUI\initAdministrationCommands().

CMD_PERFORM_DELETE

const ilAssQuestionHintsGUI::CMD_PERFORM_DELETE = 'performDelete'

Definition at line 44 of file class.ilAssQuestionHintsGUI.php.

CMD_RESET_ORDERING_CLIPBOARD

const ilAssQuestionHintsGUI::CMD_RESET_ORDERING_CLIPBOARD = 'resetOrderingClipboard'

Definition at line 49 of file class.ilAssQuestionHintsGUI.php.

CMD_SAVE_LIST_ORDER

const ilAssQuestionHintsGUI::CMD_SAVE_LIST_ORDER = 'saveListOrder'

Definition at line 45 of file class.ilAssQuestionHintsGUI.php.

Referenced by ilAssQuestionHintsTableGUI\initAdministrationCommands().

CMD_SHOW_HINT

const ilAssQuestionHintsGUI::CMD_SHOW_HINT = 'showHint'

Definition at line 42 of file class.ilAssQuestionHintsGUI.php.

CMD_SHOW_LIST

const ilAssQuestionHintsGUI::CMD_SHOW_LIST = 'showList'

command constants

Definition at line 41 of file class.ilAssQuestionHintsGUI.php.

Referenced by ilAssQuestionHintPageObjectCommandForwarder\__construct(), assQuestionGUI\addTab_QuestionHints(), ilAssQuestionHintPageObjectCommandForwarder\buildAuthorPresentationPageObjectGUI(), ilAssQuestionHintPageObjectCommandForwarder\buildPreviewPresentationPageObjectGUI(), ilQuestionBrowserTableGUI\fillRow(), ILIAS\Test\Questions\Presentation\QuestionsTableActions\handleCommand(), ilAssQuestionHintGUI\saveFormCmd(), ilAssQuestionHintGUI\showFormCmd(), and assQuestionGUI\showHints().

CMD_SYNC

const ilAssQuestionHintsGUI::CMD_SYNC = 'sync'

Definition at line 51 of file class.ilAssQuestionHintsGUI.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/TestQuestionPool/classes/class.ilAssQuestionHintsGUI.php