ilAssQuestionHintsGUI Class Reference

Inheritance diagram for ilAssQuestionHintsGUI:

Collaboration diagram for ilAssQuestionHintsGUI:

Public Member Functions
	__construct (assQuestionGUI $questionGUI)
	Constructor. More...
	isEditingEnabled ()
	setEditingEnabled (bool $editingEnabled)
	executeCommand ()
	confirmSyncCmd ()
	getHintPresentationLinkTarget ($hintId, $xmlStyle=true)
	returns the link target for hint request presentation More...
	__construct (assQuestionGUI $questionGUI)
	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'

Protected Attributes
	$editingEnabled = false
Protected Attributes inherited from ilAssQuestionHintAbstractGUI
ILIAS TestQuestionPool InternalRequestService	$request
assQuestionGUI	$questionGUI = null
assQuestion	$questionOBJ = null
ilTabsGUI	$tabs

Private Member Functions
	showListCmd ()
	shows a table with existing hints More...
	confirmDeleteCmd ()
	shows a confirmation screen with selected hints for deletion More...
	performDeleteCmd ()
	performs confirmed deletion for selected hints More...
	saveListOrderCmd ()
	saves the order based on index values passed from table's form (the table must not be paginated, because ALL hints index values are required) More...
	cutToOrderingClipboardCmd ()
	cuts a hint from question hint list and stores it to ordering clipboard More...
	pasteFromOrderingClipboardBeforeCmd ()
	pastes a hint from ordering clipboard before the selected one More...
	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)
	returns a new quastion hint list that contains all question hints from the passed list except for the hint that is stored to ordering clipboard More...
	checkForSingleHintIdAndRedirectOnFailure ($hintIds)
	checks for a hint id in the passed array and redirects with corresponding failure message if not exactly one id is given More...
	showHintCmd ()
	shows an allready requested hint More...

Static Private Member Functions
static	fetchHintIdsParameter ()
	fetches either an array of hint ids from POST or a single hint id from GET and returns an array of (a single) hint id(s) casted to integer in both cases More...
static	fetchHintIndexesParameter ()
	fetches an array of hint index values from POST More...
static	orderHintIndexes ($hintIndexes)
	sorts the array of indexes by index value so keys (hint ids) get into new order submitted by user More...

Private Attributes
	$hintOrderingClipboard = null
ilLanguage	$lng
ilCtrl	$ctrl
ilGlobalTemplateInterface	$main_tpl

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilAssQuestionHintsGUI::__construct

(

assQuestionGUI

$questionGUI

)

Constructor.

@access public

Parameters

assQuestionGUI

$questionGUI

Reimplemented from ilAssQuestionHintAbstractGUI.

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

    {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        parent::__construct($questionGUI);
 
        $this->hintOrderingClipboard = new ilAssQuestionHintsOrderingClipboard($questionGUI->object);
    }

References $DIC, ilAssQuestionHintAbstractGUI\$questionGUI, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

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

@access private

Parameters

integer

$hintId

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

                                                                                               : void
    {
        $questionHintList = ilAssQuestionHintList::getListByQuestionId($this->questionOBJ->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);
        }
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

checkForSingleHintIdAndRedirectOnFailure()

ilAssQuestionHintsGUI::checkForSingleHintIdAndRedirectOnFailure (   $hintIds )

private

checks for a hint id in the passed array and redirects with corresponding failure message if not exactly one id is given

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

Parameters

array

$hintIds

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

                                                                       : void
    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];
 
        if (!count($hintIds)) {
            $this->main_tpl->setOnScreenMessage('failure', $lng->txt('tst_question_hints_cut_hints_missing_selection_msg'), true);
            $ilCtrl->redirect($this, self::CMD_SHOW_LIST);
        } elseif (count($hintIds) > 1) {
            $this->main_tpl->setOnScreenMessage('failure', $lng->txt('tst_question_hints_cut_hints_single_selection_msg'), true);
            $ilCtrl->redirect($this, self::CMD_SHOW_LIST);
        }
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

confirmDeleteCmd()

ilAssQuestionHintsGUI::confirmDeleteCmd ( )

private

