ilObjAssessmentFolderGUI Class Reference

Class ilObjAssessmentFolderGUI. More...

Inheritance diagram for ilObjAssessmentFolderGUI:

Collaboration diagram for ilObjAssessmentFolderGUI:

Public Member Functions
	__construct ($a_data, int $a_id=0, bool $a_call_by_reference=true, bool $a_prepare_output=true)
	executeCommand ()
	settingsObject (ilPropertyFormGUI $form=null)
	saveSettingsObject ()
	Save Assessment settings. More...
	showLogObject ()
	Called when the a log should be shown. More...
	exportLogObject ()
	Called when the a log should be exported. More...
	logsObject (ilPropertyFormGUI $form=null)
	deleteLogObject ()
	Deletes the log entries for one or more tests. More...
	logAdminObject ()
	Administration output for assessment log files. More...
	getAdminTabs ()
	getLogdataSubtabs ()
Public Member Functions inherited from ilObjectGUI
	__construct ($data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true)
	getRefId ()
	setAdminMode (string $mode)
	getAdminMode ()
	getObject ()
	executeCommand ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...
	getCreationMode ()
	prepareOutput (bool $show_sub_objects=true)
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
	cancelObject ()
	cancel action and go back to previous page More...
	createObject ()
	create new object form More...
	editAvailabilityPeriodObject ()
	saveAvailabilityPeriodObject ()
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	addExternalEditFormCustom (ilPropertyFormGUI $form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...
	isVisible (int $ref_id, string $type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...
	setColumnSettings (ilColumnGUI $column_gui)
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen. More...
	addToDeskObject ()
	removeFromDeskObject ()
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Protected Member Functions
	getLogDataOutputForm ()
	getTabs ()
	showLogSettingsObject (ilPropertyFormGUI $form=null)
	saveLogSettingsObject ()
	getLogSettingsForm ()
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	assignObject ()
	setTitleAndDescription ()
	createActionDispatcherGUI ()
	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...
	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	setTabs ()
	set admin tabs More...
	setAdminTabs ()
	set admin tabs More...
	setLocator ()
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator (bool $omit=true)
	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms (string $new_type)
	Init creation forms. More...
	getCreationFormsHTML (array $forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm (string $new_type)
	initDidacticTemplate (ilPropertyFormGUI $form)
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	addAdoptContentLinkToToolbar ()
	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)
	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm (string $new_type)
	importFileObject (int $parent_id=null)
	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...
	setFormAction (string $cmd, string $form_action)
	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...
	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...
	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...
	getTabs ()
	overwrite in derived GUI class of your object type More...
	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

Protected Attributes
ILIAS TestQuestionPool QuestionInfoService	$questioninfo
ILIAS Test InternalRequestService	$testrequest
Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service
ServerRequestInterface	$request
ilLocatorGUI	$locator
ilObjUser	$user
ilAccessHandler	$access
ilSetting	$settings
ilToolbarGUI	$toolbar
ilRbacAdmin	$rbac_admin
ilRbacSystem	$rbac_system
ilRbacReview	$rbac_review
ilObjectService	$object_service
ilObjectDefinition	$obj_definition
ilGlobalTemplateInterface	$tpl
ilTree	$tree
ilCtrl	$ctrl
ilErrorHandling	$error
ilLanguage	$lng
ilTabsGUI	$tabs_gui
ILIAS	$ilias
ArrayBasedRequestWrapper	$post_wrapper
RequestWrapper	$request_wrapper
Factory	$refinery
ilFavouritesManager	$favourites
ilObjectCustomIconFactory	$custom_icon_factory
UIFactory	$ui_factory
UIRenderer	$ui_renderer
ilObject	$object = null
bool	$creation_mode = false
	$data
int	$id
bool	$call_by_reference = false
bool	$prepare_output
int	$ref_id
int	$obj_id
int	$maxcount
array	$form_action = []
array	$return_location = []
array	$target_frame = []
string	$tmp_import_dir
string	$sub_objects = ""
bool	$omit_locator = false
string	$type = ""
string	$admin_mode = self::ADMIN_MODE_NONE
int	$requested_ref_id = 0
int	$requested_crtptrefid = 0
int	$requested_crtcb = 0
string	$requested_new_type = ""
string	$link_params
string	$html = ""

Private Member Functions
	getAssessmentFolder ()
	buildSettingsForm ()

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode (int $ref_id, string $cmd="")
static	_gotoSharedWorkspaceNode (int $wsp_id)
Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
const	ADMIN_MODE_NONE = ""
const	ADMIN_MODE_SETTINGS = "settings"
const	ADMIN_MODE_REPOSITORY = "repository"
const	UPLOAD_TYPE_LOCAL = 1
const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3

Detailed Description

Class ilObjAssessmentFolderGUI.

Author

Helmut Schottmüller hscho.nosp@m.ttm@.nosp@m.gmx.d.nosp@m.e ilObjAssessmentFolderGUI: ilPermissionGUI, ilGlobalUnitConfigurationGUI

Definition at line 26 of file class.ilObjAssessmentFolderGUI.php.

Constructor & Destructor Documentation

__construct()

ilObjAssessmentFolderGUI::__construct	(		$a_data,
		int	$a_id = 0,
		bool	$a_call_by_reference = true,
		bool	$a_prepare_output = true
	)

Definition at line 31 of file class.ilObjAssessmentFolderGUI.php.

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), and ILIAS\Repository\lng().

    {
        global $DIC;
        $rbacsystem = $DIC['rbacsystem'];
        $this->testrequest = $DIC->test()->internal()->request();
        $this->questioninfo = $DIC->testQuestionPool()->questionInfo();
        $this->type = "assf";
        parent::__construct($a_data, $a_id, $a_call_by_reference, false);

        if (!$rbacsystem->checkAccess('read', $this->object->getRefId())) {
            $this->ilias->raiseError($this->lng->txt("msg_no_perm_read_assf"), $this->ilias->error_obj->WARNING);
        }

        $this->lng->loadLanguageModule('assessment');
    }

Here is the call graph for this function:

Member Function Documentation

buildSettingsForm()

ilObjAssessmentFolderGUI::buildSettingsForm ( )

private

Definition at line 100 of file class.ilObjAssessmentFolderGUI.php.

References ilObjAssessmentFolder\_getForbiddenQuestionTypes(), ilObjAssessmentFolder\_getManualScoring(), ilObjQuestionPool\_getQuestionTypes(), ILIAS\Repository\access(), ilObjAssessmentFolder\ASS_PROC_LOCK_MODE_DB, ilObjAssessmentFolder\ASS_PROC_LOCK_MODE_FILE, ilObjAssessmentFolder\ASS_PROC_LOCK_MODE_NONE, ILIAS\Repository\ctrl(), getAssessmentFolder(), ILIAS\Repository\lng(), ilRadioOption\setInfo(), ilFormPropertyGUI\setInfo(), ilFormPropertyGUI\setRequired(), and ilColorPickerInputGUI\setValue().

Referenced by saveSettingsObject(), and settingsObject().

                                        : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTableWidth("100%");
        $form->setId("settings");

        $header = new ilFormSectionHeaderGUI();
        $header->setTitle($this->lng->txt('settings'));
        $form->addItem($header);

        // question process locking behaviour (e.g. on saving users working data)
        $chb = new ilCheckboxInputGUI($this->lng->txt('ass_process_lock'), 'ass_process_lock');
        $chb->setChecked($this->getAssessmentFolder()->getAssessmentProcessLockMode() !== ilObjAssessmentFolder::ASS_PROC_LOCK_MODE_NONE);
        $chb->setInfo($this->lng->txt('ass_process_lock_desc'));
        $form->addItem($chb);
        $rg = new ilRadioGroupInputGUI($this->lng->txt('ass_process_lock_mode'), 'ass_process_lock_mode');
        $rg->setRequired(true);
        $opt = new ilRadioOption(
            $this->lng->txt('ass_process_lock_mode_file'),
            ilObjAssessmentFolder::ASS_PROC_LOCK_MODE_FILE
        );
        $opt->setInfo($this->lng->txt('ass_process_lock_mode_file_desc'));
        $rg->addOption($opt);
        $opt = new ilRadioOption(
            $this->lng->txt('ass_process_lock_mode_db'),
            ilObjAssessmentFolder::ASS_PROC_LOCK_MODE_DB
        );
        $opt->setInfo($this->lng->txt('ass_process_lock_mode_db_desc'));
        $rg->addOption($opt);
        if ($this->getAssessmentFolder()->getAssessmentProcessLockMode() !== ilObjAssessmentFolder::ASS_PROC_LOCK_MODE_NONE) {
            $rg->setValue($this->getAssessmentFolder()->getAssessmentProcessLockMode());
        }
        $chb->addSubItem($rg);

        $assessmentSetting = new ilSetting('assessment');
        $imap_line_color = $assessmentSetting->get('imap_line_color');
        if ($this->testrequest->isset('imap_line_color')) {
            $imap_line_color = $this->testrequest->strVal('imap_line_color');
        }
        if ($imap_line_color == '') {
            $imap_line_color = 'FF0000';
        }

        $linepicker = new ilColorPickerInputGUI($this->lng->txt('assessment_imap_line_color'), 'imap_line_color');
        $linepicker->setValue($imap_line_color);
        $form->addItem($linepicker);

        $user_criteria = $assessmentSetting->get('user_criteria');
        if ($this->testrequest->isset('user_criteria')) {
            $user_criteria = $this->testrequest->strVal('user_criteria');
        }
        $userCriteria = new ilSelectInputGUI($this->lng->txt('user_criteria'), 'user_criteria');
        $userCriteria->setInfo($this->lng->txt('user_criteria_desc'));
        $userCriteria->setRequired(true);

        $fields = ['usr_id', 'login', 'email', 'matriculation', 'ext_account'];
        $usr_fields = [];
        foreach ($fields as $field) {
            $usr_fields[$field] = $field;
        }
        $userCriteria->setOptions($usr_fields);
        $userCriteria->setValue($user_criteria);
        $form->addItem($userCriteria);

        $numRequiredAnswers = new ilNumberInputGUI(
            $this->lng->txt('tst_skill_triggerings_num_req_answers'),
            'num_req_answers'
        );
        $numRequiredAnswers->setInfo($this->lng->txt('tst_skill_triggerings_num_req_answers_desc'));
        $numRequiredAnswers->setSize(4);
        $numRequiredAnswers->allowDecimals(false);
        $numRequiredAnswers->setMinValue(1);
        $numRequiredAnswers->setMinvalueShouldBeGreater(false);
        $numRequiredAnswers->setValue($this->getAssessmentFolder()->getSkillTriggeringNumAnswersBarrier());
        $form->addItem($numRequiredAnswers);

        $ceeqwh = new ilCheckboxInputGUI($this->lng->txt('export_essay_qst_with_html'), 'export_essay_qst_with_html');
        $ceeqwh->setChecked($this->getAssessmentFolder()->getExportEssayQuestionsWithHtml());
        $ceeqwh->setInfo($this->lng->txt('export_essay_qst_with_html_desc'));
        $form->addItem($ceeqwh);

        // question settings
        $header = new ilFormSectionHeaderGUI();
        $header->setTitle($this->lng->txt("assf_questiontypes"));
        $form->addItem($header);

        // available question types
        $allowed = new ilCheckboxGroupInputGUI(
            $this->lng->txt('assf_allowed_questiontypes'),
            "chb_allowed_questiontypes"
        );
        $questiontypes = ilObjQuestionPool::_getQuestionTypes(true);
        $forbidden_types = ilObjAssessmentFolder::_getForbiddenQuestionTypes();
        $allowedtypes = [];
        foreach ($questiontypes as $qt) {
            if (!in_array($qt['question_type_id'], $forbidden_types)) {
                $allowedtypes[] = $qt['question_type_id'];
            }
        }
        $allowed->setValue($allowedtypes);
        foreach ($questiontypes as $type_name => $qtype) {
            $allowed->addOption(new ilCheckboxOption($type_name, (string) $qtype["question_type_id"]));
        }
        $allowed->setInfo($this->lng->txt('assf_allowed_questiontypes_desc'));
        $form->addItem($allowed);

        // manual scoring
        $manual = new ilCheckboxGroupInputGUI(
            $this->lng->txt('assessment_log_manual_scoring_activate'),
            "chb_manual_scoring"
        );
        $manscoring = ilObjAssessmentFolder::_getManualScoring();
        $manual->setValue($manscoring);
        foreach ($questiontypes as $type_name => $qtype) {
            $manual->addOption(new ilCheckboxOption($type_name, (string) $qtype["question_type_id"]));
        }
        $manual->setInfo($this->lng->txt('assessment_log_manual_scoring_desc'));
        $form->addItem($manual);

        // scoring adjustment active
        $scoring_activation = new ilCheckboxInputGUI(
            $this->lng->txt('assessment_scoring_adjust'),
            'chb_scoring_adjust'
        );
        $scoring_activation->setChecked($this->getAssessmentFolder()->getScoringAdjustmentEnabled());
        $scoring_activation->setInfo($this->lng->txt('assessment_scoring_adjust_desc'));
        $form->addItem($scoring_activation);

        // scoring adjustment
        $scoring = new ilCheckboxGroupInputGUI(
            $this->lng->txt('assessment_log_scoring_adjustment_activate'),
            "chb_scoring_adjustment"
        );
        $scoring_active = $this->getAssessmentFolder()->getScoringAdjustableQuestions();
        $scoring->setValue($scoring_active);

        foreach ($this->getAssessmentFolder()->fetchScoringAdjustableTypes($questiontypes) as $type_name => $qtype) {
            $scoring->addOption(
                new ilCheckboxOption($type_name, (string) $qtype["question_type_id"])
            );
        }
        $scoring->setInfo($this->lng->txt('assessment_log_scoring_adjustment_desc'));
        $form->addItem($scoring);

        if ($this->access->checkAccess("write", "", $this->getAssessmentFolder()->getRefId())) {
            $form->addCommandButton("saveSettings", $this->lng->txt("save"));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteLogObject()

ilObjAssessmentFolderGUI::deleteLogObject

(

)

Deletes the log entries for one or more tests.

Definition at line 516 of file class.ilObjAssessmentFolderGUI.php.

References getAssessmentFolder(), ILIAS\Repository\lng(), logAdminObject(), and ILIAS\Repository\refinery().

                                     : void
    {
        $test_ids = $this->post_wrapper->retrieve(
            'chb_test',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int()),
                $this->refinery->always([])
            ])
        );

        if ($test_ids !== []) {
            $this->getAssessmentFolder()->deleteLogEntries($test_ids);
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("ass_log_deleted"));
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("ass_log_delete_no_selection"));
        }

        $this->logAdminObject();
    }

