class.ilAssQuestionHintsTableGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once 'Services/Table/classes/class.ilTable2GUI.php';
require_once 'Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php';
require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionHintRequestGUI.php';

class ilAssQuestionHintsTableGUI extends ilTable2GUI
{
        const INDEX_TO_POSITION_FACTOR = 10;
        
        const TBL_MODE_TESTOUTPUT               = '1';
        const TBL_MODE_ADMINISTRATION   = '2';
        
        private $questionOBJ = null;
        
        private $tableMode = null;
        
        private $hintOrderingClipboard = null;
        
        public function __construct(assQuestion $questionOBJ, ilAssQuestionHintList $questionHintList,
                        ilAssQuestionHintAbstractGUI $parentGUI, $parentCmd, $tableMode = self::TBL_MODE_TESTOUTPUT,
                        ilAssQuestionHintsOrderingClipboard $hintOrderingClipboard = null)
        {
                global $ilCtrl, $lng;
                
                $this->questionOBJ = $questionOBJ;
                $this->tableMode = $tableMode;
                $this->hintOrderingClipboard = $hintOrderingClipboard;
                
                $this->setPrefix('tsthints'.$tableMode);
                $this->setId('tsthints'.$tableMode);
                
                parent::__construct($parentGUI, $parentCmd);
                
                $this->setTitle( sprintf($lng->txt('tst_question_hints_table_header'), $questionOBJ->getTitle()) );
                $this->setNoEntriesText( $lng->txt('tst_question_hints_table_no_items') );
                
                // we don't take care about offset/limit values, so this avoids segmentation in general
                // --> required for ordering via clipboard feature
                $this->setExternalSegmentation(true);
                
                $tableData = $questionHintList->getTableData();
                
                if( $this->questionOBJ->isAdditionalContentEditingModePageObject() )
                {
                        require_once 'Modules/TestQuestionPool/classes/class.ilAssHintPageGUI.php';
                        
                        foreach( $tableData as $key => $data )
                        {
                                $pageObjectGUI = new ilAssHintPageGUI($data['hint_id']);
                                $pageObjectGUI->setOutputMode("presentation");
                                $tableData[$key]['hint_text'] = $pageObjectGUI->presentation();
                        }
                }
                
                $this->setData($tableData);

                if( $this->tableMode == self::TBL_MODE_ADMINISTRATION )
                {
                        $this->setRowTemplate('tpl.tst_question_hints_administration_table_row.html', 'Modules/TestQuestionPool');

                        $this->setSelectAllCheckbox('hint_ids[]');
                
                        $rowCount = count($tableData);
                        $this->initAdministrationColumns($rowCount);
                        $this->initAdministrationCommands($rowCount);
                }
                else
                {
                        $this->setRowTemplate('tpl.tst_question_hints_testoutput_table_row.html', 'Modules/TestQuestionPool');

                        $this->initTestoutputColumns();
                        $this->initTestoutputCommands();
                }
        }
        
        private function initAdministrationCommands($rowCount)
        {
                global $ilCtrl, $lng;
                
                $this->setFormAction( $ilCtrl->getFormAction($this->parent_obj) );
                
                if( $this->hintOrderingClipboard->hasStored() )
                {
                        $this->addMultiCommand(
                                        ilAssQuestionHintsGUI::CMD_PASTE_FROM_ORDERING_CLIPBOARD_BEFORE,
                                        $lng->txt('tst_questions_hints_table_multicmd_paste_hint_before')
                        );
                        
                        $this->addMultiCommand(
                                        ilAssQuestionHintsGUI::CMD_PASTE_FROM_ORDERING_CLIPBOARD_AFTER,
                                        $lng->txt('tst_questions_hints_table_multicmd_paste_hint_after')
                        );
                }
                elseif( $rowCount > 0 )
                {
                        $this->addMultiCommand(
                                        ilAssQuestionHintsGUI::CMD_CONFIRM_DELETE,
                                        $lng->txt('tst_questions_hints_table_multicmd_delete_hint')
                        );
                        
                        if( $rowCount > 1 )     $this->addMultiCommand(
                                        ilAssQuestionHintsGUI::CMD_CUT_TO_ORDERING_CLIPBOARD,
                                        $lng->txt('tst_questions_hints_table_multicmd_cut_hint')
                        );

                        $this->addCommandButton(
                                        ilAssQuestionHintsGUI::CMD_SAVE_LIST_ORDER,
                                        $lng->txt('tst_questions_hints_table_cmd_save_order')
                        );
                }
        }
        