shows a confirmation screen with selected hints for deletion

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

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

                                       : void
    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];
 
        $hintIds = self::fetchHintIdsParameter();
 
        if (!count($hintIds)) {
            $this->main_tpl->setOnScreenMessage('failure', $lng->txt('tst_question_hints_delete_hints_missing_selection_msg'), true);
            $ilCtrl->redirect($this);
        }
 
        $confirmation = new ilConfirmationGUI();
 
        $confirmation->setHeaderText($lng->txt('tst_question_hints_delete_hints_confirm_header'));
        $confirmation->setFormAction($ilCtrl->getFormAction($this));
        $confirmation->setConfirm($lng->txt('tst_question_hints_delete_hints_confirm_cmd'), self::CMD_PERFORM_DELETE);
        $confirmation->setCancel($lng->txt('cancel'), self::CMD_SHOW_LIST);
 
        $questionHintList = ilAssQuestionHintList::getListByQuestionId($this->questionOBJ->getId());
 
        foreach ($questionHintList as $questionHint) {
            /* @var $questionHint ilAssQuestionHint */
 
            if (in_array($questionHint->getId(), $hintIds)) {
                $confirmation->addItem('hint_ids[]', $questionHint->getId(), sprintf(
                    $lng->txt('tst_question_hints_delete_hints_confirm_item'),
                    $questionHint->getIndex(),
                    $questionHint->getText()
                ));
            }
        }
 
        $tpl->setContent($ilCtrl->getHtml($confirmation));
    }

References $DIC, $lng, $tpl, fetchHintIdsParameter(), ilAssQuestionHintList\getListByQuestionId(), and ilLanguage\txt().

Here is the call graph for this function:

confirmSyncCmd()

ilAssQuestionHintsGUI::confirmSyncCmd

(

)

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

                                    : void
    {
        $this->questionGUI->originalSyncForm('showHints');
    }

cutToOrderingClipboardCmd()

ilAssQuestionHintsGUI::cutToOrderingClipboardCmd ( )

private

cuts a hint from question hint list and stores it to ordering clipboard

@access private @global ilCtrl $ilCtrl

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

                                                : void
    {
        if (!$this->isEditingEnabled()) {
            return;
        }
 
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
 
        $moveHintIds = self::fetchHintIdsParameter();
        $this->checkForSingleHintIdAndRedirectOnFailure($moveHintIds);
 
        $moveHintId = current($moveHintIds);
 
        $this->checkForExistingHintRelatingToCurrentQuestionAndRedirectOnFailure($moveHintId);
 
        $this->hintOrderingClipboard->setStored($moveHintId);
 
        $ilCtrl->redirect($this, self::CMD_SHOW_LIST);
    }

References $DIC, checkForExistingHintRelatingToCurrentQuestionAndRedirectOnFailure(), checkForSingleHintIdAndRedirectOnFailure(), fetchHintIdsParameter(), and isEditingEnabled().

Here is the call graph for this function:

executeCommand()

ilAssQuestionHintsGUI::executeCommand

(

)

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

                                    : void
    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $ilTabs = $DIC['ilTabs'];
        $lng = $DIC['lng'];
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        $ilHelp = $DIC['ilHelp']; /* @var ilHelpGUI $ilHelp */
        $ilHelp->setScreenIdComponent('qpl');
 
        require_once "./Services/Style/Content/classes/class.ilObjStyleSheet.php";
        $DIC->ui()->mainTemplate()->setCurrentBlock("ContentStyle");
        $DIC->ui()->mainTemplate()->setVariable("LOCATION_CONTENT_STYLESHEET", ilObjStyleSheet::getContentStylePath(0));
        $DIC->ui()->mainTemplate()->parseCurrentBlock();
 
        $cmd = $ilCtrl->getCmd(self::CMD_SHOW_LIST);
        $nextClass = $ilCtrl->getNextClass($this);
 
        switch ($nextClass) {
            case 'ilassquestionhintgui':
 
                if (!$this->isEditingEnabled()) {
                    return;
                }
 
                require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionHintGUI.php';
                $gui = new ilAssQuestionHintGUI($this->questionGUI);
                $ilCtrl->forwardCommand($gui);
                break;
 
            case 'ilasshintpagegui':
 
                if ($this->isEditingEnabled()) {
                    $presentationMode = ilAssQuestionHintPageObjectCommandForwarder::PRESENTATION_MODE_AUTHOR;
                } else {
                    $presentationMode = ilAssQuestionHintPageObjectCommandForwarder::PRESENTATION_MODE_PREVIEW;
                }
 
                require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionHintPageObjectCommandForwarder.php';
                $forwarder = new ilAssQuestionHintPageObjectCommandForwarder($this->questionOBJ, $ilCtrl, $ilTabs, $lng);
                $forwarder->setPresentationMode($presentationMode);
                $forwarder->forward();
                break;
 
            default:
                $this->tabs->setTabActive('tst_question_hints_tab');
                $cmd .= 'Cmd';
                $this->$cmd();
                break;
        }
    }

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