Here is the call graph for this function:

executeCommand()

ilObjAssessmentFolderGUI::executeCommand

(

)

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

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

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
        $this->prepareOutput();

        switch ($next_class) {
            case 'ilpermissiongui':
                $this->tabs_gui->activateTab('perm_settings');
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
            case 'ilglobalunitconfigurationgui':
                if (!$this->rbac_system->checkAccess('visible,read', $this->getAssessmentFolder()->getRefId())) {
                    $this->ilias->raiseError($this->lng->txt('permission_denied'), $this->ilias->error_obj->WARNING);
                }

                $this->tabs_gui->setTabActive('units');

                $gui = new ilGlobalUnitConfigurationGUI(
                    new ilUnitConfigurationRepository(0)
                );
                $this->ctrl->forwardCommand($gui);
                break;

            default:
                if ($cmd === null || $cmd === "" || $cmd === "view") {
                    $cmd = "settings";
                }
                $cmd .= "Object";
                $this->$cmd();

                break;
        }
    }

Here is the call graph for this function:

exportLogObject()

ilObjAssessmentFolderGUI::exportLogObject

(

)

Called when the a log should be exported.

Definition at line 330 of file class.ilObjAssessmentFolderGUI.php.

References ILIAS\LTI\ToolProvider\$key, $log, ilObjTest\_getAvailableTests(), ilObjUser\_lookupName(), ilUtil\deliverData(), ilObjAssessmentFolder\getLog(), getLogDataOutputForm(), IL_CAL_FKT_DATE, IL_CAL_UNIX, ILIAS\Repository\int(), ILIAS\Repository\lng(), logsObject(), and ilCSVUtil\processCSVRow().

                                     : void
    {
        $form = $this->getLogDataOutputForm();
        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->logsObject($form);
            return;
        }

        $test = (int) $form->getInput('sel_test');
        $from = $form->getItemByPostVar('log_from')->getDate()->get(IL_CAL_UNIX);
        $until = $form->getItemByPostVar('log_until')->getDate()->get(IL_CAL_UNIX);

        $csv = [];
        $separator = ";";
        $row = [
            $this->lng->txt("assessment_log_datetime"),
            $this->lng->txt("user"),
            $this->lng->txt("assessment_log_text"),
            $this->lng->txt("question")
        ];

        $available_tests = ilObjTest::_getAvailableTests(1);
        $csv[] = ilCSVUtil::processCSVRow($row, true, $separator);
        $log_output = ilObjAssessmentFolder::getLog($from, $until, $test);
        $users = [];
        foreach ($log_output as $key => $log) {
            if (!array_key_exists($log["user_fi"], $users)) {
                $users[$log["user_fi"]] = ilObjUser::_lookupName((int) $log["user_fi"]);
            }
            $title = "";
            if ($log["question_fi"] || $log["original_fi"]) {
                $title = $this->questioninfo->getQuestionTitle((int) $log["question_fi"]);
                if ($title === '') {
                    $title = $this->questioninfo->getQuestionTitle((int) $log["original_fi"]);
                }
                $title = $this->lng->txt("assessment_log_question") . ": " . $title;
            }
            $csvrow = [];
            $date = new ilDateTime((int) $log['tstamp'], IL_CAL_UNIX);
            $csvrow[] = $date->get(IL_CAL_FKT_DATE, 'Y-m-d H:i');
            $csvrow[] = trim($users[$log["user_fi"]]["title"] . " " . $users[$log["user_fi"]]["firstname"] . " " . $users[$log["user_fi"]]["lastname"]);
            $csvrow[] = trim($log["logtext"]);
            $csvrow[] = $title;
            $csv[] = ilCSVUtil::processCSVRow($csvrow, true, $separator);
        }
        $csvoutput = "";
        foreach ($csv as $row) {
            $csvoutput .= implode($separator, $row) . "\n";
        }
        ilUtil::deliverData(
            $csvoutput,
            str_replace(" ", "_", "log_" . $from . "_" . $until . "_" . $available_tests[$test]) . ".csv"
        );
    }

