ilObjExerciseGUI Class Reference

Class ilObjExerciseGUI. More...

Inheritance diagram for ilObjExerciseGUI:

Collaboration diagram for ilObjExerciseGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference, $a_prepare_output=true)
	Constructor public. More...
	executeCommand ()
	viewObject ()
	addContentSubTabs ($a_activate)
	Add subtabs of content view. More...
	getTabs ()
	adds tabs to tab gui object More...
	infoScreenObject ()
	this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed More...
	infoScreen ()
	show information screen More...
	editObject ()
	addLocatorItems ()
	Add locator item. More...
	showOverviewObject ()
	Show overview of assignments. More...
	certificateObject ()
	outCertificateObject ()
Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...
	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	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...
	cancelDeleteObject ()
	cancel deletion of object More...
	cancelObject ()
	cancel action and go back to previous page public More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	save object More...
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	edit object More...
	addExternalEditFormCustom (ilPropertyFormGUI $a_form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	list childs of current object More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...

Static Public Member Functions
static	_goto ($a_target, $a_raw)
	redirect script More...
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Protected Member Functions
	afterSave (ilObject $a_new_object)
	listAssignmentsObject ()
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Init properties form. More...
	getEditFormCustomValues (array &$a_values)
	Get values for properties form. More...
	updateCustom (ilPropertyFormGUI $a_form)
	setSettingsSubTabs ()
Protected Member Functions inherited from ilObjectGUI
	assignObject ()
	setTitleAndDescription ()
	called by prepare output More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	showMountWebfolderIcon ()
	setTabs ()
	set admin tabs public More...
	setAdminTabs ()
	set admin tabs public More...
	setLocator ()
	set Locator More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm ($a_new_type)
	Init object creation form. More...
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	Init object edit form. More...
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	Get values for edit form. More...
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm ($a_new_type)
	Init object import form. More...
	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...
	getTabs ()
	get tabs abstract method. More...
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...
	redirectToRefId ($a_ref_id, $a_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 $_GET["ref_id"] value More...
	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Protected Attributes
	$tabs
	$help
Protected Attributes inherited from ilObjectGUI
	$ilErr
	$locator
	$user
	$access
	$settings
	$rbacreview
	$toolbar
	$rbacsystem
	$tmp_import_dir
	$tabs_gui = null
	$ctrl

Additional Inherited Members
Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3

Detailed Description

Class ilObjExerciseGUI.

Author

Stefan Meyer smeye.nosp@m.r@da.nosp@m.tabay.nosp@m..de

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de $Id$

ilObjExerciseGUI: ilPermissionGUI, ilLearningProgressGUI, ilInfoScreenGUI ilObjExerciseGUI: ilObjectCopyGUI, ilExportGUI ilObjExerciseGUI: ilCommonActionDispatcherGUI, ilCertificateGUI ilObjExerciseGUI: ilExAssignmentEditorGUI, ilExSubmissionGUI ilObjExerciseGUI: ilExerciseManagementGUI, ilExcCriteriaCatalogueGUI

Definition at line 23 of file class.ilObjExerciseGUI.php.

Constructor & Destructor Documentation

__construct()

ilObjExerciseGUI::__construct	(		$a_data,
			$a_id,
			$a_call_by_reference,
			$a_prepare_output = true
	)

Constructor public.

Definition at line 39 of file class.ilObjExerciseGUI.php.

References $DIC, ilObjectGUI\$lng, ilExAssignment\lookupExerciseId(), object, and user().

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->ctrl = $DIC->ctrl();
        $this->tabs = $DIC->tabs();
        $this->help = $DIC["ilHelp"];
        $this->locator = $DIC["ilLocator"];
        $this->tpl = $DIC["tpl"];
        $this->toolbar = $DIC->toolbar();
        $lng = $DIC->language();
        
        $this->type = "exc";
        parent::__construct($a_data, $a_id, $a_call_by_reference, false);
        
        $lng->loadLanguageModule("exercise");
        $lng->loadLanguageModule("exc");
        $this->ctrl->saveParameter($this, "ass_id");

        include_once("./Modules/Exercise/classes/class.ilExAssignment.php");
        if ($_REQUEST["ass_id"] > 0 && is_object($this->object) && ilExAssignment::lookupExerciseId($_REQUEST["ass_id"]) == $this->object->getId()) {
            $this->ass = new ilExAssignment((int) $_REQUEST["ass_id"]);
        } elseif ($_REQUEST["ass_id"] > 0) {
            include_once("./Modules/Exercise/exceptions/class.ilExerciseException.php");
            throw new ilExerciseException("Assignment ID does not match Exercise.");
        }
    }

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilObjExerciseGUI::_goto (   $a_target,   $a_raw  )

static

redirect script

Parameters

string

$a_target

Definition at line 690 of file class.ilObjExerciseGUI.php.

References $_GET, $action, $DIC, $ilCtrl, ilObjectGUI\$ilErr, ilObjectGUI\$lng, ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), array, and ilUtil\sendFailure().

    {
        global $DIC;

        $ilErr = $DIC["ilErr"];
        $lng = $DIC->language();
        $ilAccess = $DIC->access();
        $ilCtrl = $DIC->ctrl();

        //we don't have baseClass here...
        $ilCtrl->setTargetScript("ilias.php");
        $ilCtrl->initBaseClass("ilRepositoryGUI");

        //ilExerciseMailNotification has links to:
        // "Assignments", "Submission and Grades" and Downnoad the NEW files if the assignment type is "File Upload".
        $ass_id = $_GET['ass_id'];
        $parts = explode("_", $a_raw);
        if (!$ass_id) {
            $ass_id = null;
            $action = null;

            switch (end($parts)) {
                case "download":
                    $action = $parts[3];
                    $member = $parts[2];
                    $ass_id = $parts[1];
                    break;

                case "setdownload":
                    $action = $parts[3];
                    $member = $parts[2];
                    $ass_id = $parts[1];
                    break;

                case "grades":
                    $action= $parts[2];
                    $ass_id = $parts[1];
                    break;
            }
        }

        $ilCtrl->setParameterByClass("ilExerciseHandlerGUI", "ref_id", $a_target);

        if ($ilAccess->checkAccess("read", "", $a_target)) {
            $ilCtrl->setParameterByClass("ilExerciseHandlerGUI", "target", $a_raw);

            if ($ass_id) {
                $ilCtrl->setParameterByClass("ilExerciseManagementGUI", "ass_id", $ass_id);
            }

            switch ($action) {
                case "grades":
                    $ilCtrl->redirectByClass(array("ilRepositoryGUI", "ilExerciseHandlerGUI", "ilObjExerciseGUI", "ilExerciseManagementGUI"), "members");
                    break;

                /*case "download":
                    $ilCtrl->setParameterByClass("ilExerciseHandlerGUI", "member_id", $member);
                    $ilCtrl->redirectByClass(array("ilRepositoryGUI", "ilExerciseHandlerGUI", "ilObjExerciseGUI", "ilExerciseManagementGUI", "ilExSubmissionFileGUI"),"downloadNewReturned");
                    break;*/

                case "setdownload":
                    $ilCtrl->setParameterByClass("ilExerciseHandlerGUI", "member_id", $member);
                    $ilCtrl->redirectByClass(array("ilRepositoryGUI", "ilExerciseHandlerGUI", "ilObjExerciseGUI", "ilExerciseManagementGUI"), "waitingDownload");
                    break;

                default:
                    if ($parts[1] != "") {
                        $ilCtrl->setParameterByClass("ilExerciseHandlerGUI", "ass_id", $parts[1]);
                        $ilCtrl->setParameterByClass("ilExerciseHandlerGUI", "ass_id_goto", $parts[1]);
                    }
                    $ilCtrl->redirectByClass(array("ilRepositoryGUI", "ilExerciseHandlerGUI", "ilObjExerciseGUI"), "showOverview");
                    break;

            }
        } elseif ($ilAccess->checkAccess("visible", "", $a_target)) {
            $ilCtrl->redirectByClass(array("ilRepositoryGUI", "ilExerciseHandlerGUI", "ilObjExerciseGUI"), "infoScreen");
        } elseif ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
            ilUtil::sendFailure(sprintf(
                $lng->txt("msg_no_perm_read_item"),
                ilObject::_lookupTitle(ilObject::_lookupObjId($a_target))
            ), true);
            ilObjectGUI::_gotoRepositoryRoot();
        }
    }