Here is the call graph for this function:

fetchHintIdsParameter()

static ilAssQuestionHintsGUI::fetchHintIdsParameter ( )

staticprivate

fetches either an array of hint ids from POST or a single hint id from GET and returns an array of (a single) hint id(s) casted to integer in both cases

@access private

Returns

array $hintIds

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

                                                   : array
    {
        global $DIC;
        $request = $DIC->testQuestionPool()->internal()->request();
        $hintIds = array();
 
        if (isset($_POST['hint_ids']) && is_array($_POST['hint_ids'])) {
            foreach ($_POST['hint_ids'] as $hintId) {
                if ((int) $hintId) {
                    $hintIds[] = (int) $hintId;
                }
            }
        } elseif ($request->isset('hint_id') && (int) $request->raw('hint_id')) {
            $hintIds[] = (int) $request->raw('hint_id');
        }
 
        return $hintIds;
    }

References $DIC, ilAssQuestionHintAbstractGUI\$request, and ILIAS\Repository\int().

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

Here is the call graph for this function:

Here is the caller graph for this function:

fetchHintIndexesParameter()

static ilAssQuestionHintsGUI::fetchHintIndexesParameter ( )

staticprivate

fetches an array of hint index values from POST

@access private

Returns

array $hintIndexes

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

                                                       : array
    {
        $hintIndexes = array();
 
        if (isset($_POST['hint_indexes']) && is_array($_POST['hint_indexes'])) {
            foreach ($_POST['hint_indexes'] as $hintId => $hintIndex) {
                if ((int) $hintId) {
                    $hintIndexes[(int) $hintId] = $hintIndex;
                }
            }
        }
 
        return $hintIndexes;
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

getHintPresentationLinkTarget()

ilAssQuestionHintsGUI::getHintPresentationLinkTarget	(		$hintId,
			$xmlStyle = true
	)

returns the link target for hint request presentation

Parameters

integer	$hintId
boolean	$xmlStyle

Returns

string $linkTarget

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

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

References $DIC.

getQuestionHintListWithoutHintStoredInOrderingClipboard()

ilAssQuestionHintsGUI::getQuestionHintListWithoutHintStoredInOrderingClipboard ( ilAssQuestionHintList  $questionHintList )

private

returns a new quastion hint list that contains all question hints from the passed list except for the hint that is stored to ordering clipboard

@access private

Parameters

ilAssQuestionHintList

$questionHintList

Returns

ilAssQuestionHintList $filteredQuestionHintList

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

                                                                                                                     : ilAssQuestionHintList
    {
        $filteredQuestionHintList = new ilAssQuestionHintList();
 
        foreach ($questionHintList as $questionHint) {
            /* @var $questionHint ilAssQuestionHint */
 
            if ($questionHint->getId() != $this->hintOrderingClipboard->getStored()) {
                $filteredQuestionHintList->addHint($questionHint);
            }
        }
 
        return $filteredQuestionHintList;
    }

Referenced by showListCmd().

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

@access private @global ilLanguage $lng

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

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

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

Referenced by showListCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

isEditingEnabled()

ilAssQuestionHintsGUI::isEditingEnabled

(

)

Returns

bool

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

                                      : bool
    {
        return $this->editingEnabled;
    }

References $editingEnabled.

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

Here is the caller graph for this function:

orderHintIndexes()

static ilAssQuestionHintsGUI::orderHintIndexes (   $hintIndexes )

staticprivate

sorts the array of indexes by index value so keys (hint ids) get into new order submitted by user

@access private

Returns

array $hintIndexes

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

                                                          : array
    {
        asort($hintIndexes);
 
        return $hintIndexes;
    }

Referenced by saveListOrderCmd().

Here is the caller graph for this function:

pasteFromOrderingClipboardAfterCmd()

ilAssQuestionHintsGUI::pasteFromOrderingClipboardAfterCmd ( )

private

pastes a hint from ordering clipboard after the selected one

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

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

                                                         : void
    {
        if (!$this->isEditingEnabled()) {
            return;
        }
 
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];
 
        $targetHintIds = self::fetchHintIdsParameter();
        $this->checkForSingleHintIdAndRedirectOnFailure($targetHintIds);
 
        $targetHintId = current($targetHintIds);
 
        $this->checkForExistingHintRelatingToCurrentQuestionAndRedirectOnFailure($targetHintId);
 
        $curQuestionHintList = ilAssQuestionHintList::getListByQuestionId($this->questionOBJ->getId());
        $newQuestionHintList = new ilAssQuestionHintList($this->questionOBJ->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);
    }

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

