ilObjLearningResourcesSettingsGUI Class Reference

Learning Resources Settings. More...

Inheritance diagram for ilObjLearningResourcesSettingsGUI:

Collaboration diagram for ilObjLearningResourcesSettingsGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
	Contructor. More...
	executeCommand ()
	Execute command. More...
	getAdminTabs ()
	Get tabs. More...
	editSettings ()
	Edit learning resources settings. More...
	saveSettings ()
	Save learning resources settings. More...
	addToExternalSettingsForm ($a_form_id)
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...

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

Static Private Attributes
static	$ERROR_MESSAGE

Additional Inherited Members
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...
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
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...

Detailed Description

Learning Resources Settings.

Author

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

Version

$Id$

ilObjLearningResourcesSettingsGUI: ilPermissionGUI ilObjLearningResourcesSettingsGUI: ilLicenseOverviewGUI ilObjLearningResourcesSettingsGUI: ilAdministrationGUI

Definition at line 19 of file class.ilObjLearningResourcesSettingsGUI.php.

Constructor & Destructor Documentation

__construct()

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

Contructor.

public

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

References $DIC, and settings().

    {
        global $DIC;

        $this->rbacsystem = $DIC->rbac()->system();
        $this->error = $DIC["ilErr"];
        $this->access = $DIC->access();
        $this->settings = $DIC->settings();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->type = 'lrss';
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);

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

Here is the call graph for this function:

Member Function Documentation

addToExternalSettingsForm()

ilObjLearningResourcesSettingsGUI::addToExternalSettingsForm

(

$a_form_id

)

Definition at line 360 of file class.ilObjLearningResourcesSettingsGUI.php.

References ilPrivacySettings\_getInstance(), array, ilAdministrationSettingsFormHandler\FORM_PRIVACY, and ilAdministrationSettingsFormHandler\VALUE_BOOL.

    {
        switch ($a_form_id) {
            case ilAdministrationSettingsFormHandler::FORM_PRIVACY:
                
                $privacy = ilPrivacySettings::_getInstance();
                
                $fields = array('enable_sahs_protocol_data' => array($privacy->enabledSahsProtocolData(), ilAdministrationSettingsFormHandler::VALUE_BOOL));
                
                return array(array("editSettings", $fields));
        }
    }

Here is the call graph for this function:

editSettings()

ilObjLearningResourcesSettingsGUI::editSettings

(

)

Edit learning resources settings.

Definition at line 142 of file class.ilObjLearningResourcesSettingsGUI.php.

