ilObjSAHSLearningModuleGUI Class Reference

SCORM Learning Modules. More...

Inheritance diagram for ilObjSAHSLearningModuleGUI:

Collaboration diagram for ilObjSAHSLearningModuleGUI:

Public Member Functions
	__construct ($data, int $id, bool $call_by_reference, bool $prepare_output=true)
	Constructor. More...
	executeCommand ()
	execute command More...
	properties ()
	module properties More...
	saveProperties ()
	initUploadForm ()
	uploadObject ()
	display status information or report errors messages in case of error More...
	upload ()
	getTemplate ()
	save new learning module to db More...
	certificate ()
	Shows the certificate editor. More...
	addLocatorItems ()
	setSettingsSubTabs ()
	export ()
	exportModule ()
	getType ()
Public Member Functions inherited from ilObjectGUI
	__construct ($data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true)
	getRefId ()
	setAdminMode (string $mode)
	getAdminMode ()
	getObject ()
	executeCommand ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	setCreationMode (bool $mode=true)
	if true, a creation screen is displayed the current [ref_id] don't belong to the current class! The mode is determined in ilRepositoryGUI More...
	getCreationMode ()
	prepareOutput (bool $show_sub_objects=true)
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
	cancelDeleteObject ()
	cancel deletion of object More...
	cancelObject ()
	cancel action and go back to previous page More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	addExternalEditFormCustom (ilPropertyFormGUI $form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...
	isVisible (int $ref_id, string $type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...
	setColumnSettings (ilColumnGUI $column_gui)
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen. More...
	addToDeskObject ()
	removeFromDeskObject ()
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Static Public Member Functions
static	_goto (string $a_target)
	goto target course More...
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode (int $ref_id, string $cmd="")
static	_gotoSharedWorkspaceNode (int $wsp_id)

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

Private Attributes
ilPropertyFormGUI	$form

Additional Inherited Members
Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
const	ADMIN_MODE_NONE = ""
const	ADMIN_MODE_SETTINGS = "settings"
const	ADMIN_MODE_REPOSITORY = "repository"
const	UPLOAD_TYPE_LOCAL = 1
const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3
Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service
ServerRequestInterface	$request
ilLocatorGUI	$locator
ilObjUser	$user
ilAccessHandler	$access
ilSetting	$settings
ilToolbarGUI	$toolbar
ilRbacAdmin	$rbac_admin
ilRbacSystem	$rbac_system
ilRbacReview	$rbac_review
ilObjectService	$object_service
ilObjectDefinition	$obj_definition
ilGlobalTemplateInterface	$tpl
ilTree	$tree
ilCtrl	$ctrl
ilErrorHandling	$error
ilLanguage	$lng
ilTabsGUI	$tabs_gui
ILIAS	$ilias
ArrayBasedRequestWrapper	$post_wrapper
RequestWrapper	$request_wrapper
Factory	$refinery
ilFavouritesManager	$favourites
ilObjectCustomIconFactory	$custom_icon_factory
ilObject	$object = null
bool	$creation_mode = false
	$data
int	$id
bool	$call_by_reference = false
bool	$prepare_output
int	$ref_id
int	$obj_id
int	$maxcount
array	$form_action = []
array	$return_location = []
array	$target_frame = []
string	$tmp_import_dir
string	$sub_objects = ""
bool	$omit_locator = false
string	$type = ""
string	$admin_mode = self::ADMIN_MODE_NONE
int	$requested_ref_id = 0
int	$requested_crtptrefid = 0
int	$requested_crtcb = 0
string	$requested_new_type = ""
string	$link_params
string	$html = ""

Detailed Description

SCORM Learning Modules.

Author

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

@ilCtrl_Calls ilObjSAHSLearningModuleGUI: ilFileSystemGUI, ilObjectMetaDataGUI, ilPermissionGUI, ilInfoScreenGUI, ilLearningProgressGUI @ilCtrl_Calls ilObjSAHSLearningModuleGUI: ilCommonActionDispatcherGUI, ilExportGUI, ilObjectCopyGUI

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

Constructor & Destructor Documentation

__construct()

ilObjSAHSLearningModuleGUI::__construct	(		$data,
		int	$id,
		bool	$call_by_reference,
		bool	$prepare_output = true
	)

Constructor.

Reimplemented from ilObjectGUI.

Reimplemented in ilObjSCORMLearningModuleGUI.

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

    {
        global $DIC;
        $lng = $DIC->language();
        $rbacsystem = $DIC->access();
        $lng->loadLanguageModule("content");
        $this->type = "sahs";
        parent::__construct($data, $id, $call_by_reference, false);
    }

References ilObjectGUI\$call_by_reference, ilObjectGUI\$data, $DIC, ilObjectGUI\$id, ilObjectGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), and ilLanguage\loadLanguageModule().

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilObjSAHSLearningModuleGUI::_goto ( string  $a_target )

static

goto target course

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

                                                  : void
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();
        $ilAccess = $DIC->access();
        $ilErr = $DIC['ilErr'];
        $lng = $DIC->language();
 
        $targetParameters = explode('_', $a_target);
        $id = (int) $targetParameters[0];
 
        if ($id <= 0) {
            $ilErr->raiseError($lng->txt('msg_no_perm_read'), $ilErr->FATAL);
        }
 
        if ($ilAccess->checkAccess("write", "", $id)) {
            $DIC->ctrl()->setParameterByClass("ilSAHSEditGUI", "ref_id", (string) $id);
            $DIC->ctrl()->redirectByClass("ilSAHSEditGUI", "infoScreen"); //cmd was "" in 7
        }
 
        if ($ilAccess->checkAccess("visible", "", $id) || $ilAccess->checkAccess("read", "", $id)) {
            $DIC->ctrl()->setParameterByClass("ilSAHSPresentationGUI", "ref_id", (string) $id);
            $DIC->ctrl()->redirectByClass("ilSAHSPresentationGUI", "infoScreen");
        } else {
            if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
                $main_tpl->setOnScreenMessage('info', sprintf(
                    $lng->txt("msg_no_perm_read_item"),
                    ilObject::_lookupTitle(ilObject::_lookupObjId($id))
                ), true);
                ilObjectGUI::_gotoRepositoryRoot();
            }
        }
 
        $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
    }