Here is the call graph for this function:

pasteFromOrderingClipboardBeforeCmd()

ilAssQuestionHintsGUI::pasteFromOrderingClipboardBeforeCmd ( )

private

pastes a hint from ordering clipboard before the selected one

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

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

                                                          : void
    {
        if (!$this->isEditingEnabled()) {
            return;
        }
 
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];
 
        $targetHintIds = self::fetchHintIdsParameter();
        $this->checkForSingleHintIdAndRedirectOnFailure($targetHintIds);
 
        $targetHintId = current($targetHintIds);
 
        $this->checkForExistingHintRelatingToCurrentQuestionAndRedirectOnFailure($targetHintId);
 
        $curQuestionHintList = ilAssQuestionHintList::getListByQuestionId($this->questionOBJ->getId());
        $newQuestionHintList = new ilAssQuestionHintList($this->questionOBJ->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(
            $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);
 
        $ilCtrl->redirect($this, self::CMD_SHOW_LIST);
    }

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

Here is the call graph for this function:

performDeleteCmd()

ilAssQuestionHintsGUI::performDeleteCmd ( )

private

performs confirmed deletion for selected hints

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

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

                                       : void
    {
        if (!$this->isEditingEnabled()) {
            return;
        }
 
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];
 
        $hintIds = self::fetchHintIdsParameter();
 
        if (!count($hintIds)) {
            $this->main_tpl->setOnScreenMessage('failure', $lng->txt('tst_question_hints_delete_hints_missing_selection_msg'), true);
            $ilCtrl->redirect($this);
        }
 
        $questionCompleteHintList = ilAssQuestionHintList::getListByQuestionId($this->questionOBJ->getId());
 
        $questionRemainingHintList = new ilAssQuestionHintList();
 
        foreach ($questionCompleteHintList as $listKey => $questionHint) {
            /* @var $questionHint ilAssQuestionHint */
 
            if (in_array($questionHint->getId(), $hintIds)) {
                $questionHint->delete();
            } else {
                $questionRemainingHintList->addHint($questionHint);
            }
        }
 
        $questionRemainingHintList->reIndex();
 
        $this->main_tpl->setOnScreenMessage('success', $lng->txt('tst_question_hints_delete_success_msg'), true);
 
        $originalexists = $this->questionOBJ->_questionExistsInPool((int) $this->questionOBJ->getOriginalId());
        include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";
        global $DIC;
        $ilUser = $DIC['ilUser'];
        if ($this->request->raw("calling_test") && $originalexists && assQuestion::_isWriteable($this->questionOBJ->getOriginalId(), $ilUser->getId())) {
            $ilCtrl->redirectByClass('ilAssQuestionHintsGUI', ilAssQuestionHintsGUI::CMD_CONFIRM_SYNC);
        }
 
        $ilCtrl->redirect($this);
    }

References $DIC, $ilUser, $lng, $tpl, assQuestion\_isWriteable(), CMD_CONFIRM_SYNC, fetchHintIdsParameter(), ilAssQuestionHintList\getListByQuestionId(), isEditingEnabled(), and ilLanguage\txt().

Here is the call graph for this function:

resetOrderingClipboardCmd()

ilAssQuestionHintsGUI::resetOrderingClipboardCmd ( )

private

resets the ordering clipboard

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

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

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

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

Here is the call graph for this function:

saveListOrderCmd()

ilAssQuestionHintsGUI::saveListOrderCmd ( )

private