Here is the call graph for this function:

getAdminTabs()

ilObjAssessmentFolderGUI::getAdminTabs

(

)

Definition at line 563 of file class.ilObjAssessmentFolderGUI.php.

References getTabs().

                                  : void
    {
        $this->getTabs();
    }

Here is the call graph for this function:

getAssessmentFolder()

ilObjAssessmentFolderGUI::getAssessmentFolder ( )

private

PhpIncompatibleReturnTypeInspection

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

References ilObjectGUI\$object.

Referenced by buildSettingsForm(), deleteLogObject(), getLogDataOutputForm(), logAdminObject(), saveLogSettingsObject(), and saveSettingsObject().

                                          : ilObjAssessmentFolder
    {
        return $this->object;
    }

Here is the caller graph for this function:

getLogDataOutputForm()

ilObjAssessmentFolderGUI::getLogDataOutputForm ( )

protected

Returns

ilPropertyFormGUI

Definition at line 389 of file class.ilObjAssessmentFolderGUI.php.

References ILIAS\LTI\ToolProvider\$key, ilObjTest\_getAvailableTests(), ILIAS\Repository\ctrl(), getAssessmentFolder(), ILIAS\Repository\lng(), ilLegacyFormElementsUtil\prepareFormOutput(), ilFormPropertyGUI\setRequired(), ilDateTimeInputGUI\setShowTime(), and ilArrayUtil\sortArray().