References ilObjectGUI\$ctrl, $form, $ilCtrl, $ilSetting, $lm_set, ilObjectGUI\$lng, $options, ilObjectGUI\$settings, $si, ilPrivacySettings\_getInstance(), array, ilObjectGUI\checkPermissionBool(), ilFormPropertyGUI\setInfo(), ilSelectInputGUI\setOptions(), and ilNumberInputGUI\setSize().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilSetting = $this->settings;

        $lm_set = new ilSetting("lm");
        $lic_set = new ilSetting("license");
        $lng->loadLanguageModule("license");
        $lng->loadLanguageModule("scormdebug");

        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this));
        $form->setTitle($lng->txt("cont_lrs_settings"));
        
        // Page History
        $cb_prop = new ilCheckboxInputGUI(
            $lng->txt("cont_enable_page_history"),
            "page_history"
        );
        $cb_prop->setInfo($lng->txt("cont_enable_page_history_info"));
        $cb_prop->setChecked($lm_set->get("page_history", 1));
        $form->addItem($cb_prop);
        
        // Time scheduled page activation
        $cb_prop = new ilCheckboxInputGUI(
            $lng->txt("cont_enable_time_scheduled_page_activation"),
            "time_scheduled_page_activation"
        );
        $cb_prop->setInfo($lng->txt("cont_enable_time_scheduled_page_activation_info"));
        $cb_prop->setChecked($lm_set->get("time_scheduled_page_activation"));
        $form->addItem($cb_prop);

        // lm starting point
        $options = array(
            "" => $this->lng->txt("cont_last_visited_page"),
            "first" => $this->lng->txt("cont_first_page")
            );
        $si = new ilSelectInputGUI($this->lng->txt("cont_lm_starting_point"), "lm_starting_point");
        $si->setOptions($options);
        $si->setValue($lm_set->get("lm_starting_point"));
        $si->setInfo($this->lng->txt("cont_lm_starting_point_info"));
        $form->addItem($si);

        // Activate replace media object function
        $cb_prop = new ilCheckboxInputGUI(
            $lng->txt("cont_replace_mob_feature"),
            "replace_mob_feature"
        );
        $cb_prop->setInfo($lng->txt("cont_replace_mob_feature_info"));
        $cb_prop->setChecked($lm_set->get("replace_mob_feature"));
        $form->addItem($cb_prop);

        // Activate HTML export IDs
        $cb_prop = new ilCheckboxInputGUI(
            $lng->txt("cont_html_export_ids"),
            "html_export_ids"
        );
        $cb_prop->setInfo($lng->txt("cont_html_export_ids_info"));
        $cb_prop->setChecked($lm_set->get("html_export_ids"));
        $form->addItem($cb_prop);

        // Upload dir for learning resources
        $tx_prop = new ilTextInputGUI(
            $lng->txt("cont_upload_dir"),
            "cont_upload_dir"
        );
        $tx_prop->setInfo($lng->txt("cont_upload_dir_info"));
        $tx_prop->setValue($lm_set->get("cont_upload_dir"));
        $form->addItem($tx_prop);


        // license activation
        $cb_prop = new ilCheckboxInputGUI(
            $lng->txt("license_counter"),
            "license_counter"
        );
        $cb_prop->setInfo($lng->txt("license_counter_info"));
        $cb_prop->setChecked($lic_set->get("license_counter"));
        $form->addItem($cb_prop);
        
        // license warning
        $tx_prop = new ilNumberInputGUI(
            $lng->txt("license_warning"),
            "license_warning"
        );
        $tx_prop->setSize(5);
        $tx_prop->setInfo($lng->txt("license_warning_info"));
        $tx_prop->setValue($lic_set->get("license_warning"));
        $form->addItem($tx_prop);
        
        // scormDebugger activation
        $cb_prop = new ilCheckboxInputGUI($lng->txt("scormdebug_global_activate"), "scormdebug_global_activate");
        $cb_prop->setInfo($lng->txt("scormdebug_global_activate_info"));
        $cb_prop->setChecked($lm_set->get("scormdebug_global_activate"));
        $form->addItem($cb_prop);

        // scorm2004 disableRTECaching
        $cb_prop = new ilCheckboxInputGUI(
            $lng->txt("scormdebug_disable_cache"),
            "scormdebug_disable_cache"
        );
        $cb_prop->setInfo($lng->txt("scormdebug_disable_cache_info"));
        $cb_prop->setChecked($lm_set->get("scormdebug_disable_cache"));
        $form->addItem($cb_prop);

        // scorm2004 without session
        $cb_prop = new ilCheckboxInputGUI(
            $lng->txt("scorm_without_session"),
            "scorm_without_session"
        );
        $cb_prop->setInfo($lng->txt("scorm_without_session_info"));
        $cb_prop->setChecked($lm_set->get("scorm_without_session"));
        $form->addItem($cb_prop);
        
        $privacy = ilPrivacySettings::_getInstance();
        $check = new ilCheckboxInputGui($lng->txt('enable_sahs_protocol_data'), 'enable_sahs_pd');
        $check->setInfo($this->lng->txt('enable_sahs_protocol_data_desc'));
        $check->setChecked($privacy->enabledSahsProtocolData());
        $form->addItem($check);

        // show and export protocol data with name
        $check = new ilCheckboxInputGui($this->lng->txt('ps_export_scorm'), 'export_scorm');
        $check->setInfo($this->lng->txt('enable_export_scorm_desc'));
        $check->setChecked($privacy->enabledExportSCORM());
        $form->addItem($check);

        // scorm auto-setting for learning progress
        $cb_prop = new ilCheckboxInputGUI($lng->txt("scorm_lp_auto_activate"), "scorm_lp_auto_activate");
        $cb_prop->setInfo($lng->txt("scorm_lp_auto_activate_info"));
        $cb_prop->setChecked($lm_set->get("scorm_lp_auto_activate"));
        $form->addItem($cb_prop);

        // command buttons
        if ($this->checkPermissionBool("write")) {
            $form->addCommandButton("saveSettings", $lng->txt("save"));
            $form->addCommandButton("view", $lng->txt("cancel"));
        }

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

Here is the call graph for this function:

executeCommand()

ilObjLearningResourcesSettingsGUI::executeCommand

(

)

Execute command.

public

Definition at line 59 of file class.ilObjLearningResourcesSettingsGUI.php.

References ilObjectGUI\$access, $error, ilObjectGUI\$ilErr, $rbacsystem, $ret, ilLicenseOverviewGUI\LIC_MODE_ADMINISTRATION, and ilObjectGUI\prepareOutput().

    {
        $rbacsystem = $this->rbacsystem;
        $ilErr = $this->error;
        $ilAccess = $this->access;

        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        $this->prepareOutput();

        if (!$ilAccess->checkAccess('read', '', $this->object->getRefId())) {
            $ilErr->raiseError($this->lng->txt('no_permission'), $ilErr->WARNING);
        }

        switch ($next_class) {
            case 'illicenseoverviewgui':
                include_once("./Services/License/classes/class.ilLicenseOverviewGUI.php");
                $license_gui = new ilLicenseOverviewGUI($this, ilLicenseOverviewGUI::LIC_MODE_ADMINISTRATION);
                $ret = $this->ctrl->forwardCommand($license_gui);
                break;

            case 'ilpermissiongui':
                $this->tabs_gui->setTabActive('perm_settings');
                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                $perm_gui = new ilPermissionGUI($this);
                $ret = $this->ctrl->forwardCommand($perm_gui);
                break;

            default:
                if (!$cmd || $cmd == 'view') {
                    $cmd = "editSettings";
                }

                $this->$cmd();
                break;
        }
        return true;
    }