Here is the call graph for this function:

addContentSubTabs()

ilObjExerciseGUI::addContentSubTabs

(

$a_activate

)

Add subtabs of content view.

Parameters

object

$tabs_gui

ilTabsGUI object

Definition at line 422 of file class.ilObjExerciseGUI.php.

References ilObjectGUI\$ctrl, $ilCtrl, ilObjectGUI\$lng, $tabs, and ilObjectGUI\checkPermissionBool().

Referenced by executeCommand(), and showOverviewObject().

    {
        $ilTabs = $this->tabs;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        $ilTabs->addSubTab(
            "content",
            $lng->txt("view"),
            $ilCtrl->getLinkTarget($this, "showOverview")
        );
        if ($this->checkPermissionBool("write")) {
            $ilTabs->addSubTab(
                "list_assignments",
                $lng->txt("edit"),
                $ilCtrl->getLinkTargetByClass("ilExAssignmentEditorGUI", "listAssignments")
            );
        }
        $ilTabs->activateSubTab($a_activate);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addLocatorItems()

ilObjExerciseGUI::addLocatorItems

(

)

Add locator item.

Definition at line 778 of file class.ilObjExerciseGUI.php.

References $_GET, ilObjectGUI\$locator, and object.

    {
        $ilLocator = $this->locator;
        
        if (is_object($this->object)) {
            // #17955
            $ilLocator->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, "showOverview"), "", $_GET["ref_id"]);
        }
    }

afterSave()

ilObjExerciseGUI::afterSave ( ilObject  $a_new_object )

protected

Definition at line 209 of file class.ilObjExerciseGUI.php.