References $DIC, ilObjectGUI\$id, $ilErr, ilObjectGUI\$lng, ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ILIAS\Repository\int(), ROOT_FOLDER_ID, and ilLanguage\txt().

Here is the call graph for this function:

addLocatorItems()

ilObjSAHSLearningModuleGUI::addLocatorItems

(

)

Exceptions

ilCtrlException

Reimplemented from ilObjectGUI.

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

                                     : void
    {
        global $DIC;
        $ilLocator = $DIC['ilLocator'];
 
        if (is_object($this->object)) {
            $ilLocator->addItem(
                $this->object->getTitle(),
                $this->ctrl->getLinkTargetByClass("ilinfoscreengui", "showSummary"),
                "",
                $DIC->http()->wrapper()->query()->retrieve('ref_id', $DIC->refinery()->kindlyTo()->int())
            );
        }
    }

References $DIC, and ILIAS\Repository\object().

Here is the call graph for this function:

certificate()

ilObjSAHSLearningModuleGUI::certificate

(

)

Shows the certificate editor.

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

                                 : void
    {
        $guiFactory = new ilCertificateGUIFactory();
        $output_gui = $guiFactory->create($this->object);
 
        $output_gui->certificateEditor();
    }

executeCommand()

ilObjSAHSLearningModuleGUI::executeCommand

(

)

execute command

Exceptions

ilCtrlException
ilException

Reimplemented from ilObjectGUI.