saves the order based on index values passed from table's form (the table must not be paginated, because ALL hints index values are required)

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

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

                                       : void
    {
        if (!$this->isEditingEnabled()) {
            return;
        }
 
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];
 
        $hintIndexes = self::orderHintIndexes(
            self::fetchHintIndexesParameter()
        );
 
        if (!count($hintIndexes)) {
            $this->main_tpl->setOnScreenMessage('failure', $lng->txt('tst_question_hints_save_order_unkown_failure_msg'), true);
            $ilCtrl->redirect($this);
        }
 
        $curQuestionHintList = ilAssQuestionHintList::getListByQuestionId($this->questionOBJ->getId());
 
        $newQuestionHintList = new ilAssQuestionHintList();
 
        foreach ($hintIndexes as $hintId => $hintIndex) {
            if (!$curQuestionHintList->hintExists($hintId)) {
                $this->main_tpl->setOnScreenMessage('failure', $lng->txt('tst_question_hints_save_order_unkown_failure_msg'), true);
                $ilCtrl->redirect($this);
            }
 
            $questionHint = $curQuestionHintList->getHint($hintId);
 
            $newQuestionHintList->addHint($questionHint);
        }
 
        $newQuestionHintList->reIndex();
 
        $this->main_tpl->setOnScreenMessage('success', $lng->txt('tst_question_hints_save_order_success_msg'), true);
 
        $originalexists = $this->questionOBJ->_questionExistsInPool((int) $this->questionOBJ->getOriginalId());
        include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";
        global $DIC;
        $ilUser = $DIC['ilUser'];
        if ($this->request->raw("calling_test") && $originalexists && assQuestion::_isWriteable($this->questionOBJ->getOriginalId(), $ilUser->getId())) {
            $ilCtrl->redirectByClass('ilAssQuestionHintsGUI', ilAssQuestionHintsGUI::CMD_CONFIRM_SYNC);
        }
 
        $ilCtrl->redirect($this);
    }

References $DIC, $ilUser, $lng, assQuestion\_isWriteable(), CMD_CONFIRM_SYNC, ilAssQuestionHintList\getListByQuestionId(), isEditingEnabled(), orderHintIndexes(), and ilLanguage\txt().

Here is the call graph for this function:

setEditingEnabled()

ilAssQuestionHintsGUI::setEditingEnabled

(

bool

$editingEnabled

)

Parameters

bool

$editingEnabled

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

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

References $editingEnabled.

showHintCmd()

ilAssQuestionHintsGUI::showHintCmd ( )

private

shows an allready requested hint

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

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

                                  : 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');
        }
 
        $DIC->tabs()->clearTargets();
        $DIC->tabs()->clearSubTabs();
 
        $DIC->tabs()->setBackTarget(
            $DIC->language()->txt('tst_question_hints_back_to_hint_list'),
            $DIC->ctrl()->getLinkTarget($this, self::CMD_SHOW_LIST)
        );
 
        $questionHint = ilAssQuestionHint::getInstanceById((int) $this->request->raw('hintId'));
 
        // 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->getTitleForHTMLOutput()
        ));
 
        // 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);
 
        $tpl->setContent($form->getHTML());
    }

References $DIC, $lng, $tpl, ilAssQuestionHint\getInstanceById(), ilLegacyFormElementsUtil\prepareTextareaOutput(), and ilLanguage\txt().

Here is the call graph for this function:

showListCmd()

ilAssQuestionHintsGUI::showListCmd ( )

private

shows a table with existing hints

@access private @global ilTemplate $tpl

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

                                  : void
    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];
 
        $this->initHintOrderingClipboardNotification();
 
        require_once 'Services/UIComponent/Toolbar/classes/class.ilToolbarGUI.php';
        require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionHintsTableGUI.php';
 
        $toolbar = new ilToolbarGUI();
 
        $questionHintList = ilAssQuestionHintList::getListByQuestionId($this->questionOBJ->getId());
 
        if ($this->isEditingEnabled()) {
            if ($this->hintOrderingClipboard->hasStored()) {
                $questionHintList = $this->getQuestionHintListWithoutHintStoredInOrderingClipboard($questionHintList);
 
                $toolbar->addButton(
                    $lng->txt('tst_questions_hints_toolbar_cmd_reset_ordering_clipboard'),
                    $ilCtrl->getLinkTarget($this, self::CMD_RESET_ORDERING_CLIPBOARD)
                );
            } else {
                $toolbar->addButton(
                    $lng->txt('tst_questions_hints_toolbar_cmd_add_hint'),
                    $ilCtrl->getLinkTargetByClass('ilAssQuestionHintGUI', ilAssQuestionHintGUI::CMD_SHOW_FORM)
                );
            }
 
            $tableMode = ilAssQuestionHintsTableGUI::TBL_MODE_ADMINISTRATION;
        } else {
            $tableMode = ilAssQuestionHintsTableGUI::TBL_MODE_TESTOUTPUT;
        }
 
        $table = new ilAssQuestionHintsTableGUI(
            $this->questionOBJ,
            $questionHintList,
            $this,
            self::CMD_SHOW_LIST,
            $tableMode,
            $this->hintOrderingClipboard
        );
 
        $tpl->setContent($ilCtrl->getHtml($toolbar) . $ilCtrl->getHtml($table));
    }