References ilObjectGUI\$ctrl, $ilCtrl, ilObject\getRefId(), and ilUtil\sendSuccess().

    {
        $ilCtrl = $this->ctrl;
        
        $a_new_object->saveData();
        
        ilUtil::sendSuccess($this->lng->txt("exc_added"), true);
        
        $ilCtrl->setParameterByClass("ilExAssignmentEditorGUI", "ref_id", $a_new_object->getRefId());
        $ilCtrl->redirectByClass("ilExAssignmentEditorGUI", "addAssignment");
    }

Here is the call graph for this function:

certificateObject()

ilObjExerciseGUI::certificateObject

(

)

Definition at line 867 of file class.ilObjExerciseGUI.php.

References setSettingsSubTabs().

    {
        $this->setSettingsSubTabs();
        $this->tabs_gui->activateTab("settings");
        $this->tabs_gui->activateSubTab("certificate");
        
        include_once "./Services/Certificate/classes/class.ilCertificateGUI.php";
        include_once "./Modules/Exercise/classes/class.ilExerciseCertificateAdapter.php";
        $output_gui = new ilCertificateGUI(new ilExerciseCertificateAdapter($this->object));
        $output_gui->certificateEditor();
    }

Here is the call graph for this function:

editObject()

ilObjExerciseGUI::editObject

(

)

Definition at line 654 of file class.ilObjExerciseGUI.php.

References setSettingsSubTabs().

    {
        $this->setSettingsSubTabs();
        $this->tabs_gui->activateSubTab("edit");
        return parent::editObject();
    }

Here is the call graph for this function:

executeCommand()

ilObjExerciseGUI::executeCommand

(

)

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

