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 ()
	uploadObject ()
	display status information or report errors messages in case of error More...
	upload ()
	getTemplate ()
	output main header (title and locator) More...
	certificate ()
	Shows the certificate editor. More...
	addLocatorItems ()
	setSettingsSubTabs ()
	List files. More...
	export ()
	exportModule ()
	getType ()
Public Member Functions inherited from ilObjectGUI
	getRefId ()
	setAdminMode (string $mode)
	getAdminMode ()
	getObject ()
	executeCommand ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...
	getCreationMode ()
	prepareOutput (bool $show_sub_objects=true)
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
	cancelObject ()
	cancel action and go back to previous page More...
	createObject ()
	create new object form More...
	editAvailabilityPeriodObject ()
	saveAvailabilityPeriodObject ()
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	addExternalEditFormCustom (ilPropertyFormGUI $form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...
	isVisible (int $ref_id, string $type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...
	setColumnSettings (ilColumnGUI $column_gui)
	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 ()
	initCreateForm (string $new_type)
	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)
	setTabs ()
	getTabs ()
	adds tabs to tab gui object More...
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	assignObject ()
	setTitleAndDescription ()
	createActionDispatcherGUI ()
	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...
	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	setTabs ()
	set admin tabs More...
	setAdminTabs ()
	set admin tabs More...
	setLocator ()
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator (bool $omit=true)
	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	getCreationFormsHTML (StandardForm|ilPropertyFormGUI|array $form)
	getTitleForCreationFormPage ()
	getCreationFormTitle ()
	initCreateForm (string $new_type)
	didacticTemplatesToForm ()
	initDidacticTemplate (ilPropertyFormGUI $form)
	retrieveAdditionalDidacticTemplateOptions ()
	addAdoptContentLinkToToolbar ()
	addImportButtonToToolbar ()
	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)
	parseDidacticTemplateVar (string $var, string $type)
	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...
	routeImportCmdObject ()
	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)
	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)
	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...
	setFormAction (string $cmd, string $form_action)
	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...
	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...
	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...
	getTabs ()
	overwrite in derived GUI class of your object type More...
	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	getCreatableObjectTypes ()
	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)
	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Private Attributes
ilPropertyFormGUI	$form
	$archives

Additional Inherited Members
Data Fields inherited from ilObjectGUI
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
const	SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]
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
Refinery	$refinery
ilFavouritesManager	$favourites
ilObjectCustomIconFactory	$custom_icon_factory
UIFactory	$ui_factory
UIRenderer	$ui_renderer
Filesystem	$temp_file_system
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$

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

\

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

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

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

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

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 719 of file class.ilObjSAHSLearningModuleGUI.php.

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

Referenced by ILIAS\StaticURL\Handler\LegacyGotoHandler\handle().

                                                  : 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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addLocatorItems()

ilObjSAHSLearningModuleGUI::addLocatorItems

(

)

Exceptions

ilCtrlException

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

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

                                     : 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())
            );
        }
    }

Here is the call graph for this function:

certificate()

ilObjSAHSLearningModuleGUI::certificate

(

)

Shows the certificate editor.

Definition at line 572 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

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

References $DIC, $GLOBALS, $ilErr, $refId, 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(), ilLTIProviderObjectSettingGUI\setCustomRolesForSelection(), ilObjectGUI\setLocator(), setSettingsSubTabs(), setTabs(), and ilFileSystemGUI\setUseUploadDirectory().

                                    : 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("standard/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;
        }
    }

Here is the call graph for this function:

export()

ilObjSAHSLearningModuleGUI::export

(

)

Exceptions

ilCtrlException

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

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

                            : mixed
    {
        $GLOBALS['DIC']->tabs()->setTabActive('export');
        $exp_gui = new ilExportGUI($this);
        // @todo: removed deprecated ilCtrl methods, this needs inspection by a maintainer.
        // $this->ctrl->setCmd("listExportFiles");
        $exp_gui->addFormat("xml");
        return $this->ctrl->forwardCommand($exp_gui);
    }

Here is the call graph for this function:

exportModule()

ilObjSAHSLearningModuleGUI::exportModule

(

)

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

References $DIC, and ilObject\_lookupObjectId().

                                  : 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);
    }

Here is the call graph for this function:

getTabs()

ilObjSAHSLearningModuleGUI::getTabs ( )

protected

adds tabs to tab gui object

Exceptions

ilCtrlException

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

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

Referenced by setTabs().

                                : 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'
            );
        }
    }

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 539 of file class.ilObjSAHSLearningModuleGUI.php.