References $DIC, $lng, $tpl, ilAssQuestionHintGUI\CMD_SHOW_FORM, ilAssQuestionHintList\getListByQuestionId(), getQuestionHintListWithoutHintStoredInOrderingClipboard(), initHintOrderingClipboardNotification(), isEditingEnabled(), ilAssQuestionHintsTableGUI\TBL_MODE_ADMINISTRATION, ilAssQuestionHintsTableGUI\TBL_MODE_TESTOUTPUT, and ilLanguage\txt().

Here is the call graph for this function:

Field Documentation

$ctrl

ilCtrl ilAssQuestionHintsGUI::$ctrl

private

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

$editingEnabled

ilAssQuestionHintsGUI::$editingEnabled = false

protected

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

Referenced by isEditingEnabled(), and setEditingEnabled().

$hintOrderingClipboard

ilAssQuestionHintsGUI::$hintOrderingClipboard = null

private

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

$lng

ilLanguage ilAssQuestionHintsGUI::$lng

private

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

Referenced by checkForSingleHintIdAndRedirectOnFailure(), confirmDeleteCmd(), executeCommand(), initHintOrderingClipboardNotification(), pasteFromOrderingClipboardAfterCmd(), pasteFromOrderingClipboardBeforeCmd(), performDeleteCmd(), resetOrderingClipboardCmd(), saveListOrderCmd(), showHintCmd(), and showListCmd().

$main_tpl

ilGlobalTemplateInterface ilAssQuestionHintsGUI::$main_tpl

private

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

CMD_CONFIRM_DELETE

const ilAssQuestionHintsGUI::CMD_CONFIRM_DELETE = 'confirmDelete'

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

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

CMD_CONFIRM_SYNC

const ilAssQuestionHintsGUI::CMD_CONFIRM_SYNC = 'confirmSync'

Definition at line 51 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 47 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 49 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 48 of file class.ilAssQuestionHintsGUI.php.

Referenced by ilAssQuestionHintsTableGUI\initAdministrationCommands().

CMD_PERFORM_DELETE

const ilAssQuestionHintsGUI::CMD_PERFORM_DELETE = 'performDelete'

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

CMD_RESET_ORDERING_CLIPBOARD

const ilAssQuestionHintsGUI::CMD_RESET_ORDERING_CLIPBOARD = 'resetOrderingClipboard'

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

CMD_SAVE_LIST_ORDER

const ilAssQuestionHintsGUI::CMD_SAVE_LIST_ORDER = 'saveListOrder'

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

Referenced by ilAssQuestionHintsTableGUI\initAdministrationCommands().

CMD_SHOW_HINT

const ilAssQuestionHintsGUI::CMD_SHOW_HINT = 'showHint'

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

CMD_SHOW_LIST

const ilAssQuestionHintsGUI::CMD_SHOW_LIST = 'showList'

command constants

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

Referenced by ilAssQuestionHintPageObjectCommandForwarder\__construct(), assQuestionGUI\addTab_QuestionHints(), ilAssQuestionHintPageObjectCommandForwarder\buildAuthorPresentationPageObjectGUI(), ilAssQuestionHintPageObjectCommandForwarder\buildPreviewPresentationPageObjectGUI(), ilTestQuestionsTableGUI\fillRow(), ilQuestionBrowserTableGUI\fillRow(), ilAssQuestionHintGUI\saveFormCmd(), ilAssQuestionHintGUI\showFormCmd(), and assQuestionGUI\showHints().

---

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

• Modules/TestQuestionPool/classes/class.ilAssQuestionHintsGUI.php