References $_GET, ilObjectGUI\$ctrl, $GLOBALS, $ilCtrl, $ilUser, ilObjectGUI\$lng, $ret, $tabs, ilObjectGUI\$user, addContentSubTabs(), ilObjectGUI\addHeaderAction(), ilObjectGUI\checkPermission(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), infoScreen(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, object, ilObjectGUI\prepareOutput(), and setSettingsSubTabs().

    {
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;
        $lng = $this->lng;
  
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
        $this->prepareOutput();
  
        //echo "-".$next_class."-".$cmd."-"; exit;
        switch ($next_class) {
            case "ilinfoscreengui":
                $ilTabs->activateTab("info");
                $this->infoScreen();    // forwards command
                break;

            case 'ilpermissiongui':
                $ilTabs->activateTab("permissions");
                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                $perm_gui = new ilPermissionGUI($this);
                $ret =&$this->ctrl->forwardCommand($perm_gui);
            break;
    
            case "illearningprogressgui":
                $ilTabs->activateTab("learning_progress");
                include_once './Services/Tracking/classes/class.ilLearningProgressGUI.php';
    
                $new_gui = new ilLearningProgressGUI(
                    ilLearningProgressGUI::LP_CONTEXT_REPOSITORY,
                    $this->object->getRefId(),
                    $_GET['user_id'] ? $_GET['user_id'] : $ilUser->getId()
                );
                $this->ctrl->forwardCommand($new_gui);
                $this->tabs_gui->setTabActive('learning_progress');
            break;
            
            case 'ilobjectcopygui':
                $ilCtrl->saveParameter($this, 'new_type');
                $ilCtrl->setReturnByClass(get_class($this), 'create');

                include_once './Services/Object/classes/class.ilObjectCopyGUI.php';
                $cp = new ilObjectCopyGUI($this);
                $cp->setType('exc');
                $this->ctrl->forwardCommand($cp);
                break;

            case "ilexportgui":
                $ilTabs->activateTab("export");
                include_once("./Services/Export/classes/class.ilExportGUI.php");
                $exp_gui = new ilExportGUI($this);
                $exp_gui->addFormat("xml");
                $ret = $this->ctrl->forwardCommand($exp_gui);
//                              $this->tpl->show();
                break;
            
            case "ilcommonactiondispatchergui":
                include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;
            
            case "ilcertificategui":
                $this->setSettingsSubTabs();
                $this->tabs_gui->activateTab("settings");
                $this->tabs_gui->activateSubTab("certificate");
                include_once "./Services/Certificate/classes/class.ilCertificateGUI.php";
                include_once "./Modules/Exercise/classes/class.ilExerciseCertificateAdapter.php";
                $output_gui = new ilCertificateGUI(new ilExerciseCertificateAdapter($this->object));
                $this->ctrl->forwardCommand($output_gui);
                break;
            
            case "ilexassignmenteditorgui":
                $this->checkPermission("write");
                $ilTabs->activateTab("content");
                $this->addContentSubTabs("list_assignments");
                include_once("./Modules/Exercise/classes/class.ilExAssignmentEditorGUI.php");
                $ass_gui = new ilExAssignmentEditorGUI($this->object->getId(), $this->object->isCompletionBySubmissionEnabled(), $this->ass);
                $this->ctrl->forwardCommand($ass_gui);
                break;
            
            case "ilexsubmissiongui":
                $this->checkPermission("read");
                $ilTabs->activateTab("content");
                $this->addContentSubTabs("content");
                $this->ctrl->setReturn($this, "showOverview");
                include_once("./Modules/Exercise/classes/class.ilExSubmissionGUI.php");
                $sub_gui = new ilExSubmissionGUI($this->object, $this->ass, (int) $_REQUEST["member_id"]);
                $this->ctrl->forwardCommand($sub_gui);
                break;
            
            case "ilexercisemanagementgui":
                // rbac or position access
                if ($GLOBALS['DIC']->access()->checkRbacOrPositionPermissionAccess(
                    'edit_submissions_grades',
                    'edit_submissions_grades',
                    $this->object->getRefId()
                )) {
                    $ilTabs->activateTab("grades");
                    include_once("./Modules/Exercise/classes/class.ilExerciseManagementGUI.php");
                    $mgmt_gui = new ilExerciseManagementGUI($this->object, $this->ass);
                    $this->ctrl->forwardCommand($mgmt_gui);
                } else {
                    $this->checkPermission("edit_submissions_grades");  // throw error by standard procedure
                }
                break;
            
            case "ilexccriteriacataloguegui":
                $this->checkPermission("write");
                $ilTabs->activateTab("settings");
                $this->setSettingsSubTabs();
                $ilTabs->activateSubTab("crit");
                include_once("./Modules/Exercise/classes/class.ilExcCriteriaCatalogueGUI.php");
                $crit_gui = new ilExcCriteriaCatalogueGUI($this->object);
                $this->ctrl->forwardCommand($crit_gui);
                break;
                
            default:
                if (!$cmd) {
                    $cmd = "infoScreen";
                }
    
                $cmd .= "Object";
    
                $this->$cmd();
    
            break;
        }
        
        $this->addHeaderAction();
  
        return true;
    }

Here is the call graph for this function:

getEditFormCustomValues()

ilObjExerciseGUI::getEditFormCustomValues ( array &  $a_values )

protected

Get values for properties form.

Definition at line 346 of file class.ilObjExerciseGUI.php.

References $ilUser, ilObjectGUI\$user, array, ilOrgUnitGlobalSettings\getInstance(), ilNotification\hasNotification(), object, ilObjExercise\TUTOR_FEEDBACK_FILE, ilObjExercise\TUTOR_FEEDBACK_MAIL, ilObjExercise\TUTOR_FEEDBACK_TEXT, and ilNotification\TYPE_EXERCISE_SUBMISSION.

    {
        $ilUser = $this->user;

        $a_values["desc"] = $this->object->getLongDescription();
        $a_values["show_submissions"] = $this->object->getShowSubmissions();
        $a_values["pass_mode"] = $this->object->getPassMode();
        if ($a_values["pass_mode"] == "nr") {
            $a_values["pass_nr"] = $this->object->getPassNr();
        }
        
        include_once "./Services/Notification/classes/class.ilNotification.php";
        $a_values["notification"] = ilNotification::hasNotification(
            ilNotification::TYPE_EXERCISE_SUBMISSION,
            $ilUser->getId(),
            $this->object->getId()
        );
                
        $a_values['completion_by_submission'] = (int) $this->object->isCompletionBySubmissionEnabled();
        
        $tfeedback = array();
        if ($this->object->hasTutorFeedbackMail()) {
            $tfeedback[] = ilObjExercise::TUTOR_FEEDBACK_MAIL;
        }
        if ($this->object->hasTutorFeedbackText()) {
            $tfeedback[] = ilObjExercise::TUTOR_FEEDBACK_TEXT;
        }
        if ($this->object->hasTutorFeedbackFile()) {
            $tfeedback[] = ilObjExercise::TUTOR_FEEDBACK_FILE;
        }
        $a_values['tfeedback'] = $tfeedback;

        // orgunit position setting enabled
        $a_values['obj_orgunit_positions'] = (bool) ilOrgUnitGlobalSettings::getInstance()
            ->isPositionAccessActiveForObject($this->object->getId());
    }

Here is the call graph for this function:

getTabs()

ilObjExerciseGUI::getTabs

(

)

adds tabs to tab gui object

Parameters

object

$tabs_gui

ilTabsGUI object

Definition at line 448 of file class.ilObjExerciseGUI.php.

References $_GET, $help, ilObjectGUI\$lng, array, ilLearningProgressAccess\checkAccess(), ilObjectGUI\checkPermissionBool(), and object.

    {
        $lng = $this->lng;
        $ilHelp = $this->help;
  
        $ilHelp->setScreenIdComponent("exc");
        
        if ($this->checkPermissionBool("read")) {
            $this->tabs_gui->addTab(
                "content",
                $lng->txt("exc_assignments"),
                $this->ctrl->getLinkTarget($this, "showOverview")
            );
        }

        $next_class = strtolower($this->ctrl->getNextClass());
        if ($this->checkPermissionBool("visible") || $this->checkPermissionBool("read")) {
            $this->tabs_gui->addTab(
                "info",
                $lng->txt("info_short"),
                $this->ctrl->getLinkTargetByClass("ilinfoscreengui", "showSummary")
            );
        }

        // edit properties
        if ($this->checkPermissionBool("write")) {
            /*$tabs_gui->addTab("assignments",
                $lng->txt("exc_edit_assignments"),
                $this->ctrl->getLinkTarget($this, 'listAssignments'));*/
            
            $this->tabs_gui->addTab(
                "settings",
                $lng->txt("settings"),
                $this->ctrl->getLinkTarget($this, 'edit')
            );
        }
        if ($this->access->checkRbacOrPositionPermissionAccess(
            'edit_submissions_grades',
            'edit_submissions_grades',
            $this->object->getRefId()
        )) {
            $this->tabs_gui->addTab(
                "grades",
                $lng->txt("exc_submissions_and_grades"),
                $this->ctrl->getLinkTargetByClass("ilexercisemanagementgui", "members")
            );
        }

        // learning progress
        $save_sort_order = $_GET["sort_order"];         // hack, because exercise sort parameters
        $save_sort_by = $_GET["sort_by"];                       // must not be forwarded to learning progress
        $save_offset = $_GET["offset"];
        $_GET["offset"] = $_GET["sort_by"] = $_GET["sort_order"] = "";
        
        include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
        if (ilLearningProgressAccess::checkAccess($this->object->getRefId())) {
            $this->tabs_gui->addTab(
                'learning_progress',
                $lng->txt('learning_progress'),
                $this->ctrl->getLinkTargetByClass(array('ilobjexercisegui','illearningprogressgui'), '')
            );
        }

        $_GET["sort_order"] = $save_sort_order;         // hack, part ii
        $_GET["sort_by"] = $save_sort_by;
        $_GET["offset"] = $save_offset;

        // export
        if ($this->checkPermissionBool("write")) {
            $this->tabs_gui->addTab(
                "export",
                $lng->txt("export"),
                $this->ctrl->getLinkTargetByClass("ilexportgui", "")
            );
        }


        // permissions
        if ($this->checkPermissionBool("edit_permission")) {
            $this->tabs_gui->addTab(
                'permissions',
                $lng->txt("perm_settings"),
                $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm")
            );
        }
    }

Here is the call graph for this function:

infoScreen()

ilObjExerciseGUI::infoScreen

(

)

show information screen

Definition at line 550 of file class.ilObjExerciseGUI.php.

References $ilUser, $img, $info, ilObjectGUI\$lng, $tabs, ilObjectGUI\$user, ilLPMarks\_lookupComment(), ilLPMarks\_lookupMark(), ilObjectGUI\checkPermission(), ilObjectGUI\checkPermissionBool(), ilExAssignment\getAssignmentDataOfExercise(), ilUtil\getImagePath(), and object.

Referenced by executeCommand(), and infoScreenObject().

    {
        $ilUser = $this->user;
        $ilTabs = $this->tabs;
        $lng = $this->lng;
        
        $ilTabs->activateTab("info");

        if (!$this->checkPermissionBool("read")) {
            $this->checkPermission("visible");
        }

        include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
        $info = new ilInfoScreenGUI($this);
        
        $info->enablePrivateNotes();
        
        $info->enableNews();
        if ($this->checkPermissionBool("write")) {
            $info->enableNewsEditing();
            $info->setBlockProperty("news", "settings", true);
        }
        
        // standard meta data
        //$info->addMetaDataSections($this->object->getId(),0, $this->object->getType());

        // instructions
        $info->addSection($this->lng->txt("exc_overview"));
        include_once("./Modules/Exercise/classes/class.ilExAssignment.php");
        $ass = ilExAssignment::getAssignmentDataOfExercise($this->object->getId());
        $cnt = 0;
        $mcnt = 0;
        foreach ($ass as $a) {
            $cnt++;
            if ($a["mandatory"]) {
                $mcnt++;
            }
        }
        $info->addProperty($lng->txt("exc_assignments"), $cnt);
        $info->addProperty($lng->txt("exc_mandatory"), $mcnt);
        if ($this->object->getPassMode() != "nr") {
            $info->addProperty(
                $lng->txt("exc_pass_mode"),
                $lng->txt("exc_msg_all_mandatory_ass")
            );
        } else {
            $info->addProperty(
                $lng->txt("exc_pass_mode"),
                sprintf($lng->txt("exc_msg_min_number_ass"), $this->object->getPassNr())
            );
        }

        // feedback from tutor
        include_once("Services/Tracking/classes/class.ilLPMarks.php");
        if ($this->checkPermissionBool("read")) {
            $lpcomment = ilLPMarks::_lookupComment($ilUser->getId(), $this->object->getId());
            $mark = ilLPMarks::_lookupMark($ilUser->getId(), $this->object->getId());
            //$status = ilExerciseMembers::_lookupStatus($this->object->getId(), $ilUser->getId());
            $st = $this->object->determinStatusOfUser($ilUser->getId());
            $status = $st["overall_status"];
            if ($lpcomment != "" || $mark != "" || $status != "notgraded") {
                $info->addSection($this->lng->txt("exc_feedback_from_tutor"));
                if ($lpcomment != "") {
                    $info->addProperty(
                        $this->lng->txt("exc_comment"),
                        $lpcomment
                    );
                }
                if ($mark != "") {
                    $info->addProperty(
                        $this->lng->txt("exc_mark"),
                        $mark
                    );
                }

                //if ($status == "")
                //{
                //  $info->addProperty($this->lng->txt("status"),
                //              $this->lng->txt("message_no_delivered_files"));
                //}
                //else
                if ($status != "notgraded") {
                    $img = '<img src="' . ilUtil::getImagePath("scorm/" . $status . ".svg") . '" ' .
                        ' alt="' . $lng->txt("exc_" . $status) . '" title="' . $lng->txt("exc_" . $status) .
                        '" />';

                    $add = "";
                    if ($st["failed_a_mandatory"]) {
                        $add = " (" . $lng->txt("exc_msg_failed_mandatory") . ")";
                    } elseif ($status == "failed") {
                        $add = " (" . $lng->txt("exc_msg_missed_minimum_number") . ")";
                    }
                    $info->addProperty(
                        $this->lng->txt("status"),
                        $img . " " . $this->lng->txt("exc_" . $status) . $add
                    );
                }
            }
        }
        
        // forward the command
        $this->ctrl->forwardCommand($info);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

infoScreenObject()

ilObjExerciseGUI::infoScreenObject

(

)

this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed

Definition at line 540 of file class.ilObjExerciseGUI.php.

References infoScreen().

Referenced by viewObject().

    {
        $this->ctrl->setCmd("showSummary");
        $this->ctrl->setCmdClass("ilinfoscreengui");
        $this->infoScreen();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initEditCustomForm()

ilObjExerciseGUI::initEditCustomForm ( ilPropertyFormGUI  $a_form )

protected

Init properties form.

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

References $section, ilPropertyFormGUI\addItem(), array, ilExAssignment\countMandatory(), ilOrgUnitGlobalSettings\getInstance(), ilObjectServiceSettingsGUI\initServiceSettingsForm(), object, ilObjectServiceSettingsGUI\ORGU_POSITION_ACCESS, ilRadioOption\setInfo(), ilFormPropertyGUI\setInfo(), ilNumberInputGUI\setSize(), ilPropertyFormGUI\setTitle(), ilObjExercise\TUTOR_FEEDBACK_FILE, ilObjExercise\TUTOR_FEEDBACK_MAIL, and ilObjExercise\TUTOR_FEEDBACK_TEXT.

    {
        $a_form->setTitle($this->lng->txt("exc_edit_exercise"));

        $section = new ilFormSectionHeaderGUI();
        $section->setTitle($this->lng->txt('exc_passing_exc'));
        $a_form->addItem($section);

        // pass mode
        $radg = new ilRadioGroupInputGUI($this->lng->txt("exc_pass_mode"), "pass_mode");
    
        $op1 = new ilRadioOption(
            $this->lng->txt("exc_pass_all"),
            "all",
            $this->lng->txt("exc_pass_all_info")
        );
        $radg->addOption($op1);
        $op2 = new ilRadioOption(
            $this->lng->txt("exc_pass_minimum_nr"),
            "nr",
            $this->lng->txt("exc_pass_minimum_nr_info")
        );
        $radg->addOption($op2);

        // minimum number of assignments to pass
        $ni = new ilNumberInputGUI($this->lng->txt("exc_min_nr"), "pass_nr");
        $ni->setSize(4);
        $ni->setMaxLength(4);
        $ni->setRequired(true);
        include_once("./Modules/Exercise/classes/class.ilExAssignment.php");
        $mand = ilExAssignment::countMandatory($this->object->getId());
        $min = max($mand, 1);
        $ni->setMinValue($min, true);
        $ni->setInfo($this->lng->txt("exc_min_nr_info"));
        $op2->addSubItem($ni);

        $a_form->addItem($radg);

        // completion by submission
        $subcompl = new ilRadioGroupInputGUI($this->lng->txt("exc_passed_status_determination"), "completion_by_submission");
        $op1 = new ilRadioOption($this->lng->txt("exc_completion_by_tutor"), 0, "");
        $subcompl->addOption($op1);
        $op2 = new ilRadioOption($this->lng->txt("exc_completion_by_submission"), 1, $this->lng->txt("exc_completion_by_submission_info"));
        $subcompl->addOption($op2);
        $a_form->addItem($subcompl);

        /*$subcompl = new ilCheckboxInputGUI($this->lng->txt('exc_completion_by_submission'), 'completion_by_submission');
        $subcompl->setInfo($this->lng->txt('exc_completion_by_submission_info'));
        $subcompl->setValue(1);
        $a_form->addItem($subcompl);*/

        $section = new ilFormSectionHeaderGUI();
        $section->setTitle($this->lng->txt('exc_publishing'));
        $a_form->addItem($section);

        // show submissions
        $cb = new ilCheckboxInputGUI($this->lng->txt("exc_show_submissions"), "show_submissions");
        $cb->setInfo($this->lng->txt("exc_show_submissions_info"));
        $a_form->addItem($cb);
        
        $section = new ilFormSectionHeaderGUI();
        $section->setTitle($this->lng->txt('exc_notification'));
        $a_form->addItem($section);

        // submission notifications
        $cbox = new ilCheckboxInputGUI($this->lng->txt("exc_submission_notification"), "notification");
        $cbox->setInfo($this->lng->txt("exc_submission_notification_info"));
        $a_form->addItem($cbox);
        
        
        // feedback settings
        
        $section = new ilFormSectionHeaderGUI();
        $section->setTitle($this->lng->txt('exc_feedback'));
        $a_form->addItem($section);
        
        $fdb = new ilCheckboxGroupInputGUI($this->lng->txt("exc_settings_feedback"), "tfeedback");
        $a_form->addItem($fdb);
        
        $option = new ilCheckboxOption($this->lng->txt("exc_settings_feedback_mail"), ilObjExercise::TUTOR_FEEDBACK_MAIL);
        $option->setInfo($this->lng->txt("exc_settings_feedback_mail_info"));
        $fdb->addOption($option);
        $option = new ilCheckboxOption($this->lng->txt("exc_settings_feedback_file"), ilObjExercise::TUTOR_FEEDBACK_FILE);
        $option->setInfo($this->lng->txt("exc_settings_feedback_file_info"));
        $fdb->addOption($option);
        $option = new ilCheckboxOption($this->lng->txt("exc_settings_feedback_text"), ilObjExercise::TUTOR_FEEDBACK_TEXT);
        $option->setInfo($this->lng->txt("exc_settings_feedback_text_info"));
        $fdb->addOption($option);
        
        $position_settings = ilOrgUnitGlobalSettings::getInstance()
            ->getObjectPositionSettingsByType($this->object->getType());

        if ($position_settings->isActive()) {
            // add additional feature section
            $feat = new ilFormSectionHeaderGUI();
            $feat->setTitle($this->lng->txt('obj_features'));
            $a_form->addItem($feat);

            // add orgunit settings
            ilObjectServiceSettingsGUI::initServiceSettingsForm(
                $this->object->getId(),
                $a_form,
                array(
                        ilObjectServiceSettingsGUI::ORGU_POSITION_ACCESS
                    )
            );
        }
    }

Here is the call graph for this function:

listAssignmentsObject()

ilObjExerciseGUI::listAssignmentsObject ( )

protected

Definition at line 221 of file class.ilObjExerciseGUI.php.

References ilObjectGUI\$ctrl, $ilCtrl, and ilObjectGUI\checkPermissionBool().

    {
        $ilCtrl = $this->ctrl;
        
        $this->checkPermissionBool("write");
        
        // #16587
        $ilCtrl->redirectByClass("ilExAssignmentEditorGUI", "listAssignments");
    }

Here is the call graph for this function:

outCertificateObject()

ilObjExerciseGUI::outCertificateObject

(

)

Definition at line 879 of file class.ilObjExerciseGUI.php.

References $certificate, $ilUser, ilObjectGUI\$user, array, object, ilUtil\sendFailure(), and showOverviewObject().

    {
        $ilUser = $this->user;
    
        if ($this->object->hasUserCertificate($ilUser->getId())) {
            ilUtil::sendFailure($this->lng->txt("msg_failed"));
            $this->showOverviewObject();
        }
        
        include_once "./Services/Certificate/classes/class.ilCertificate.php";
        include_once "./Modules/Exercise/classes/class.ilExerciseCertificateAdapter.php";
        $certificate = new ilCertificate(new ilExerciseCertificateAdapter($this->object));
        $certificate->outCertificate(array("user_id" => $ilUser->getId()));
    }

Here is the call graph for this function:

setSettingsSubTabs()

ilObjExerciseGUI::setSettingsSubTabs ( )

protected

Definition at line 661 of file class.ilObjExerciseGUI.php.

References ilCertificate\isActive().

Referenced by certificateObject(), editObject(), and executeCommand().

    {
        $this->tabs_gui->addSubTab(
            "edit",
            $this->lng->txt("general_settings"),
            $this->ctrl->getLinkTarget($this, "edit")
        );
        
        $this->tabs_gui->addSubTab(
            "crit",
            $this->lng->txt("exc_criteria_catalogues"),
            $this->ctrl->getLinkTargetByClass("ilexccriteriacataloguegui", "")
        );
        
        include_once "Services/Certificate/classes/class.ilCertificate.php";
        if (ilCertificate::isActive()) {
            $this->tabs_gui->addSubTab(
                "certificate",
                $this->lng->txt("certificate"),
                $this->ctrl->getLinkTarget($this, "certificate")
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showOverviewObject()

ilObjExerciseGUI::showOverviewObject

(

)

Show overview of assignments.

Definition at line 796 of file class.ilObjExerciseGUI.php.

References $_GET, $adapter, $ilUser, $tabs, ilObjectGUI\$toolbar, ilObjectGUI\$tpl, ilObjectGUI\$user, ilCertificate\_isComplete(), ilLearningProgress\_tracProgress(), addContentSubTabs(), ilObjectGUI\checkPermission(), ilExAssignment\getInstancesByExercise(), and object.

Referenced by outCertificateObject().

    {
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        $ilUser = $this->user;
        $ilToolbar = $this->toolbar;
        
        $this->checkPermission("read");

        $tpl->addJavaScript("./Modules/Exercise/js/ilExcPresentation.js");
        
        include_once("./Services/Tracking/classes/class.ilLearningProgress.php");
        ilLearningProgress::_tracProgress(
            $ilUser->getId(),
            $this->object->getId(),
            $this->object->getRefId(),
            'exc'
        );
        
        $ilTabs->activateTab("content");
        $this->addContentSubTabs("content");
        
        // show certificate?
        if ($this->object->hasUserCertificate($ilUser->getId())) {
            include_once "./Modules/Exercise/classes/class.ilExerciseCertificateAdapter.php";
            include_once "./Services/Certificate/classes/class.ilCertificate.php";
            $adapter = new ilExerciseCertificateAdapter($this->object);
            if (ilCertificate::_isComplete($adapter)) {
                $ilToolbar->addButton(
                    $this->lng->txt("certificate"),
                    $this->ctrl->getLinkTarget($this, "outCertificate")
                );
            }
        }
        
        include_once("./Modules/Exercise/classes/class.ilExAssignmentGUI.php");
        $ass_gui = new ilExAssignmentGUI($this->object);
                
        include_once("./Modules/Exercise/classes/class.ilExAssignment.php");
        include_once("./Services/Accordion/classes/class.ilAccordionGUI.php");
        $acc = new ilAccordionGUI();
        $acc->setId("exc_ow_" . $this->object->getId());

        $ass_data = ilExAssignment::getInstancesByExercise($this->object->getId());
        foreach ($ass_data as $ass) {
            // incoming assignment deeplink
            $force_open = false;
            if (isset($_GET["ass_id_goto"]) &&
                (int) $_GET["ass_id_goto"] == $ass->getId()) {
                $force_open = true;
            }
            
            $acc->addItem(
                $ass_gui->getOverviewHeader($ass),
                $ass_gui->getOverviewBody($ass),
                $force_open
            );
        }
        
        if (count($ass_data) < 2) {
            $acc->setBehaviour("FirstOpen");
        } else {
            $acc->setUseSessionStorage(true);
        }

        $mtpl = new ilTemplate("tpl.exc_ass_overview.html", true, true, "Modules/Exercise");
        $mtpl->setVariable("CONTENT", $acc->getHTML());

        $tpl->setContent($mtpl->get());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateCustom()

ilObjExerciseGUI::updateCustom ( ilPropertyFormGUI  $a_form )

protected

Definition at line 383 of file class.ilObjExerciseGUI.php.

References $ilUser, ilObjectGUI\$user, array, ilPropertyFormGUI\getInput(), object, ilObjectServiceSettingsGUI\ORGU_POSITION_ACCESS, ilNotification\setNotification(), ilNotification\TYPE_EXERCISE_SUBMISSION, and ilObjectServiceSettingsGUI\updateServiceSettingsForm().

    {
        $ilUser = $this->user;
        $this->object->setShowSubmissions($a_form->getInput("show_submissions"));
        $this->object->setPassMode($a_form->getInput("pass_mode"));
        if ($this->object->getPassMode() == "nr") {
            $this->object->setPassNr($a_form->getInput("pass_nr"));
        }
        
        $this->object->setCompletionBySubmission($a_form->getInput('completion_by_submission') == 1 ? true : false);
        
        $feedback = $a_form->getInput("tfeedback");
        $this->object->setTutorFeedback(is_array($feedback)
            ? array_sum($feedback)
            : null);
        
        include_once "./Services/Notification/classes/class.ilNotification.php";
        ilNotification::setNotification(
            ilNotification::TYPE_EXERCISE_SUBMISSION,
            $ilUser->getId(),
            $this->object->getId(),
            (bool) $a_form->getInput("notification")
        );
        
        
        ilObjectServiceSettingsGUI::updateServiceSettingsForm(
            $this->object->getId(),
            $a_form,
            array(
                ilObjectServiceSettingsGUI::ORGU_POSITION_ACCESS
            )
        );
    }

Here is the call graph for this function:

viewObject()

ilObjExerciseGUI::viewObject

(

)

Definition at line 204 of file class.ilObjExerciseGUI.php.

References infoScreenObject().

    {
        $this->infoScreenObject();
    }

Here is the call graph for this function:

Field Documentation

$help

ilObjExerciseGUI::$help

protected

Definition at line 33 of file class.ilObjExerciseGUI.php.

Referenced by getTabs().

$tabs

ilObjExerciseGUI::$tabs

protected

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

Referenced by addContentSubTabs(), executeCommand(), infoScreen(), and showOverviewObject().

---

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

• Modules/Exercise/classes/class.ilObjExerciseGUI.php