Reimplemented in ilObjSCORM2004LearningModuleGUI.

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

                                    : void
    {
        global $DIC;
        $ilAccess = $DIC->access();
        $ilTabs = $DIC->tabs();
        $ilErr = $DIC['ilErr'];
        $navigationHistory = $DIC['ilNavigationHistory'];
 
        $baseClass = $refId = $DIC->http()->wrapper()->query()->retrieve('baseClass', $DIC->refinery()->kindlyTo()->string());
        $ilLog = ilLoggerFactory::getLogger('sahs');
        $ilLog->debug("bc:" . $baseClass . "; nc:" . $this->ctrl->getNextClass($this) . "; cmd:" . $this->ctrl->getCmd());
        if (strtolower($baseClass) === "iladministrationgui" ||
            strtolower($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());
            $navigationHistory->addItem(
                $this->object->getRefId(),
                ilLink::_getLink($this->object->getRefId(), $this->object->getType()),
                $this->object->getType()
            );
        }
 
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        switch ($next_class) {
            case 'illtiproviderobjectsettinggui':
                $this->setSettingsSubTabs();
                $ilTabs->setSubTabActive('lti_provider');
                $lti_gui = new ilLTIProviderObjectSettingGUI($this->object->getRefId());
                $lti_gui->setCustomRolesForSelection($GLOBALS['DIC']->rbac()->review()->getLocalRoles($this->object->getRefId()));
                $lti_gui->offerLTIRolesForSelection(false);
                $this->ctrl->forwardCommand($lti_gui);
                break;
 
 
            case 'ilobjectmetadatagui':
                if (!$ilAccess->checkAccess('write', '', $this->object->getRefId())) {
                    $ilErr->raiseError($this->lng->txt('permission_denied'), $ilErr->WARNING);
                }
                $md_gui = new ilObjectMetaDataGUI($this->object);
                $this->ctrl->forwardCommand($md_gui);
                break;
 
                //            case 'ilexportgui':
                //                $exp = new ilExportGUI($this);
                //                $exp->addFormat('xml');
                //                $this->ctrl->forwardCommand($exp);
                //                break;
 
            case 'ilpermissiongui':
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
 
            case "ilfilesystemgui":
                $fs_gui = new ilFileSystemGUI($this->object->getDataDirectory());
                $fs_gui->setUseUploadDirectory(true);
                $fs_gui->setTableId("sahsfs" . $this->object->getId());
                $this->ctrl->forwardCommand($fs_gui);
                break;
 
            case "ilcertificategui":
                $this->setSettingsSubTabs();
                $ilTabs->setSubTabActive('certificate');
 
                $guiFactory = new ilCertificateGUIFactory();
                $output_gui = $guiFactory->create($this->object);
 
                $this->ctrl->forwardCommand($output_gui);
                break;
 
            case "illearningprogressgui":
                $new_gui = new ilLearningProgressGUI(ilLearningProgressGUI::LP_CONTEXT_REPOSITORY, $this->object->getRefId());
                $this->ctrl->forwardCommand($new_gui);
 
                break;
 
            case "ilinfoscreengui":
                $ilTabs->setTabActive('info_short');
                $this->infoScreenForward();
                break;
 
            case "ilcommonactiondispatchergui":
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                if ($gui !== null) {
                    $this->ctrl->forwardCommand($gui);
                }
                break;
 
            case 'ilobjectcopygui':
                $this->prepareOutput();
                $cp = new ilObjectCopyGUI($this);
                $cp->setType('sahs');
                $this->ctrl->forwardCommand($cp);
                break;
 
            default:
                //                if ($this->object && !$this->object->getEditable()) {
                $cmd = $this->ctrl->getCmd("properties");
                //                }
                if ((strtolower($baseClass) === "iladministrationgui" ||
                    $this->getCreationMode() == true) &&
                    $cmd !== "frameset") {
                    $cmd .= "Object";
                }
 
                // #9225
                if ($cmd === "redrawHeaderAction") {
                    $cmd .= "Object";
                }
 
                $this->$cmd();
                break;
        }
    }

