ilObjSAHSLearningModuleGUI Class Reference

SCORM/AICC/HACP Learning Modules. More...

Inheritance diagram for ilObjSAHSLearningModuleGUI:

Collaboration diagram for ilObjSAHSLearningModuleGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference, $a_prepare_output=true)
	Constructor. More...
	executeCommand ()
	execute command More...
	viewObject ()
	properties ()
	module properties More...
	saveProperties ()
	save properties More...
	initCreationForms ($a_new_type)
	no manual SCORM creation, only import at the time More...
	initCreationForm ()
	Init form. More...
	initUploadForm ()
	Init upload form. More...
	uploadObject ()
	display status information or report errors messages in case of error More...
	upload ()
	saveObject ()
	save new learning module to db More...
	info ()
	permission form More...
	owner ()
	show owner of learning module More...
	getTemplate ()
	output main header (title and locator) More...
	setTabs ()
	output tabs More...
	certificate ()
	Shows the certificate editor. More...
	getTabs ()
	adds tabs to tab gui object More...
	addLocatorItems ()
	editContent ()
	List files. More...
	setSettingsSubTabs ()
	set Tabs for settings More...
	export ()
	exportModule ()
	getType ()
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...
	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)
	goto target course 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...

Additional Inherited Members
Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1
	$ilias
	$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...
	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...
	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 inherited from ilObjectGUI
	$tmp_import_dir
	$tabs_gui = null
	$ctrl

Detailed Description

SCORM/AICC/HACP Learning Modules.

Author

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

ilObjSAHSLearningModuleGUI: ilFileSystemGUI, ilObjectMetaDataGUI, ilPermissionGUI, ilInfoScreenGUI, ilLearningProgressGUI ilObjSAHSLearningModuleGUI: ilLicenseGUI, ilCommonActionDispatcherGUI, ilExportGUI

Definition at line 17 of file class.ilObjSAHSLearningModuleGUI.php.

Constructor & Destructor Documentation

__construct()

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

Constructor.

public

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

References ilObjectGUI\$lng.

        {
                global $lng;

                $lng->loadLanguageModule("content");
                $this->type = "sahs";
                parent::__construct($a_data,$a_id,$a_call_by_reference,false);
        }

Member Function Documentation

_goto()

static ilObjSAHSLearningModuleGUI::_goto (   $a_target )

static

goto target course

Definition at line 762 of file class.ilObjSAHSLearningModuleGUI.php.

References $_GET, $ilErr, ilObjectGUI\$lng, ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), exit, and ilUtil\sendInfo().

        {
                global $ilAccess, $ilErr, $lng;

                $parts = explode("_", $a_target);

                if ($ilAccess->checkAccess("write", "", $parts[0]))
                {
                        $_GET["cmd"] = "";
                        $_GET["baseClass"] = "ilSAHSEditGUI";
                        $_GET["ref_id"] = $parts[0];
                        $_GET["obj_id"] = $parts[1];
                        include("ilias.php");
                        exit;
                }
                if ($ilAccess->checkAccess("visible", "", $parts[0]) || $ilAccess->checkAccess("read", "", $parts[0]))
                {
                        $_GET["cmd"] = "infoScreen";
                        $_GET["baseClass"] = "ilSAHSPresentationGUI";
                        $_GET["ref_id"] = $parts[0];
                        include("ilias.php");
                        exit;
                }
                else
                {
                        if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID))
                        {
                                ilUtil::sendInfo(sprintf($lng->txt("msg_no_perm_read_item"),
                                        ilObject::_lookupTitle(ilObject::_lookupObjId($parts[0]))), true);
                                ilObjectGUI::_gotoRepositoryRoot();
                        }
                }

                $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
        }

Here is the call graph for this function:

addLocatorItems()

ilObjSAHSLearningModuleGUI::addLocatorItems

(

)

Definition at line 798 of file class.ilObjSAHSLearningModuleGUI.php.

References $_GET, and object.

        {
                global $ilLocator;
                
                if (is_object($this->object))
                {
                        $ilLocator->addItem($this->object->getTitle(),
                                $this->ctrl->getLinkTargetByClass("ilinfoscreengui", "showSummary"), "", $_GET["ref_id"]);
                }
        }

certificate()

ilObjSAHSLearningModuleGUI::certificate

(

)

Shows the certificate editor.

Definition at line 635 of file class.ilObjSAHSLearningModuleGUI.php.

        {
                include_once "./Services/Certificate/classes/class.ilCertificateGUI.php";
                include_once "./Modules/ScormAicc/classes/class.ilSCORMCertificateAdapter.php";
                $output_gui = new ilCertificateGUI(new ilSCORMCertificateAdapter($this->object));
                $output_gui->certificateEditor();
        }