References $DIC, and ilObjectGUI\$lng.

Referenced by executeCommand().

                                 : void
    {
        global $DIC;
        $lng = $DIC->language();

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

Here is the caller graph for this function:

getType()

ilObjSAHSLearningModuleGUI::getType

(

)

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

                             : string
    {
        return "sahs";
    }

importFile()

ilObjSAHSLearningModuleGUI::importFile ( string  $file_to_import, string  $path_to_uploaded_file_in_temp_dir  )

protected

ILIAS $DIC

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

References $DIC, ILIAS\Repository\ctrl(), ilFileUtils\delDir(), ilObjectGUI\deleteUploadedImportFile(), ilFileUtils\ilTempnam(), ILIAS\Repository\lng(), ilFileUtils\makeDir(), ilObjectGUI\putObjectInTree(), ilFileUtils\rename(), and ilFileUtils\renameExecutables().

                                                                                                    : void
    {
        global $DIC;
        $ilLog = $DIC['log'];

        $lm_temp_dir = ilFileUtils::ilTempnam();
        ilFileUtils::makeDir($lm_temp_dir);
        $zar = new ZipArchive();
        $zar->open($file_to_import);
        $zar->extractTo($lm_temp_dir);
        $zar->close();
        ilFileUtils::renameExecutables($lm_temp_dir);
        $importer = new ilScormAiccImporter();
        $import_dirname = $lm_temp_dir . '/' . substr(basename($file_to_import), 0, -4);
        $importer->importXmlRepresentation("sahs", "", $import_dirname, null);
        $import_result = $importer->getResult();

        if ($import_result->isOK()) {
            $properties = $import_result->value();
            if (($subType = $properties['SubType']) === 'scorm') {
                $new_obj = new ilObjSCORMLearningModule();
            } else {
                $new_obj = new ilObjSCORM2004LearningModule();
            }
            $name = $properties['Title'];
            $description = $properties['Description'];
        } else {
            ilFileUtils::delDir($lm_temp_dir, false);
            $this->deleteUploadedImportFile($path_to_uploaded_file_in_temp_dir);
            $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_here"), true);
            return;
        }

        $new_obj->setTitle($name);
        $new_obj->setSubType($subType);
        $new_obj->setDescription($description);
        $new_obj->create(true);
        $this->putObjectInTree($new_obj);
        $new_obj->setOfflineStatus(false);

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

        $scorm_file = "content.zip";
        $scorm_file_path = $import_dirname . "/" . $scorm_file;
        $file_path = $new_obj->getDataDirectory() . "/" . $scorm_file;
        ilFileUtils::rename($scorm_file_path, $file_path);
        $this->archives->unzip(
            $file_path,
            $new_obj->getDataDirectory(),
            false,
            false,
            false
        );
        unlink($file_path);
        ilFileUtils::delDir($lm_temp_dir, false);
        ilFileUtils::renameExecutables($new_obj->getDataDirectory());

        //auto set learning progress settings
        $new_obj->setLearningProgressSettingsAtUpload();

        $importer->writeData("sahs", "5.1.0", $new_obj->getId());

        $this->tpl->setOnScreenMessage('info', $this->lng->txt($new_obj->getType() . "_added"), true);
        $this->ctrl->setParameterByClass(self::class, 'ref_id', $new_obj->getRefId());
        $this->ctrl->redirectByClass(self::class);
    }

Here is the call graph for this function:

infoScreen()

ilObjSAHSLearningModuleGUI::infoScreen ( )

protected

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

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

                                   : void
    {
        if (strtolower($this->ctrl->getCmd() ?? '') === 'infoscreen') {
            $this->ctrl->redirectByClass(ilInfoScreenGUI::class, 'showSummary');
        }

        $this->infoScreenForward();
    }

Here is the call graph for this function:

infoScreenForward()

ilObjSAHSLearningModuleGUI::infoScreenForward ( )

protected

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

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

Referenced by executeCommand(), and infoScreen().

                                          : void
    {
        if (!$this->checkPermissionBool("visible") && !$this->checkPermissionBool("read")) {
            $this->error->raiseError($this->lng->txt("msg_no_perm_read"), $this->error->MESSAGE);
        }

        $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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initCreateForm()

ilObjSAHSLearningModuleGUI::initCreateForm ( string  $new_type )

protected

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

References $DIC, $form, ilObjectGUI\$lng, ilFrameTargetInfo\_getFrame(), ilUploadFiles\_getUploadDirectory(), ilUploadFiles\_getUploadFiles(), ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ilSubEnabledFormPropertyGUI\addSubItem(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), ilFormPropertyGUI\setInfo(), ilSelectInputGUI\setOptions(), ilFormPropertyGUI\setRequired(), ilFormGUI\setTarget(), ilPropertyFormGUI\setTitle(), ilRadioOption\setValue(), and ilLanguage\txt().

                                                       : ilPropertyFormGUI
    {
        global $DIC;
        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();
        $form = new ilPropertyFormGUI();

        // type selection
        $radg = new ilRadioGroupInputGUI($lng->txt("type"), "sub_type");
        $op0 = new ilRadioOption($this->lng->txt("lm_type_scorm"), "scorm");
        $op0->setInfo($this->lng->txt("lm_type_scorm_info"));
        $radg->addOption($op0);
        $op0 = new ilRadioOption($this->lng->txt("lm_type_scorm2004"), "scorm2004");
        $op0->setInfo($this->lng->txt("lm_type_scorm2004_info"));
        $radg->addOption($op0);
        $radg->setValue("scorm");
        $form->addItem($radg);

        $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);

            $form->addItem($radg);
        } else {
            $fi = new ilFileInputGUI($this->lng->txt("select_file"), "scormfile");
            $fi->setRequired(true);
            $form->addItem($fi);
        }

        $form->addCommandButton("upload", $lng->txt("create"));
        $form->addCommandButton("cancel", $lng->txt("cancel"));

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

Here is the call graph for this function:

properties()

ilObjSAHSLearningModuleGUI::properties

(

)

module properties

Returns

void

Exceptions

ilObjectException

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

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

saveProperties()

ilObjSAHSLearningModuleGUI::saveProperties

(

)

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

                                    : void
    {
    }

setSettingsSubTabs()

ilObjSAHSLearningModuleGUI::setSettingsSubTabs

(

)

List files.

Parameters

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

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

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

                                        : void
    {
        global $DIC;
        $lng = $DIC->language();
        $ilTabs = $DIC->tabs();
        $ilCtrl = $DIC->ctrl();

        $ilTabs->addSubTabTarget(
            "general",
            $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');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTabs()

ilObjSAHSLearningModuleGUI::setTabs ( )

protected

Exceptions

ilCtrlException

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

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

Referenced by executeCommand().

                                : void
    {
        global $DIC;
        $baseClass = $refId = $DIC->http()->wrapper()->query()->retrieve('baseClass', $DIC->refinery()->kindlyTo()->string());
        $this->tpl->setTitleIcon(ilUtil::getImagePath("standard/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();
        }
    }

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 459 of file class.ilObjSAHSLearningModuleGUI.php.

References uploadObject().

                            : void
    {
        $this->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 320 of file class.ilObjSAHSLearningModuleGUI.php.

References $DIC, $ilErr, $refId, ilUploadFiles\_checkUploadFile(), ilUploadFiles\_copyUploadFile(), ilObject\_writeTitle(), ilLoggerFactory\getLogger(), ILIAS\Repository\lng(), ilFileUtils\moveUploadedFile(), ilUtil\redirect(), and ilFileUtils\renameExecutables().

Referenced by upload().

                                  : 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;
        }

        $newObj->setTitle($name);
        $newObj->setSubType($subType);
        $newObj->setDescription($description);
        $newObj->create(true);
        $newObj->createReference();
        $newObj->putInTree($refId);
        $newObj->setPermissions($refId);
        $newObj->setOfflineStatus(false);

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

        if ($_FILES["scormfile"]["name"]) {
            // copy uploaded file to data directory
            $file_path = $newObj->getDataDirectory() . "/" . $_FILES["scormfile"]["name"];
            ilFileUtils::moveUploadedFile(
                $_FILES["scormfile"]["tmp_name"],
                $_FILES["scormfile"]["name"],
                $file_path
            );
            $this->archives->unzip(
                $file_path,
                $newObj->getDataDirectory(),
                false,
                false,
                false
            );
        } 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);
            $this->archives->unzip(
                $file_path,
                $newObj->getDataDirectory(),
                false,
                false,
                true
            );
        }
        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());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$archives

ilObjSAHSLearningModuleGUI::$archives

private

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

$form

ilPropertyFormGUI ilObjSAHSLearningModuleGUI::$form

private

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

Referenced by initCreateForm().

---

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

• components/ILIAS/ScormAicc/classes/class.ilObjSAHSLearningModuleGUI.php