References $DIC, $GLOBALS, $ilErr, $refId, ilLink\_getLink(), ILIAS\Repository\ctrl(), ilObjectGUI\getCreationMode(), ilUtil\getImagePath(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), ilLoggerFactory\getLogger(), getTemplate(), infoScreenForward(), ILIAS\Repository\lng(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, ILIAS\Repository\object(), ilObjectGUI\prepareOutput(), ILIAS\Repository\rbac(), ilObjectGUI\setLocator(), setSettingsSubTabs(), and setTabs().

Here is the call graph for this function:

export()

ilObjSAHSLearningModuleGUI::export

(

)

Returns

mixed

Exceptions

ilCtrlException

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

    {
        $GLOBALS['DIC']->tabs()->setTabActive('export');
        $exp_gui = new ilExportGUI($this);
        $this->ctrl->setCmd("listExportFiles");
        $exp_gui->addFormat("xml");
        return $this->ctrl->forwardCommand($exp_gui);
    }

References $GLOBALS, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

exportModule()

ilObjSAHSLearningModuleGUI::exportModule

(

)

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

                                  : void
    {
        global $DIC;
        //        $ilDB = $DIC->database();
        //
        $moduleId = ilObject::_lookupObjectId($DIC->http()->wrapper()->query()->retrieve('ref_id', $DIC->refinery()->kindlyTo()->int()));
        $exporter = new ilScormAiccExporter();
        //        $xml = $exporter->getXmlRepresentation("sahs", "5.1.0", $moduleId);
    }

References $DIC, and ilObject\_lookupObjectId().

Here is the call graph for this function:

getTabs()

ilObjSAHSLearningModuleGUI::getTabs ( )

protected

adds tabs to tab gui object

Exceptions

ilCtrlException

Reimplemented from ilObjectGUI.

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

                                : void
    {
        global $DIC;
        $rbacsystem = $DIC->access();
        $ilCtrl = $DIC->ctrl();
        $ilHelp = $DIC->help();
 
        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
        if ($rbacsystem->checkAccess("write", "", $this->object->getRefId())) {
            $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)
        );
 
        //        if (ilLearningProgressAccess::checkAccess($this->object->getRefId())) {
        //            $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())) {
            $ar_rights = [];
            if ($rbacsystem->checkAccess("read_learning_progress", "", $this->object->getRefId())) {
                $ar_rights = ['illplistofobjectsgui'];
            }
            if ($rbacsystem->checkAccess("edit_learning_progress", "", $this->object->getRefId())) {
                $ar_rights[] = 'illplistofsettingsgui';
            }
            if (ilLearningProgressAccess::checkAccess($this->object->getRefId())) {
                $this->tabs_gui->addTarget(
                    'learning_progress',
                    $this->ctrl->getLinkTargetByClass(array('illearningprogressgui'), ''),
                    '',
                    $ar_rights
                );
            }
 
            if ($this->object->getSubType() === "scorm2004" || $this->object->getSubType() === "scorm") {
                $privacy = ilPrivacySettings::getInstance();
                if ($privacy->enabledSahsProtocolData()) {
                    $scormClass = "ilobjscormlearningmodulegui";
                    if ($this->object->getSubType() === "scorm2004") {
                        $scormClass = "ilobjscorm2004learningmodulegui";
                    }
                    $this->ctrl->setParameterByClass($scormClass, "ref_id", $this->object->getRefId());
                    $this->tabs_gui->addTarget(
                        "cont_tracking_data",
                        $this->ctrl->getLinkTargetByClass(['ilsahseditgui',$scormClass], "showTrackingItems"),
                        "showTrackingItems"
                    );
                }
            }
        }
 
        if ($rbacsystem->checkAccess("write", "", $this->object->getRefId())) {
            $mdgui = new ilObjectMetaDataGUI($this->object);
            $mdtab = $mdgui->getTab();
            if ($mdtab) {
                $this->tabs_gui->addTarget(
                    "meta_data",
                    $mdtab,
                    "",
                    "ilmdeditorgui"
                );
            }
        }
        // export - Jour Fixe Date for Decission not to allow for Users with Right Wirite?
        if ($rbacsystem->checkAccess("edit", "", $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'
            );
        }
    }