Referenced by exportLogObject(), logsObject(), and showLogObject().

                                             : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setPreventDoubleSubmission(false);
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTableWidth("100%");
        $form->setId("logs");

        $header = new ilFormSectionHeaderGUI();
        $header->setTitle($this->lng->txt("assessment_log"));
        $form->addItem($header);

        // from
        $from = new ilDateTimeInputGUI($this->lng->txt('cal_from'), "log_from");
        $from->setShowTime(true);
        $from->setRequired(true);
        $form->addItem($from);

        // until
        $until = new ilDateTimeInputGUI($this->lng->txt('cal_until'), "log_until");
        $until->setShowTime(true);
        $until->setRequired(true);
        $form->addItem($until);

        $available_tests = ilObjTest::_getAvailableTests(1);

        // tests
        $fortest = new ilSelectInputGUI($this->lng->txt('assessment_log_for_test'), "sel_test");
        $fortest->setRequired(true);
        $sorted_options = [];
        foreach ($available_tests as $key => $value) {
            $sorted_options[] = [
                'title' => ilLegacyFormElementsUtil::prepareFormOutput($value) . " [" . $this->getAssessmentFolder()->getNrOfLogEntries((int) $key) . " " . $this->lng->txt("assessment_log_log_entries") . "]",
                'key' => $key
            ];
        }
        $sorted_options = ilArrayUtil::sortArray($sorted_options, 'title', 'asc');
        $options = ['' => $this->lng->txt('please_choose')];
        foreach ($sorted_options as $option) {
            $options[$option['key']] = $option['title'];
        }
        $fortest->setOptions($options);
        $form->addItem($fortest);

        $form->addCommandButton('showLog', $this->lng->txt('show'));
        $form->addCommandButton('exportLog', $this->lng->txt('export'));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLogdataSubtabs()