editContent()

ilObjSAHSLearningModuleGUI::editContent

(

)

List files.

Parameters

Definition at line 815 of file class.ilObjSAHSLearningModuleGUI.php.

References $ilCtrl, and object.

        {
                global $ilCtrl;
                
                if (!$this->object->getEditable())
                {
                        $ilCtrl->redirectByClass("ilfilesystemgui", "listFiles");
                }
                else
                {
                        $ilCtrl->redirectByClass("ilobjscorm2004learningmodulegui", "editOrganization");
                }
        }

executeCommand()

ilObjSAHSLearningModuleGUI::executeCommand

(

)

execute command

Definition at line 36 of file class.ilObjSAHSLearningModuleGUI.php.

References $_GET, $cmd, $GLOBALS, $ilErr, $info, $ret, ilObjectGUI\getCreationMode(), ilUtil\getImagePath(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), getTemplate(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, object, ilObjectGUI\omitLocator(), ilObjectGUI\prepareOutput(), ilObjectGUI\setLocator(), setSettingsSubTabs(), setTabs(), and ilFileSystemGUI\setUseUploadDirectory().

        {
                global $ilAccess, $ilTabs, $ilErr;
                
                $GLOBALS["ilLog"]->write ("bc:".$_GET["baseClass"]."; nc:".$this->ctrl->getNextClass($this)."; cmd:".$this->ctrl->getCmd());
                if (strtolower($_GET["baseClass"]) == "iladministrationgui" ||
                        strtolower($_GET["baseClass"]) == "ilsahspresentationgui" ||
                        $this->getCreationMode() == true)
                {
                        $this->prepareOutput();
                }
                else
                {
                        $this->getTemplate();
                        $this->setLocator();
                        $this->setTabs();
                        $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_lm.svg"));
                        $this->tpl->setTitle($this->object->getTitle());
                }

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

                switch($next_class)
                {
                        case 'ilobjectmetadatagui':
                                if(!$ilAccess->checkAccess('write','',$this->object->getRefId()))
                                {
                                        $ilErr->raiseError($this->lng->txt('permission_denied'),$ilErr->WARNING);
                                }                               
                                include_once 'Services/Object/classes/class.ilObjectMetaDataGUI.php';
                                $md_gui = new ilObjectMetaDataGUI($this->object);       
                                $this->ctrl->forwardCommand($md_gui);
                                break;
                                
                        case 'ilexportgui':
                        case 'ilpermissiongui':
                                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                                $perm_gui = new ilPermissionGUI($this);
                                $ret = $this->ctrl->forwardCommand($perm_gui);
                                break;

                        case "ilfilesystemgui":
                                $this->fs_gui = new ilFileSystemGUI($this->object->getDataDirectory());
                                $this->fs_gui->setUseUploadDirectory(true);
                                $this->fs_gui->setTableId("sahsfs".$this->object->getId());
                                $ret = $this->ctrl->forwardCommand($this->fs_gui);
                                break;

                        case "ilcertificategui":
                                $this->setSettingsSubTabs();
                                $ilTabs->setSubTabActive('certificate');
                                include_once "./Services/Certificate/classes/class.ilCertificateGUI.php";
                                include_once "./Modules/ScormAicc/classes/class.ilSCORMCertificateAdapter.php";
                                $output_gui = new ilCertificateGUI(new ilSCORMCertificateAdapter($this->object));
                                $ret = $this->ctrl->forwardCommand($output_gui);
                                break;

                        case "illearningprogressgui":
                                include_once './Services/Tracking/classes/class.ilLearningProgressGUI.php';

                                $new_gui = new ilLearningProgressGUI(ilLearningProgressGUI::LP_CONTEXT_REPOSITORY,$this->object->getRefId());
                                $this->ctrl->forwardCommand($new_gui);

                                break;

                        case 'illicensegui':
                                include_once("./Services/License/classes/class.ilLicenseGUI.php");
                                $license_gui = new ilLicenseGUI($this);
                                $ret = $this->ctrl->forwardCommand($license_gui);
                                break;

                        case "ilinfoscreengui":
                                include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");

                                $info = new ilInfoScreenGUI($this);
                                $info->enablePrivateNotes();
                                $info->enableLearningProgress();
                                
                                // add read / back button
                                if ($ilAccess->checkAccess("read", "", $_GET["ref_id"]))
                                {
                                        if (!$this->object->getEditable())
                                        {
                                                $info->addButton($this->lng->txt("view"),
                                                        "ilias.php?baseClass=ilSAHSPresentationGUI&ref_id=".$this->object->getRefID(),
                                                        ' target="ilContObj'.$this->object->getId().'" ');
                                        }
                                }

                                $info->enableNews();
                                if ($ilAccess->checkAccess("write", "", $_GET["ref_id"]))
                                {
                                        $info->enableNewsEditing();
                                        $news_set = new ilSetting("news");
                                        $enable_internal_rss = $news_set->get("enable_rss_for_internal");
                                        if ($enable_internal_rss)
                                        {
                                                $info->setBlockProperty("news", "settings", true);
                                        }
                                }
                                // show standard meta data section
                                $info->addMetaDataSections($this->object->getId(),0, $this->object->getType());
                
                                // forward the command
                                $this->ctrl->forwardCommand($info);
                                break;
                                
                        case "ilcommonactiondispatchergui":
                                include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
                                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                                $this->ctrl->forwardCommand($gui);
                                break;

                        case "ilobjstylesheetgui":
                                //$this->addLocations();
                                $this->ctrl->setReturn($this, "properties");
                                $ilTabs->clearTargets();
                                $style_gui = new ilObjStyleSheetGUI("", $this->object->getStyleSheetId(), false, false);
                                $style_gui->omitLocator();
                                if ($cmd == "create" || $_GET["new_type"]=="sty")
                                {
                                        $style_gui->setCreationMode(true);
                                }
                                //$ret =& $style_gui->executeCommand();

                                if ($cmd == "confirmedDelete")
                                {
                                        $this->object->setStyleSheetId(0);
                                        $this->object->update();
                                }
                                $ret = $this->ctrl->forwardCommand($style_gui);
                                if ($cmd == "save" || $cmd == "copyStyle" || $cmd == "importStyle")
                                {
                                        $style_id = $ret;
                                        $this->object->setStyleSheetId($style_id);
                                        $this->object->update();
                                        $this->ctrl->redirectByClass("ilobjstylesheetgui", "edit");
                                }
                                break;
                        default:
                                if ($this->object && !$this->object->getEditable())
                                {
                                        $cmd = $this->ctrl->getCmd("properties");
                                }
                                else
                                {
                                        $cmd = $this->ctrl->getCmd("frameset");
                                }
                                if ((strtolower($_GET["baseClass"]) == "iladministrationgui" ||
                                        $this->getCreationMode() == true) &&
                                        $cmd != "frameset")
                                {
                                        $cmd.= "Object";
                                }
                                
                                // #9225
                                if($cmd == "redrawHeaderAction")
                                {
                                        $cmd .= "Object";
                                }

                                $ret = $this->$cmd();
                                break;
                }
        }

Here is the call graph for this function:

export()

ilObjSAHSLearningModuleGUI::export

(

)

Definition at line 862 of file class.ilObjSAHSLearningModuleGUI.php.

References $ilCtrl, ilObjectGUI\$lng, $ret, and ilObjectGUI\$tpl.

        {
                                global $lng, $ilTabs, $ilCtrl, $tpl;
                                $ilTabs->activateTab("export");
                                include_once("./Services/Export/classes/class.ilExportGUI.php");
                                $exp_gui = new ilExportGUI($this);
                                $ilCtrl->setCmd("");
                                $exp_gui->addFormat("xml");
                                $ret = $this->ctrl->forwardCommand($exp_gui);
                                return $ret;
        }

exportModule()

ilObjSAHSLearningModuleGUI::exportModule

(

)

Definition at line 874 of file class.ilObjSAHSLearningModuleGUI.php.

References $_GET, $ilDB, and ilObject\_lookupObjectId().

        {
                global $ilDB;

                $moduleId = ilObject::_lookupObjectId($_GET["ref_id"]);
                require_once "./Modules/ScormAicc/classes/class.ilScormAiccExporter.php";
                $exporter = new ilScormAiccExporter();
                $xml = $exporter->getXmlRepresentation("sahs", "5.1.0", $moduleId);
        }

Here is the call graph for this function:

getTabs()

ilObjSAHSLearningModuleGUI::getTabs

(

)

adds tabs to tab gui object

Parameters

object

$tabs_gui

ilTabsGUI object

Definition at line 648 of file class.ilObjSAHSLearningModuleGUI.php.

References $ilCtrl, ilPrivacySettings\_getInstance(), ilLicenseAccess\_isEnabled(), array, ilLearningProgressAccess\checkAccess(), and object.

Referenced by setTabs().

        {
                global $rbacsystem, $ilCtrl, $ilHelp;
                
                if ($this->ctrl->getCmd() == "delete")
                {
                        return;
                }

                switch ($this->object->getSubType())
                {
                        case "scorm2004":
                                $ilHelp->setScreenIdComponent("sahs13");
                                break;
                                
                        case "scorm":
                                $ilHelp->setScreenIdComponent("sahs12");
                                break;
                }
                
                // file system gui tabs
                // properties
                $ilCtrl->setParameterByClass("ilfilesystemgui", "resetoffset", 1);
                $this->tabs_gui->addTarget("cont_list_files",
                        $this->ctrl->getLinkTargetByClass("ilfilesystemgui", "listFiles"), "",
                        "ilfilesystemgui");
                $ilCtrl->setParameterByClass("ilfilesystemgui", "resetoffset", "");

                // info screen
                $force_active = ($this->ctrl->getNextClass() == "ilinfoscreengui")
                        ? true
                        : false;
                $this->tabs_gui->addTarget("info_short",
                        $this->ctrl->getLinkTargetByClass("ilinfoscreengui", "showSummary"), "",
                        "ilinfoscreengui", "", $force_active);
                        
                // properties
                $this->tabs_gui->addTarget("settings",
                        $this->ctrl->getLinkTarget($this, "properties"), array("", "properties"),
                        get_class($this));
                        
                // learning progress and offline mode
                include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
                if(ilLearningProgressAccess::checkAccess($this->object->getRefId()))
                {
                        //if scorm && offline_mode activated
                        if ($this->object->getSubType() == "scorm2004" || $this->object->getSubType() == "scorm") {
                                if ($this->object->getOfflineMode() == true) {
                                        $this->tabs_gui->addTarget("offline_mode_manager",
                                                                                $this->ctrl->getLinkTarget($this, "offlineModeManager"), 
                                                                                "offlineModeManager",
                                                                                "ilobjscormlearningmodulegui");
                                }
                        }
                        
                        $this->tabs_gui->addTarget('learning_progress',
                                                                 $this->ctrl->getLinkTargetByClass(array('illearningprogressgui'),''),
                                                                 '',
                                                                 array('illplistofobjectsgui','illplistofsettingsgui','illearningprogressgui','illplistofprogressgui'));
                }

                // tracking data
                if($rbacsystem->checkAccess("read_learning_progress", $this->object->getRefId()) || $rbacsystem->checkAccess("edit_learning_progress", $this->object->getRefId()))
                {
                        if ($this->object->getSubType() == "scorm2004" || $this->object->getSubType() == "scorm") {
                                include_once('./Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
                                $privacy = ilPrivacySettings::_getInstance();
                                if($privacy->enabledSahsProtocolData())
                                {
                                        $this->tabs_gui->addTarget("cont_tracking_data",
                                                                                $this->ctrl->getLinkTarget($this, "showTrackingItems"), "showTrackingItems",
                                                                                get_class($this));
                                }
                        }
                }
                include_once("Services/License/classes/class.ilLicenseAccess.php");
                if ($rbacsystem->checkAccess('edit_permission',$this->object->getRefId())
                and ilLicenseAccess::_isEnabled())
                {
                        $this->tabs_gui->addTarget("license",
                                $this->ctrl->getLinkTargetByClass('illicensegui', ''),
                        "", "illicensegui");
                }
                
                // edit meta
                include_once "Services/Object/classes/class.ilObjectMetaDataGUI.php";
                $mdgui = new ilObjectMetaDataGUI($this->object);                                        
                $mdtab = $mdgui->getTab();
                if($mdtab)
                {
                        $this->tabs_gui->addTarget("meta_data",
                                $mdtab,
                                "", "ilmdeditorgui");
                }

                // export
                if ($rbacsystem->checkAccess("edit_permission", "", $this->object->getRefId()))
                {
                        $this->tabs_gui->addTarget("export",
                                $this->ctrl->getLinkTarget($this, "export"), array("", "export"),
                                get_class($this));
                }

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

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplate()

ilObjSAHSLearningModuleGUI::getTemplate

(

)

output main header (title and locator)

Definition at line 614 of file class.ilObjSAHSLearningModuleGUI.php.

References ilObjectGUI\$lng.

Referenced by executeCommand(), and ilObjSCORM2004LearningModuleGUI\executeCommand().

        {
                global $lng;

                $this->tpl->getStandardTemplate();
        }

Here is the caller graph for this function:

getType()

ilObjSAHSLearningModuleGUI::getType

(

)

Definition at line 884 of file class.ilObjSAHSLearningModuleGUI.php.

        {
                return "sahs";
        }

info()

ilObjSAHSLearningModuleGUI::info

(

)

permission form

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

        {
                $this->infoObject();
        }

initCreationForm()

ilObjSAHSLearningModuleGUI::initCreationForm

(

)

Init form.

Parameters

int

$a_mode

Edit Mode

Definition at line 254 of file class.ilObjSAHSLearningModuleGUI.php.

References $ilCtrl, ilObjectGUI\$lng, ilFrameTargetInfo\_getFrame(), ilTextAreaInputGUI\setCols(), ilTextInputGUI\setSize(), and ilObject\TITLE_LENGTH.

Referenced by initCreationForms().

        {
                global $lng, $ilCtrl;
        
                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                $this->form = new ilPropertyFormGUI();
        
                // title
                $ti = new ilTextInputGUI($this->lng->txt("title"), "title");
                $ti->setSize(min(40, ilObject::TITLE_LENGTH));
                $ti->setMaxLength(ilObject::TITLE_LENGTH);
                $ti->setRequired(true);
                $this->form->addItem($ti);
                
                // text area
                $ta = new ilTextAreaInputGUI($this->lng->txt("description"), "desc");
                $ta->setCols(40);
                $ta->setRows(2);
                $this->form->addItem($ta);
                
        
                $this->form->addCommandButton("save", $lng->txt("create"));
                $this->form->addCommandButton("cancel", $lng->txt("cancel"));
                        
                $this->form->setTitle($lng->txt("scorm_new"));
                $this->form->setFormAction($ilCtrl->getFormAction($this));
                $this->form->setTarget(ilFrameTargetInfo::_getFrame("MainContent"));
        }

Here is the call graph for this function:

Here is the caller graph for this function:

initCreationForms()

ilObjSAHSLearningModuleGUI::initCreationForms

(

$a_new_type

)

no manual SCORM creation, only import at the time

Definition at line 236 of file class.ilObjSAHSLearningModuleGUI.php.

References array, initCreationForm(), and initUploadForm().

        {
                $forms = array();

                $this->initUploadForm();
                $forms[self::CFORM_IMPORT] = $this->form;

                $this->initCreationForm();
                $forms[self::CFORM_NEW] = $this->form;
        
                return $forms;
        }

Here is the call graph for this function:

initUploadForm()

ilObjSAHSLearningModuleGUI::initUploadForm

(

)

Init upload form.

Definition at line 286 of file class.ilObjSAHSLearningModuleGUI.php.

References $file, $files, $ilCtrl, ilObjectGUI\$lng, $options, $si, ilFrameTargetInfo\_getFrame(), ilUploadFiles\_getUploadDirectory(), ilUploadFiles\_getUploadFiles(), ilRadioOption\addSubItem(), array, ilSelectInputGUI\setOptions(), ilFormPropertyGUI\setRequired(), ilCheckboxInputGUI\setValue(), and ilRadioGroupInputGUI\setValue().

Referenced by initCreationForms().

        {
                global $lng, $ilCtrl;
        
                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                $this->form = new ilPropertyFormGUI();
                
                // type selection
                $options = array(
                        "scorm2004" => $lng->txt("lm_type_scorm2004"),
                        "scorm" => $lng->txt("lm_type_scorm"),
                        "exportFile" => $lng->txt("sahs_export_file")
                );
                $si = new ilSelectInputGUI($this->lng->txt("type"), "sub_type");
                $si->setOptions($options);
                $this->form->addItem($si);
                
                // input file
                $fi = new ilFileInputGUI($this->lng->txt("select_file"), "scormfile");
                $fi->setRequired(true);
                $this->form->addItem($fi);
                
                // todo "uploaded file"
                // todo wysiwyg editor removement
                
                include_once 'Services/FileSystem/classes/class.ilUploadFiles.php';
                if (ilUploadFiles::_getUploadDirectory())
                {
                        $options = array();
                        $fi->setRequired(false);
                        $files = ilUploadFiles::_getUploadFiles();
                        $options[""] = $this->lng->txt("cont_select_from_upload_dir");
                        foreach($files as $file)
                        {
                                $file = htmlspecialchars($file, ENT_QUOTES, "utf-8");
                                $options[$file] = $file;
                        }
                        // 
                        $si = new ilSelectInputGUI($this->lng->txt("cont_uploaded_file"), "uploaded_file");
                        $si->setOptions($options);
                        $this->form->addItem($si);
                }

                
                // validate file
                $cb = new ilCheckboxInputGUI($this->lng->txt("cont_validate_file"), "validate");
                $cb->setValue("y");
                //$cb->setChecked(true);
                $this->form->addItem($cb);

                // import for editing
                $cb = new ilCheckboxInputGUI($this->lng->txt("sahs_authoring_mode"), "editable");
                $cb->setValue("y");
                $cb->setInfo($this->lng->txt("sahs_authoring_mode_info"));
                $this->form->addItem($cb);
                
                // 
                $radg = new ilRadioGroupInputGUI($lng->txt("sahs_sequencing"), "import_sequencing");
                $radg->setValue(0);
                        $op1 = new ilRadioOption($lng->txt("sahs_std_sequencing"), 0,$lng->txt("sahs_std_sequencing_info"));
                        $radg->addOption($op1);
                        $op1 = new ilRadioOption($lng->txt("sahs_import_sequencing"), 1,$lng->txt("sahs_import_sequencing_info"));
                        $radg->addOption($op1);
                $cb->addSubItem($radg);
                

                $this->form->addCommandButton("upload", $lng->txt("import"));
                $this->form->addCommandButton("cancel", $lng->txt("cancel"));
                        
                $this->form->setTitle($lng->txt("import_sahs"));
                $this->form->setFormAction($ilCtrl->getFormAction($this, "upload"));
                $this->form->setTarget(ilFrameTargetInfo::_getFrame("MainContent"));
        }

Here is the call graph for this function:

Here is the caller graph for this function:

owner()

ilObjSAHSLearningModuleGUI::owner

(

)

show owner of learning module

Definition at line 606 of file class.ilObjSAHSLearningModuleGUI.php.

        {
                $this->ownerObject();
        }

properties()

ilObjSAHSLearningModuleGUI::properties

(

)

module properties

Definition at line 218 of file class.ilObjSAHSLearningModuleGUI.php.

        {
        }

saveObject()

ilObjSAHSLearningModuleGUI::saveObject

(

)

save new learning module to db

Definition at line 571 of file class.ilObjSAHSLearningModuleGUI.php.

References $_GET, $_POST, ilUtil\redirect(), ilUtil\sendInfo(), and ilUtil\stripSlashes().

        {
                if (trim($_POST["title"]) == "")
                {
                        $this->ilias->raiseError($this->lng->txt("msg_no_title"),$this->ilias->error_obj->MESSAGE);
                }
                
                include_once("./Modules/Scorm2004/classes/class.ilObjSCORM2004LearningModule.php");
                $newObj = new ilObjSCORM2004LearningModule();
                $newObj->setTitle(ilUtil::stripSlashes($_POST["title"]));
                $newObj->setSubType("scorm2004");
                $newObj->setEditable(true);
                $newObj->setDescription(ilUtil::stripSlashes($_POST["desc"]));
                $newObj->create();
                $newObj->createReference();
                $newObj->putInTree($_GET["ref_id"]);
                $newObj->setPermissions($_GET["ref_id"]);               
                $newObj->createDataDirectory();
                $newObj->createScorm2004Tree();
                ilUtil::sendInfo( $this->lng->txt($newObj->getType()."_added"), true);
                ilUtil::redirect("ilias.php?baseClass=ilSAHSEditGUI&ref_id=".$newObj->getRefId());
        }

Here is the call graph for this function:

saveProperties()

ilObjSAHSLearningModuleGUI::saveProperties

(

)

save properties

Definition at line 225 of file class.ilObjSAHSLearningModuleGUI.php.

        {
        }

setSettingsSubTabs()

ilObjSAHSLearningModuleGUI::setSettingsSubTabs

(

)

set Tabs for settings

Definition at line 832 of file class.ilObjSAHSLearningModuleGUI.php.

References $ilCtrl, ilObjectGUI\$lng, array, and ilCertificate\isActive().

Referenced by executeCommand(), ilObjSCORMLearningModuleGUI\newModuleVersion(), ilObjSCORMLearningModuleGUI\properties(), and ilObjSCORM2004LearningModuleGUI\properties().

        {
                global $lng, $ilTabs, $ilCtrl;

                $ilTabs->addSubTabTarget("cont_settings",
                $this->ctrl->getLinkTarget($this, "properties"), array("edit", ""),
                get_class($this));

                $ilTabs->addSubTabTarget("cont_sc_new_version",
                $this->ctrl->getLinkTarget($this, "newModuleVersion"), array("edit", ""),
                get_class($this));
        
                include_once "Services/Certificate/classes/class.ilCertificate.php";
                if(ilCertificate::isActive())
                {       
                        // // create and insert object in objecttree
                        // $ilTabs->addSubTabTarget("certificate",
                                // $this->ctrl->getLinkTarget($this, "certificate"),
                                // array("certificate", "certificateEditor", "certificateRemoveBackground", "certificateSave",
                                        // "certificatePreview", "certificateDelete", "certificateUpload", "certificateImport")
                        // );
                        $ilTabs->addSubTabTarget(
                                "certificate",
                                $this->ctrl->getLinkTargetByClass("ilcertificategui", "certificateeditor"),
                                "", "ilcertificategui");                                        
                }

                $ilTabs->setTabActive('settings');
        }

Here is the call graph for this function:

Here is the caller graph for this function:

setTabs()

ilObjSAHSLearningModuleGUI::setTabs

(

)

output tabs

Definition at line 624 of file class.ilObjSAHSLearningModuleGUI.php.

References $_GET, ilUtil\getImagePath(), getTabs(), and object.

Referenced by executeCommand(), and ilObjSCORM2004LearningModuleGUI\executeCommand().

        {
                $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_lm.svg"));
                $this->tpl->setTitle($this->object->getTitle());
                if(strtolower($_GET["baseClass"]) == "ilsahseditgui") $this->getTabs($this->tabs_gui);
                //if(strtolower($_GET["baseClass"]) == "ilsahseditgui") $this->getTabs();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

upload()

ilObjSAHSLearningModuleGUI::upload

(

)

Definition at line 561 of file class.ilObjSAHSLearningModuleGUI.php.

References uploadObject().

        {
                $this->uploadObject();
        }

Here is the call graph for this function:

uploadObject()

ilObjSAHSLearningModuleGUI::uploadObject

(

)

display status information or report errors messages in case of error

public

Definition at line 366 of file class.ilObjSAHSLearningModuleGUI.php.

References $_GET, $_POST, $file, $title, ilUploadFiles\_checkUploadFile(), ilUploadFiles\_copyUploadFile(), ilObject\_writeTitle(), ilUtil\getWebspaceDir(), ilUtil\moveUploadedFile(), ilUtil\redirect(), ilFileUtils\rename(), ilUtil\renameExecutables(), ilUtil\sendInfo(), time, and ilUtil\unzip().

Referenced by upload().

        {
                global $_FILES, $rbacsystem;

                include_once 'Services/FileSystem/classes/class.ilUploadFiles.php';

                // check create permission
                if (!$rbacsystem->checkAccess("create", $_GET["ref_id"], "sahs"))
                {
                        $this->ilias->raiseError($this->lng->txt("no_create_permission"), $this->ilias->error_obj->WARNING);
                }
                elseif ($_FILES["scormfile"]["name"])
                {
                        // check if file was uploaded
                        $source = $_FILES["scormfile"]["tmp_name"];
                        if (($source == 'none') || (!$source))
                        {
                                $this->ilias->raiseError($this->lng->txt("msg_no_file"),$this->ilias->error_obj->MESSAGE);
                        }
                        // get_cfg_var("upload_max_filesize"); // get the may filesize form t he php.ini
                        switch ($__FILES["scormfile"]["error"])
                        {
                                case UPLOAD_ERR_INI_SIZE:
                                        $this->ilias->raiseError($this->lng->txt("err_max_file_size_exceeds"),$this->ilias->error_obj->MESSAGE);
                                        break;
        
                                case UPLOAD_ERR_FORM_SIZE:
                                        $this->ilias->raiseError($this->lng->txt("err_max_file_size_exceeds"),$this->ilias->error_obj->MESSAGE);
                                        break;
        
                                case UPLOAD_ERR_PARTIAL:
                                        $this->ilias->raiseError($this->lng->txt("err_partial_file_upload"),$this->ilias->error_obj->MESSAGE);
                                        break;
        
                                case UPLOAD_ERR_NO_FILE:
                                        $this->ilias->raiseError($this->lng->txt("err_no_file_uploaded"),$this->ilias->error_obj->MESSAGE);
                                        break;
                        }
        
                        $file = pathinfo($_FILES["scormfile"]["name"]);
                }
                elseif ($_POST["uploaded_file"])
                {
                        // check if the file is in the upload directory and readable
                        if (!ilUploadFiles::_checkUploadFile($_POST["uploaded_file"]))
                        {
                                $this->ilias->raiseError($this->lng->txt("upload_error_file_not_found"),$this->ilias->error_obj->MESSAGE);
                        }

                        $file = pathinfo($_POST["uploaded_file"]);
                }
                else
                {
                        $this->ilias->raiseError($this->lng->txt("msg_no_file"),$this->ilias->error_obj->MESSAGE);
                }

                $name = substr($file["basename"], 0, strlen($file["basename"]) - strlen($file["extension"]) - 1);
                if ($name == "")
                {
                        $name = $this->lng->txt("no_title");
                }

                $subType = $_POST["sub_type"];
                // create and insert object in objecttree
                switch ($subType)
                {
                case "scorm2004":
                        include_once("./Modules/Scorm2004/classes/class.ilObjSCORM2004LearningModule.php");
                        $newObj = new ilObjSCORM2004LearningModule();
                        $newObj->setEditable($_POST["editable"]=='y');
                        $newObj->setImportSequencing($_POST["import_sequencing"]);
                        $newObj->setSequencingExpertMode($_POST["import_sequencing"]);
                        break;

                case "scorm":
                        include_once("./Modules/ScormAicc/classes/class.ilObjSCORMLearningModule.php");
                        $newObj = new ilObjSCORMLearningModule();
                        break;

                case "exportFile":
                        $sFile = $_FILES["scormfile"];
                        $fType = $sFile["type"];
                        $cFileTypes = ["application/zip", "application/x-compressed"];

                        if (in_array ($fType, $cFileTypes))
                        {
                                $timeStamp = time();
                                $tempFile = $sFile["tmp_name"];
                                $lmDir = ilUtil::getWebspaceDir ("filesystem")."/lm_data/";
                                $lmTempDir = $lmDir . $timeStamp;
                                if (!file_exists ($lmTempDir)) mkdir ($lmTempDir, 0755, true);
                                $zar = new ZipArchive();
                                $zar->open ($tempFile);
                                $zar->extractTo ($lmTempDir);
                                $zar->close();
                                require_once "./Modules/ScormAicc/classes/class.ilScormAiccImporter.php";
                                $importer = new ilScormAiccImporter ();
                                if ($importer->importXmlRepresentation("sahs", Null, $lmTempDir, "") == true)
                                        $importFromXml = true;
                                $mprops = [];
                                $mprops = $importer->moduleProperties;
                                $fed = $mprops["Fourth_edition"][0];
                                if ($fed == "n")
                                {
                                        include_once("./Modules/ScormAicc/classes/class.ilObjSCORMLearningModule.php");
                                        $newObj = new ilObjSCORMLearningModule();
                                        $subType = "scorm";
                                }
                                else
                                {
                                        include_once("./Modules/Scorm2004/classes/class.ilObjSCORM2004LearningModule.php");
                                        $newObj = new ilObjSCORM2004LearningModule();
                                        $newObj->setEditable($_POST["editable"]=='y');
                                        $newObj->setImportSequencing($_POST["import_sequencing"]);
                                        $newObj->setSequencingExpertMode($_POST["import_sequencing"]);
                                        $subType = "scorm2004";
                                }
                        }
                        break;
                }

                $newObj->setTitle($name);
                $newObj->setSubType($_POST["sub_type"]);
                $newObj->setDescription("");
                $newObj->create(true);
                $newObj->createReference();
                $newObj->putInTree($_GET["ref_id"]);
                $newObj->setPermissions($_GET["ref_id"]);

                // create data directory, copy file to directory
                $newObj->createDataDirectory();

                if ($_FILES["scormfile"]["name"])
                {
                        if ($importFromXml)
                        {
                                $lmTempDir = $lmDir . $timeStamp;
                                $scormFile = $importer->manifest["scormFile"][0];
                                $scormFilePath = $lmTempDir . "/" . $scormFile;
                                $targetPath = $newObj->getDataDirectory()."/".$scormFile;
                                $file_path = $targetPath;
                                require_once('./Services/Utilities/classes/class.ilFileUtils.php');
                                ilFileUtils::rename ($scormFilePath, $targetPath);
                        }
                        else
                        {
                                // copy uploaded file to data directory
                                $file_path = $newObj->getDataDirectory()."/".$_FILES["scormfile"]["name"];

                                ilUtil::moveUploadedFile($_FILES["scormfile"]["tmp_name"],
                                        $_FILES["scormfile"]["name"], $file_path);
                        }
                }
                else
                {
                        // copy uploaded file to data directory
                        $file_path = $newObj->getDataDirectory()."/". $_POST["uploaded_file"];

                        ilUploadFiles::_copyUploadFile($_POST["uploaded_file"], $file_path);
                }

                ilUtil::unzip($file_path);
                ilUtil::renameExecutables($newObj->getDataDirectory());

                $title = $newObj->readObject();
                if ($title != "")
                {
                        ilObject::_writeTitle($newObj->getId(), $title);
                        /*$md = new ilMD($newObj->getId(),0, $newObj->getType());
                        if(is_object($md_gen = $md->getGeneral()))
                        {
                                $md_gen->setTitle($title);
                                $md_gen->update();
                        }*/
                }
                
                //auto set learning progress settings
                switch ($_POST["sub_type"])
                {
                        case "scorm2004":
                        case "scorm":
                        case "exportFile":
                        $newObj->setLearningProgressSettingsAtUpload();
                        break;
                }
                
                if ($importFromXml)
                {
                        $importer->writeData("sahs", "5.1.0", $newObj->getId());
                }
                
                ilUtil::sendInfo( $this->lng->txt($newObj->getType()."_added"), true);
                ilUtil::redirect("ilias.php?baseClass=ilSAHSEditGUI&ref_id=".$newObj->getRefId());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

viewObject()

ilObjSAHSLearningModuleGUI::viewObject

(

)

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

References $_GET.

        {
                if (strtolower($_GET["baseClass"]) == "iladministrationgui")
                {
                        parent::viewObject();
                }
                else
                {
                }
        }

---

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

• Modules/ScormAicc/classes/class.ilObjSAHSLearningModuleGUI.php