References $DIC, ilLearningProgressAccess\checkAccess(), ILIAS\Repository\ctrl(), ilPrivacySettings\getInstance(), and ILIAS\Repository\object().

Referenced by setTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplate()

ilObjSAHSLearningModuleGUI::getTemplate

(

)

save new learning module to db

output main header (title and locator)

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

                                 : void
    {
        global $DIC;
        $lng = $DIC->language();
 
        $this->tpl->loadStandardTemplate();
    }

References $DIC, and ilObjectGUI\$lng.

Referenced by executeCommand().

Here is the caller graph for this function:

getType()

ilObjSAHSLearningModuleGUI::getType

(

)

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

                             : string
    {
        return "sahs";
    }

infoScreen()

ilObjSAHSLearningModuleGUI::infoScreen ( )

protected

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

                                   : void
    {
        $this->ctrl->setCmd("showSummary");
        $this->ctrl->setCmdClass("ilinfoscreengui");
        $this->infoScreenForward();
    }

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

Here is the call graph for this function:

infoScreenForward()

ilObjSAHSLearningModuleGUI::infoScreenForward ( )

protected

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

                                          : void
    {
        if (!$this->checkPermissionBool("visible") && !$this->checkPermissionBool("read")) {
            $this->error->raiseError($this->lng->txt("msg_no_perm_read"));
        }
 
        $info = new ilInfoScreenGUI($this);
        $info->enablePrivateNotes();
        $info->enableLearningProgress();
 
        // add read / back button
        if ($this->checkPermissionBool("read")) {
            $ilToolbar = $GLOBALS['DIC']->toolbar();
            $ilToolbar->addButtonInstance($this->object->getViewButton());
        }
 
        $info->enableNewsEditing(false);
        if ($this->checkPermissionBool("write")) {
            $news_set = new ilSetting("news");
            $enable_internal_rss = $news_set->get("enable_rss_for_internal");
            if ($enable_internal_rss) {
                $info->setBlockProperty("news", "settings", "");
                $info->setBlockProperty("news", "public_notifications_option", "true");
            }
        }
        // show standard meta data section
        $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());
 
        // forward the command
        $this->ctrl->forwardCommand($info);
    }

References $GLOBALS, ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), error(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by executeCommand(), and infoScreen().

Here is the call graph for this function:

Here is the caller graph for this function:

initCreationForms()

ilObjSAHSLearningModuleGUI::initCreationForms ( string  $a_new_type )

protected

no manual SCORM creation, only import at the time

Returns

array|ilPropertyFormGUI[]

Exceptions

ilCtrlException

Reimplemented from ilObjectGUI.

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

                                                            : array
    {
        $forms = [];
 
        $this->initUploadForm();
        $forms[self::CFORM_IMPORT] = $this->form;
 
        $forms[self::CFORM_CLONE] = $this->fillCloneTemplate(null, $a_new_type);
 
        return $forms;
    }

References $form, ilObjectGUI\CFORM_CLONE, ilObjectGUI\CFORM_IMPORT, ilObjectGUI\fillCloneTemplate(), and initUploadForm().

Here is the call graph for this function:

initUploadForm()

ilObjSAHSLearningModuleGUI::initUploadForm

(

)

Exceptions

ilCtrlException

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

                                    : void
    {
        global $DIC;
        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();
        $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);
 
        $options = array();
        if (ilUploadFiles::_getUploadDirectory()) {
            $options[""] = $this->lng->txt("cont_select_from_upload_dir");
            $files = ilUploadFiles::_getUploadFiles();
            foreach ($files as $file) {
                $file = htmlspecialchars($file, ENT_QUOTES, "utf-8");
                $options[$file] = $file;
            }
        }
        if (count($options) > 1) {
            // choose upload directory
            $radg = new ilRadioGroupInputGUI($lng->txt("cont_choose_file_source"), "file_source");
            $op0 = new ilRadioOption($this->lng->txt("cont_choose_local"), "local");
            $radg->addOption($op0);
            $op1 = new ilRadioOption($this->lng->txt("cont_choose_upload_dir"), "upload_dir");
            $radg->addOption($op1);
            $radg->setValue("local");
 
            $fi = new ilFileInputGUI($this->lng->txt("select_file"), "scormfile");
            $fi->setRequired(true);
            $op0->addSubItem($fi);
 
            $si = new ilSelectInputGUI($this->lng->txt("cont_uploaded_file"), "uploaded_file");
            $si->setOptions($options);
            $op1->addSubItem($si);
 
            $this->form->addItem($radg);
        } else {
            $fi = new ilFileInputGUI($this->lng->txt("select_file"), "scormfile");
            $fi->setRequired(true);
            $this->form->addItem($fi);
        }
 
        $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"));
    }