ilObjAssessmentFolderGUI::getLogdataSubtabs

(

)

Definition at line 568 of file class.ilObjAssessmentFolderGUI.php.

References ILIAS\Repository\ctrl().

Referenced by getTabs().

                                       : void
    {
        $this->tabs_gui->addSubTabTarget(
            "settings",
            $this->ctrl->getLinkTarget($this, "showLogSettings"),
            ["saveLogSettings", "showLogSettings"],
            ""
        );

        // log output
        $this->tabs_gui->addSubTabTarget(
            "ass_log_output",
            $this->ctrl->getLinkTarget($this, "logs"),
            ["logs", "showLog", "exportLog"],
            ""
        );

        // log administration
        $this->tabs_gui->addSubTabTarget(
            "ass_log_admin",
            $this->ctrl->getLinkTarget($this, "logAdmin"),
            ["logAdmin", "deleteLog"],
            "",
            ""
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLogSettingsForm()

ilObjAssessmentFolderGUI::getLogSettingsForm ( )

protected

Returns

ilPropertyFormGUI

Definition at line 686 of file class.ilObjAssessmentFolderGUI.php.

References $lang, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by saveLogSettingsObject(), and showLogSettingsObject().

                                           : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'saveLogSettings'));
        $form->setTitle($this->lng->txt('assessment_log_logging'));

        $logging = new ilCheckboxInputGUI('', 'chb_assessment_logging');
        $logging->setValue('1');
        $logging->setOptionTitle($this->lng->txt('activate_assessment_logging'));
        $form->addItem($logging);

        $reporting = new ilSelectInputGUI(
            $this->lng->txt('assessment_settings_reporting_language'),
            'reporting_language'
        );
        $languages = $this->lng->getInstalledLanguages();
        $this->lng->loadLanguageModule('meta');
        $options = [];
        foreach ($languages as $lang) {
            $options[$lang] = $this->lng->txt('meta_l_' . $lang);
        }
        $reporting->setOptions($options);
        $form->addItem($reporting);

        if ($this->access->checkAccess('write', '', $this->getAssessmentFolder()->getRefId())) {
            $form->addCommandButton('saveLogSettings', $this->lng->txt('save'));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTabs()

ilObjAssessmentFolderGUI::getTabs ( )

protected

Definition at line 595 of file class.ilObjAssessmentFolderGUI.php.

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

Referenced by getAdminTabs().

                                : void
    {
        switch ($this->ctrl->getCmd()) {
            case "saveLogSettings":
            case "showLogSettings":
            case "logs":
            case "showLog":
            case "exportLog":
            case "logAdmin":
            case "deleteLog":
                $this->getLogdataSubtabs();
                break;
        }

        if ($this->rbac_system->checkAccess("visible,read", $this->getAssessmentFolder()->getRefId())) {
            $this->tabs_gui->addTarget(
                "settings",
                $this->ctrl->getLinkTarget($this, "settings"),
                ["settings", "", "view"],
                "",
                ""
            );

            $this->tabs_gui->addTarget(
                "logs",
                $this->ctrl->getLinkTarget($this, "showLogSettings"),
                ['saveLogSettings', 'showLogSettings', "logs", "showLog", "exportLog", "logAdmin", "deleteLog"],
                "",
                ""
            );

            $this->tabs_gui->addTarget(
                'units',
                $this->ctrl->getLinkTargetByClass('ilGlobalUnitConfigurationGUI', ''),
                '',
                'ilglobalunitconfigurationgui'
            );
        }

        if ($this->rbac_system->checkAccess('edit_permission', $this->getAssessmentFolder()->getRefId())) {
            $this->tabs_gui->addTarget(
                "perm_settings",
                $this->ctrl->getLinkTargetByClass([get_class($this), 'ilpermissiongui'], "perm"),
                ["perm", "info", "owner"],
                'ilpermissiongui'
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

logAdminObject()

ilObjAssessmentFolderGUI::logAdminObject

(

)

Administration output for assessment log files.

Definition at line 539 of file class.ilObjAssessmentFolderGUI.php.

References ilObjectGUI\$data, ilObjectGUI\$obj_id, ilObjectGUI\$ref_id, ilObjTest\_getAvailableTests(), ilObject\_lookupObjectId(), ILIAS\Repository\access(), getAssessmentFolder(), ilObjectGUI\getRefId(), and ILIAS\Repository\lng().

Referenced by deleteLogObject().

                                    : void
    {
        $this->tabs_gui->activateTab('logs');

        $a_write_access = ($this->access->checkAccess("write", "", $this->getAssessmentFolder()->getRefId())) ? true : false;

        $table_gui = new ilAssessmentFolderLogAdministrationTableGUI($this, 'logAdmin', $a_write_access);

        $available_tests = ilObjTest::_getAvailableTests(false);
        $data = [];
        foreach ($available_tests as $ref_id => $title) {
            $obj_id = ilObject::_lookupObjectId($ref_id);
            $data[] = [
                "title" => $title,
                "nr" => $this->getAssessmentFolder()->getNrOfLogEntries((int) $obj_id),
                "id" => $obj_id,
                "location_href" => ilLink::_getLink($ref_id, 'tst'),
                "location_txt" => $this->lng->txt("perma_link")
            ];
        }
        $table_gui->setData($data);
        $this->tpl->setVariable('ADM_CONTENT', $table_gui->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

logsObject()

ilObjAssessmentFolderGUI::logsObject

(

ilPropertyFormGUI

$form = null

)

Parameters

ilPropertyFormGUI | null

$form

Definition at line 442 of file class.ilObjAssessmentFolderGUI.php.

References ILIAS\Repository\ctrl(), ilObjAssessmentFolder\getLog(), getLogDataOutputForm(), IL_CAL_DATETIME, IL_CAL_UNIX, and ILIAS\Repository\int().

Referenced by exportLogObject(), and showLogObject().

                                                              : void
    {
        $this->tabs_gui->activateTab('logs');

        $template = new ilTemplate("tpl.assessment_logs.html", true, true, "Modules/Test");

        $p_test = 0;
        $fromdate = 0;
        $untildate = 0;

        if (!($form instanceof ilPropertyFormGUI)) {
            $form = $this->getLogDataOutputForm();

            $values = [];
            if ($this->testrequest->isset('sel_test')) {
                $p_test = $values['sel_test'] = $this->testrequest->int('sel_test');
            }

            if ($this->testrequest->isset('log_from')) {
                $fromdate = $this->testrequest->int('log_from');
            } else {
                $fromdate = mktime(0, 0, 0, 1, 1, (int) date('Y'));
            }

            if ($this->testrequest->isset('log_until')) {
                $untildate = $this->testrequest->int('log_until');
            } else {
                $untildate = time();
            }

            $values['log_from'] = (new ilDateTime($fromdate, IL_CAL_UNIX))->get(IL_CAL_DATETIME);
            $values['log_until'] = (new ilDateTime($untildate, IL_CAL_UNIX))->get(IL_CAL_DATETIME);

            $form->setValuesByArray($values);
        } else {
            $fromdate_input = $form->getItemByPostVar('log_from')->getDate();
            $untildate_input = $form->getItemByPostVar('log_until')->getDate();
            if ($fromdate_input instanceof ilDateTime && $untildate_input instanceof ilDateTime) {
                $p_test = (int) $form->getInput('sel_test');

                $fromdate = $fromdate_input->get(IL_CAL_UNIX);
                $untildate = $untildate_input->get(IL_CAL_UNIX);
            }
        }

        $this->ctrl->setParameter($this, 'sel_test', (int) $p_test);
        $this->ctrl->setParameter($this, 'log_until', (int) $untildate);
        $this->ctrl->setParameter($this, 'log_from', (int) $fromdate);

        $template->setVariable("FORM", $form->getHTML());

        if ($p_test) {
            $table_gui = new ilAssessmentFolderLogTableGUI($this, 'logs');
            $log_output = ilObjAssessmentFolder::getLog($fromdate, $untildate, $p_test);

            $self = $this;
            array_walk($log_output, static function (&$row) use ($self) {
                $row['location_href'] = '';
                $row['location_txt'] = '';
                if (is_numeric($row['ref_id']) && $row['ref_id'] > 0) {
                    $row['location_href'] = ilLink::_getLink((int) $row['ref_id'], 'tst');
                    $row['location_txt'] = $self->lng->txt("perma_link");
                }
            });

            $table_gui->setData($log_output);
            $template->setVariable('LOG', $table_gui->getHTML());
        }
        $this->tpl->setVariable("ADM_CONTENT", $template->get());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveLogSettingsObject()

ilObjAssessmentFolderGUI::saveLogSettingsObject ( )

protected

Definition at line 665 of file class.ilObjAssessmentFolderGUI.php.

References ILIAS\Repository\access(), getAssessmentFolder(), getLogSettingsForm(), ILIAS\Repository\lng(), and showLogSettingsObject().

                                              : void
    {
        if (!$this->access->checkAccess('write', '', $this->getAssessmentFolder()->getRefId())) {
            $this->ilias->raiseError($this->lng->txt("permission_denied"), $this->ilias->error_obj->WARNING);
        }

        $form = $this->getLogSettingsForm();
        if ($form->checkInput()) {
            $this->getAssessmentFolder()->_enableAssessmentLogging((bool) $form->getInput('chb_assessment_logging'));
            $this->getAssessmentFolder()->_setLogLanguage((string) $form->getInput('reporting_language'));
            $this->getAssessmentFolder()->update();
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
        }

        $form->setValuesByPost();
        $this->showLogSettingsObject($form);
    }

Here is the call graph for this function:

saveSettingsObject()

ilObjAssessmentFolderGUI::saveSettingsObject

(

)

Save Assessment settings.

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

References ilObjQuestionPool\_getQuestionTypes(), ILIAS\Repository\access(), ilObjAssessmentFolder\ASS_PROC_LOCK_MODE_NONE, buildSettingsForm(), ILIAS\Repository\ctrl(), getAssessmentFolder(), ilObjAssessmentFolder\getValidAssessmentProcessLockModes(), ILIAS\Repository\int(), ILIAS\Repository\lng(), settingsObject(), and ilUtil\stripSlashes().

                                        : void
    {
        if (!$this->access->checkAccess("write", "", $this->getAssessmentFolder()->getRefId())) {
            $this->ctrl->redirect($this, 'settings');
        }

        $form = $this->buildSettingsForm();
        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->settingsObject($form);
            return;
        }

        $this->getAssessmentFolder()->setSkillTriggeringNumAnswersBarrier((int) $form->getInput('num_req_answers'));
        $this->getAssessmentFolder()->setExportEssayQuestionsWithHtml(
            (bool) ($form->getInput('export_essay_qst_with_html') ?? '0')
        );
        $this->getAssessmentFolder()->_setManualScoring($form->getInput('chb_manual_scoring') ?? []);
        $question_types = ilObjQuestionPool::_getQuestionTypes(true);
        $forbidden_types = [];
        foreach ($question_types as $name => $row) {
            if (!$form->getItemByPostVar('chb_allowed_questiontypes') ||
                !in_array($row["question_type_id"], $form->getInput('chb_allowed_questiontypes'))) {
                $forbidden_types[] = (int) $row["question_type_id"];
            }
        }
        $this->getAssessmentFolder()->_setForbiddenQuestionTypes($forbidden_types);
        $this->getAssessmentFolder()->setScoringAdjustmentEnabled(
            (bool) ($form->getInput('chb_scoring_adjust') ?? '0')
        );
        $scoring_types = [];
        foreach ($question_types as $name => $row) {
            if ($form->getItemByPostVar('chb_scoring_adjustment') &&
                in_array($row["question_type_id"], $form->getInput('chb_scoring_adjustment'))) {
                $scoring_types[] = $row["question_type_id"];
            }
        }
        $this->getAssessmentFolder()->setScoringAdjustableQuestions($scoring_types);
        if (!$form->getInput('ass_process_lock')) {
            $this->getAssessmentFolder()->setAssessmentProcessLockMode(ilObjAssessmentFolder::ASS_PROC_LOCK_MODE_NONE);
        } elseif (in_array(
            $form->getInput('ass_process_lock_mode'),
            ilObjAssessmentFolder::getValidAssessmentProcessLockModes(),
            true
        )) {
            $this->getAssessmentFolder()->setAssessmentProcessLockMode($form->getInput('ass_process_lock_mode'));
        }

        $assessmentSetting = new ilSetting('assessment');
        $assessmentSetting->set('use_javascript', '1');
        if (strlen($form->getInput('imap_line_color') ?? '') === 6) {
            $assessmentSetting->set('imap_line_color', ilUtil::stripSlashes($form->getInput('imap_line_color')));
        }
        $assessmentSetting->set('user_criteria', ilUtil::stripSlashes($form->getInput('user_criteria')));

        $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);

        $this->ctrl->redirect($this, 'settings');
    }

Here is the call graph for this function:

settingsObject()

ilObjAssessmentFolderGUI::settingsObject

(

ilPropertyFormGUI

$form = null

)

Definition at line 89 of file class.ilObjAssessmentFolderGUI.php.

References buildSettingsForm().

Referenced by saveSettingsObject().

                                                                  : void
    {
        $this->tabs_gui->setTabActive('settings');

        if ($form === null) {
            $form = $this->buildSettingsForm();
        }

        $this->tpl->setVariable("ADM_CONTENT", $form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showLogObject()

ilObjAssessmentFolderGUI::showLogObject

(

)

Called when the a log should be shown.

Definition at line 318 of file class.ilObjAssessmentFolderGUI.php.

References getLogDataOutputForm(), and logsObject().

                                   : void
    {
        $form = $this->getLogDataOutputForm();
        $form->checkInput();

        $form->setValuesByPost();
        $this->logsObject($form);
    }

Here is the call graph for this function:

showLogSettingsObject()

ilObjAssessmentFolderGUI::showLogSettingsObject ( ilPropertyFormGUI  $form = null )

protected

Parameters

ilPropertyFormGUI

$form

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

References ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), and getLogSettingsForm().

Referenced by saveLogSettingsObject().

                                                                            : void
    {
        $this->tabs_gui->activateTab('logs');

        if (!($form instanceof ilPropertyFormGUI)) {
            $form = $this->getLogSettingsForm();
            $form->setValuesByArray([
                'chb_assessment_logging' => ilObjAssessmentFolder::_enabledAssessmentLogging(),
                'reporting_language' => ilObjAssessmentFolder::_getLogLanguage()
            ]);
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$questioninfo

ILIAS TestQuestionPool QuestionInfoService ilObjAssessmentFolderGUI::$questioninfo

protected

Definition at line 28 of file class.ilObjAssessmentFolderGUI.php.

$testrequest

ILIAS Test InternalRequestService ilObjAssessmentFolderGUI::$testrequest

protected

Definition at line 29 of file class.ilObjAssessmentFolderGUI.php.

---

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

• Modules/Test/classes/class.ilObjAssessmentFolderGUI.php