        private function initTestoutputCommands()
        {
                if( $this->parent_obj instanceof ilAssQuestionHintsGUI )
                {
                        return;
                }
                
                global $ilCtrl, $lng;
                
                $this->setFormAction( $ilCtrl->getFormAction($this->parent_obj) );
                
                $this->addCommandButton(
                                ilAssQuestionHintRequestGUI::CMD_BACK_TO_QUESTION,
                                $lng->txt('tst_question_hints_back_to_question')
                );
        }
        
        private function initAdministrationColumns($rowCount)
        {
                global $lng;
                
                $this->addColumn( '', '', '30', true );
                
                $this->addColumn( $lng->txt('tst_question_hints_table_column_hint_order'), 'hint_index', '60');
                $this->addColumn( $lng->txt('tst_question_hints_table_column_hint_text'), 'hint_text');
                $this->addColumn( $lng->txt('tst_question_hints_table_column_hint_points'), 'hint_points', '250');
                
                $this->addColumn('', '', '100');
                
                $this->setDefaultOrderField("hint_index");
                $this->setDefaultOrderDirection("asc");
                
                if( $rowCount < 1 )
                {
                        $this->disable('header');
                }
        }
        
        private function initTestoutputColumns()
        {
                global $lng;
                
                $this->addColumn( $lng->txt('tst_question_hints_table_column_hint_index'), 'hint_index', '200');
                $this->addColumn( $lng->txt('tst_question_hints_table_column_hint_text'), 'hint_text');
                $this->addColumn( $lng->txt('tst_question_hints_table_column_hint_points'), 'hint_points', '200');
                
                $this->setDefaultOrderField("hint_index");
                $this->setDefaultOrderDirection("asc");
        }
        
        public function numericOrdering($field)
        {
                switch($field)
                {
                        case 'hint_index':
                        case 'hint_points':
                                
                                return true;
                }
                
                return false;
        }
        
        public function fillRow($rowData)
        {
                global $ilCtrl, $lng;
                
                if( $this->tableMode == self::TBL_MODE_ADMINISTRATION )
                {
                        $list = new ilAdvancedSelectionListGUI();
                        $list->setListTitle($lng->txt('actions'));
                        $list->setId("advsl_hint_{$rowData['hint_id']}_actions");

                        if( $this->questionOBJ->isAdditionalContentEditingModePageObject() )
                        {
                                $editPointsHref = $ilCtrl->getLinkTargetByClass('ilAssQuestionHintGUI', ilAssQuestionHintGUI::CMD_SHOW_FORM);
                                $editPointsHref = ilUtil::appendUrlParameterString($editPointsHref, "hint_id={$rowData['hint_id']}", true);
                                $list->addItem($lng->txt('tst_question_hints_table_link_edit_hint_points'), '', $editPointsHref);
                                
                                $editPageHref = $ilCtrl->getLinkTargetByClass('ilasshintpagegui', 'edit');
                                $editPageHref = ilUtil::appendUrlParameterString($editPageHref, "hint_id={$rowData['hint_id']}", true);
                                $list->addItem($lng->txt('tst_question_hints_table_link_edit_hint_page'), '', $editPageHref);
                        }
                        else
                        {
                                $editHref = $ilCtrl->getLinkTargetByClass('ilAssQuestionHintGUI', ilAssQuestionHintGUI::CMD_SHOW_FORM);
                                $editHref = ilUtil::appendUrlParameterString($editHref, "hint_id={$rowData['hint_id']}", true);
                                $list->addItem($lng->txt('tst_question_hints_table_link_edit_hint'), '', $editHref);
                        }
                        
                        $deleteHref = $ilCtrl->getLinkTarget($this->parent_obj, ilAssQuestionHintsGUI::CMD_CONFIRM_DELETE);
                        $deleteHref = ilUtil::appendUrlParameterString($deleteHref, "hint_id={$rowData['hint_id']}", true);
                        $list->addItem($lng->txt('tst_question_hints_table_link_delete_hint'), '', $deleteHref);

                        $this->tpl->setVariable('ACTIONS', $list->getHTML());

                        $this->tpl->setVariable('HINT_ID', $rowData['hint_id']);

                        $hintIndex = $rowData['hint_index'] * self::INDEX_TO_POSITION_FACTOR;

                }
                else
                {
                        
                        $showHref = $this->parent_obj->getHintPresentationLinkTarget($rowData['hint_id']);
                        
                        $this->tpl->setVariable('HINT_HREF', $showHref);

                        $hintIndex = ilAssQuestionHint::getHintIndexLabel($lng, $rowData['hint_index']);
                }
                
                $this->tpl->setVariable('HINT_INDEX', $hintIndex);
                $this->tpl->setVariable('HINT_TEXT', $rowData['hint_text']);
                $this->tpl->setVariable('HINT_POINTS', $rowData['hint_points']);
        }
}