References $DIC, ilObjectGUI\$lng, ilFrameTargetInfo\_getFrame(), ilUploadFiles\_getUploadDirectory(), ilUploadFiles\_getUploadFiles(), ILIAS\Repository\form(), ILIAS\Repository\lng(), and ilLanguage\txt().

Referenced by initCreationForms().

Here is the call graph for this function:

Here is the caller graph for this function:

properties()

ilObjSAHSLearningModuleGUI::properties

(

)

module properties

Reimplemented in ilObjSCORM2004LearningModuleGUI, and ilObjSCORMLearningModuleGUI.

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

                                : void
    {
        $this->ctrl->setParameterByClass(
            "ilSAHSEditGUI",
            "ref_id",
            $this->ref_id
        );
        $this->ctrl->redirectByClass(ilSAHSEditGUI::class);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

saveProperties()

ilObjSAHSLearningModuleGUI::saveProperties

(

)

Reimplemented in ilObjSCORM2004LearningModuleGUI, and ilObjSCORMLearningModuleGUI.

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

                                    : void
    {
    }

setSettingsSubTabs()

ilObjSAHSLearningModuleGUI::setSettingsSubTabs

(

)

Exceptions

ilCtrlException

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

                                        : void
    {
        global $DIC;
        $lng = $DIC->language();
        $ilTabs = $DIC->tabs();
        $ilCtrl = $DIC->ctrl();
 
        $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)
        );
 
        $validator = new ilCertificateActiveValidator();
        if (true === $validator->validate()) {
            // // 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([static::class, "ilcertificategui"], "certificateeditor"),
                "",
                "ilcertificategui"
            );
        }
 
        $lti_settings = new ilLTIProviderObjectSettingGUI($this->object->getRefId());
        if ($lti_settings->hasSettingsAccess()) {
            $ilTabs->addSubTabTarget(
                'lti_provider',
                $this->ctrl->getLinkTargetByClass(ilLTIProviderObjectSettingGUI::class)
            );
        }
 
        $ilTabs->setTabActive('settings');
    }

References $DIC, ilObjectGUI\$lng, ILIAS\Repository\ctrl(), and ILIAS\Repository\object().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setTabs()

ilObjSAHSLearningModuleGUI::setTabs ( )

protected

Exceptions

ilCtrlException

Reimplemented from ilObjectGUI.

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

                                : void
    {
        global $DIC;
        $baseClass = $refId = $DIC->http()->wrapper()->query()->retrieve('baseClass', $DIC->refinery()->kindlyTo()->string());
        $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_lm.svg"));
        $this->tpl->setTitle($this->object->getTitle());
        $this->tpl->setDescription($this->object->getDescription());
        if ($this->object && $this->object->getOfflineStatus()) {
            $this->tpl->setAlertProperties(array(
                array("alert" => true,
                      "property" => $this->lng->txt("status"),
                      "value" => $this->lng->txt("offline"))
            ));
        }
        if (strtolower($baseClass) === "ilsahseditgui" || strtolower($baseClass) === "ilrepositorygui") {
            $this->getTabs();
        }
    }