Here is the call graph for this function:

getAdminTabs()

ilObjLearningResourcesSettingsGUI::getAdminTabs

(

)

Get tabs.

public

Definition at line 105 of file class.ilObjLearningResourcesSettingsGUI.php.

References ilObjectGUI\$access, $ilSetting, $rbacsystem, ilObjectGUI\$settings, ilLicenseAccess\_isEnabled(), and array.

    {
        $rbacsystem = $this->rbacsystem;
        $ilAccess = $this->access;
        $ilSetting = $this->settings;

        if ($rbacsystem->checkAccess("visible,read", $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                "cont_edit_lrs_settings",
                $this->ctrl->getLinkTarget($this, "editSettings"),
                array("editSettings", "view")
            );

            include_once("Services/License/classes/class.ilLicenseAccess.php");
            if (ilLicenseAccess::_isEnabled()) {
                $this->tabs_gui->addTarget(
                    "licenses",
                    $this->ctrl->getLinkTargetByClass('illicenseoverviewgui', ''),
                    "",
                    "illicenseoverviewgui"
                );
            }
        }

        if ($rbacsystem->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                "perm_settings",
                $this->ctrl->getLinkTargetByClass('ilpermissiongui', "perm"),
                array(),
                'ilpermissiongui'
            );
        }
    }

Here is the call graph for this function:

saveSettings()

ilObjLearningResourcesSettingsGUI::saveSettings

(

)

Save learning resources settings.

Definition at line 288 of file class.ilObjLearningResourcesSettingsGUI.php.

References $_POST, ilObjectGUI\$ctrl, $ilCtrl, $ilSetting, $lm_set, ilObjectGUI\$settings, ilPrivacySettings\_getInstance(), ilObjectGUI\checkPermission(), ilUtil\sendSuccess(), and ilUtil\stripSlashes().

    {
        $ilCtrl = $this->ctrl;
        $ilSetting = $this->settings;

        $this->checkPermission("write");
        
        $lm_set = new ilSetting("lm");
        $lm_set->set(
            "time_scheduled_page_activation",
            ilUtil::stripSlashes($_POST["time_scheduled_page_activation"])
        );
        $lm_set->set(
            "lm_starting_point",
            ilUtil::stripSlashes($_POST["lm_starting_point"])
        );
        $lm_set->set(
            "page_history",
            (int) ilUtil::stripSlashes($_POST["page_history"])
        );
        $lm_set->set(
            "replace_mob_feature",
            ilUtil::stripSlashes($_POST["replace_mob_feature"])
        );
        $lm_set->set(
            "html_export_ids",
            ilUtil::stripSlashes($_POST["html_export_ids"])
        );
        $lm_set->set(
            "cont_upload_dir",
            ilUtil::stripSlashes($_POST["cont_upload_dir"])
        );
        $lm_set->setScormDebug(
            "scormdebug_global_activate",
            ilUtil::stripSlashes($_POST["scormdebug_global_activate"])
        );
        $lm_set->set(
            "scorm_login_as_learner_id",
            ilUtil::stripSlashes($_POST["scorm_login_as_learner_id"])
        );
        $lm_set->set(
            "scormdebug_disable_cache",
            ilUtil::stripSlashes($_POST["scormdebug_disable_cache"])
        );
        $lm_set->set(
            "scorm_without_session",
            ilUtil::stripSlashes($_POST["scorm_without_session"])
        );
        $lm_set->set(
            "scorm_lp_auto_activate",
            ilUtil::stripSlashes($_POST["scorm_lp_auto_activate"])
        );
        $lic_set = new ilSetting("license");
        $lic_set->set(
            "license_counter",
            ilUtil::stripSlashes($_POST["license_counter"])
        );
        $lic_set->set(
            "license_warning",
            ilUtil::stripSlashes($_POST["license_warning"])
        );
        
        $privacy = ilPrivacySettings::_getInstance();
        $privacy->enableSahsProtocolData((int) $_POST['enable_sahs_pd']);
        $privacy->enableExportSCORM((int) $_POST['export_scorm']);
        $privacy->save();

        ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);

        $ilCtrl->redirect($this, "view");
    }

Here is the call graph for this function:

Field Documentation

$error

ilObjLearningResourcesSettingsGUI::$error

protected

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

Referenced by executeCommand().

$ERROR_MESSAGE

ilObjLearningResourcesSettingsGUI::$ERROR_MESSAGE

staticprivate

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

$rbacsystem

ilObjLearningResourcesSettingsGUI::$rbacsystem

protected

Definition at line 24 of file class.ilObjLearningResourcesSettingsGUI.php.

Referenced by executeCommand(), and getAdminTabs().

---

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

• Modules/LearningModule/classes/class.ilObjLearningResourcesSettingsGUI.php