References $DIC, $refId, ilUtil\getImagePath(), getTabs(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

upload()

ilObjSAHSLearningModuleGUI::upload

(

)

Exceptions

ilDatabaseException
ilException
ilFileUtilsException
ilObjectNotFoundException

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

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

References uploadObject().

Here is the call graph for this function:

uploadObject()

ilObjSAHSLearningModuleGUI::uploadObject

(

)

display status information or report errors messages in case of error

Exceptions

ilDatabaseException
ilException
ilFileUtilsException
ilObjectNotFoundException

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

                                  : void
    {
        global $DIC;
        $rbacsystem = $DIC->access();
        $ilErr = $DIC['ilErr'];
        $ilLog = ilLoggerFactory::getLogger('sahs');
        $refId = $DIC->http()->wrapper()->query()->retrieve('ref_id', $DIC->refinery()->kindlyTo()->int());
        $importFromXml = false;
 
        // check create permission
        if (!$rbacsystem->checkAccess("create", '', $refId, "sahs")) {
            $ilErr->raiseError($this->lng->txt("no_create_permission"), $ilErr->WARNING);
        } elseif ($_FILES["scormfile"]["name"]) {
            // check if file was uploaded
            $source = $_FILES["scormfile"]["tmp_name"];
            if (($source === 'none') || (!$source)) {
                $ilErr->raiseError($this->lng->txt("msg_no_file"), $ilErr->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:
                case UPLOAD_ERR_FORM_SIZE:
                    $ilErr->raiseError($this->lng->txt("err_max_file_size_exceeds"), $ilErr->MESSAGE);
                    break;
 
                case UPLOAD_ERR_PARTIAL:
                    $ilErr->raiseError($this->lng->txt("err_partial_file_upload"), $ilErr->MESSAGE);
                    break;
 
                case UPLOAD_ERR_NO_FILE:
                    $ilErr->raiseError($this->lng->txt("err_no_file_uploaded"), $ilErr->MESSAGE);
                    break;
            }
 
            $file = pathinfo($_FILES["scormfile"]["name"]);
        } elseif ($DIC->http()->wrapper()->post()->has('uploaded_file')) {
            $uploadedFile = $DIC->http()->wrapper()->post()->retrieve('uploaded_file', $DIC->refinery()->kindlyTo()->string());
            // check if the file is in the upload directory and readable
            if (!ilUploadFiles::_checkUploadFile($uploadedFile)) {
                $ilErr->raiseError($this->lng->txt("upload_error_file_not_found"), $ilErr->MESSAGE);
            }
 
            $file = pathinfo($uploadedFile);
        } else {
            $ilErr->raiseError($this->lng->txt("msg_no_file"), $ilErr->MESSAGE);
        }
 
        $name = substr($file["basename"], 0, strlen($file["basename"]) - strlen($file["extension"]) - 1);
        if ($name == "") {
            $name = $this->lng->txt("no_title");
        }
 
        $description = "";
 
        $subType = "scorm2004";
        if ($DIC->http()->wrapper()->post()->has('sub_type')) {
            $subType = $DIC->http()->wrapper()->post()->retrieve('sub_type', $DIC->refinery()->kindlyTo()->string());
        }
 
        // always import authoring packages as scorm2004, see bug #27801
        //        if ($_POST["editable"] == 'y') {
        //            $subType = "scorm2004";
        //        }
 
        // create and insert object in objecttree
        switch ($subType) {
            case "scorm2004":
                $newObj = new ilObjSCORM2004LearningModule();
                break;
 
            case "scorm":
                $newObj = new ilObjSCORMLearningModule();
                break;
 
            case "exportFile":
                $sFile = $_FILES["scormfile"];
                $fType = $sFile["type"];
                $cFileTypes = ["application/zip", "application/x-compressed","application/x-zip-compressed"];
                if (in_array($fType, $cFileTypes)) {
                    $tempFile = $sFile["tmp_name"];
                    $lmTempDir = ilFileUtils::ilTempnam();
                    ilFileUtils::makeDir($lmTempDir);
                    $zar = new ZipArchive();
                    $zar->open($tempFile);
                    $zar->extractTo($lmTempDir);
                    $zar->close();
                    ilFileUtils::renameExecutables($lmTempDir);
                    $importer = new ilScormAiccImporter();
                    $import_dirname = $lmTempDir . '/' . substr($_FILES["scormfile"]["name"], 0, -4);
                    $importer->importXmlRepresentation("sahs", "", $import_dirname, null);
                    $import_result = $importer->getResult();
 
                    $importFromXml = true;
                    if ($import_result->isOK()) {
                        $properties = $import_result->value();
                        if (($subType = $properties['SubType']) === 'scorm') {
                            $newObj = new ilObjSCORMLearningModule();
                        } else {
                            $newObj = new ilObjSCORM2004LearningModule();
                        }
                        $name = $properties['Title'];
                        $description = $properties['Description'];
                    } else {
                        ilFileUtils::delDir($lmTempDir, false);
                        $ilLog->error('SCORM import of ILIAS exportfile not possible because parsing error');
                        $ilLog->error($import_result->error());
                        $this->tpl->setOnScreenMessage('failure', $this->lng->txt("import_file_not_valid"), true);
                        return;
                    }
                }
                break;
        }
 
        $newObj->setTitle($name);
        $newObj->setSubType($subType);
        $newObj->setDescription($description);
        $newObj->setOfflineStatus(false);
        $newObj->create(true);
        $newObj->createReference();
        $newObj->putInTree($refId);
        $newObj->setPermissions($refId);
 
        // create data directory, copy file to directory
        $newObj->createDataDirectory();
 
        if ($_FILES["scormfile"]["name"]) {
            if ($importFromXml) {
                $scormFile = "content.zip";
                $scormFilePath = $import_dirname . "/" . $scormFile;
                $file_path = $newObj->getDataDirectory() . "/" . $scormFile;
                ilFileUtils::rename($scormFilePath, $file_path);
                ilFileUtils::unzip($file_path);
                unlink($file_path);
                ilFileUtils::delDir($lmTempDir, false);
            } else {
                // copy uploaded file to data directory
                $file_path = $newObj->getDataDirectory() . "/" . $_FILES["scormfile"]["name"];
                ilFileUtils::moveUploadedFile(
                    $_FILES["scormfile"]["tmp_name"],
                    $_FILES["scormfile"]["name"],
                    $file_path
                );
                ilFileUtils::unzip($file_path);
            }
        } else {
            // copy uploaded file to data directory
            $uploadedFile = $DIC->http()->wrapper()->post()->retrieve('uploaded_file', $DIC->refinery()->kindlyTo()->string());
            $file_path = $newObj->getDataDirectory() . "/" . $uploadedFile;
            ilUploadFiles::_copyUploadFile($uploadedFile, $file_path);
            ilFileUtils::unzip($file_path);
        }
        ilFileUtils::renameExecutables($newObj->getDataDirectory());
 
        $title = $newObj->readObject();
        if ($title != "") {
            ilObject::_writeTitle($newObj->getId(), $title);
        }
 
        //auto set learning progress settings
        $newObj->setLearningProgressSettingsAtUpload();
 
        if ($importFromXml) {
            $importer->writeData("sahs", "5.1.0", $newObj->getId());
        }
 
        $this->tpl->setOnScreenMessage('info', $this->lng->txt($newObj->getType() . "_added"), true);
        ilUtil::redirect("ilias.php?baseClass=ilSAHSEditGUI&ref_id=" . $newObj->getRefId());
    }

References $DIC, $ilErr, $name, $refId, $source, $uploadedFile, ilUploadFiles\_checkUploadFile(), ilUploadFiles\_copyUploadFile(), ilObject\_writeTitle(), ilFileUtils\delDir(), ilLoggerFactory\getLogger(), ilFileUtils\ilTempnam(), ILIAS\Repository\lng(), ilFileUtils\makeDir(), ilFileUtils\moveUploadedFile(), ilUtil\redirect(), ilFileUtils\rename(), ilFileUtils\renameExecutables(), and ilFileUtils\unzip().

Referenced by upload().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$form

ilPropertyFormGUI ilObjSAHSLearningModuleGUI::$form

private

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

Referenced by initCreationForms().

---

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

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