ilObjFileBasedLMGUI Class Reference

User Interface class for file based learning modules (HTML) More...

Inheritance diagram for ilObjFileBasedLMGUI:

Collaboration diagram for ilObjFileBasedLMGUI:

Public Member Functions
	__construct ( $a_data, int $a_id=0, bool $a_call_by_reference=true, bool $a_prepare_output=true)
	executeCommand ()
	cancelCreationObject ()
	properties ()
	initSettingsForm ()
	getSettingsFormValues ()
	toFilesystem ()
	saveProperties ()
	editObject ()
	edit ()
	cancel ()
	update ()
	setStartFile (string $a_file)
	getTemplate ()
	showLearningModule ()
	infoScreen ()
	this one is called from the info button in the repository More...
	showInfoScreen ()
	createFromDirectory (string $a_dir)
	exportHTML ()
	redirectAfterCreation ()
	learningProgress ()
	redrawHeaderAction ()
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)
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)

Data Fields
bool	$output_prepared
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 Member Functions
	initCreationForms (string $new_type)
	afterSave (ilObject $new_object)
	setTabs ()
	getTabs ()
	addLocatorItems ()
	importFileObject (int $parent_id=null)
	afterImport (ilObject $new_object)
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 ()
	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...

Protected Attributes
StandardGUIRequest	$lm_request
ilPropertyFormGUI	$form
ilTabsGUI	$tabs
ilHelpGUI	$help
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

User Interface class for file based learning modules (HTML)

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de ilObjFileBasedLMGUI: ilFileSystemGUI, ilObjectMetaDataGUI, ilPermissionGUI, ilLearningProgressGUI, ilInfoScreenGUI ilObjFileBasedLMGUI: ilCommonActionDispatcherGUI ilObjFileBasedLMGUI: ilExportGUI

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

Constructor & Destructor Documentation

__construct()

ilObjFileBasedLMGUI::__construct	(		$a_data,
		int	$a_id = 0,
		bool	$a_call_by_reference = true,
		bool	$a_prepare_output = true
	)

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

References $DIC, ilObjectGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), ILIAS\Repository\locator(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

      {
        global $DIC;

        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->locator = $DIC["ilLocator"];
        $this->tabs = $DIC->tabs();
        $this->tree = $DIC->repositoryTree();
        $this->tpl = $DIC["tpl"];
        $this->access = $DIC->access();
        $this->toolbar = $DIC->toolbar();
        $this->help = $DIC["ilHelp"];
        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();

        $this->ctrl = $ilCtrl;
        $this->ctrl->saveParameter($this, array("ref_id"));

        $this->lm_request = $DIC->htmlLearningModule()
            ->internal()
            ->gui()
            ->standardRequest();

        $this->type = "htlm";
        $lng->loadLanguageModule("content");
        $lng->loadLanguageModule("obj");

        parent::__construct($a_data, $a_id, $a_call_by_reference, false);
        $this->output_prepared = $a_prepare_output;
    }

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilObjFileBasedLMGUI::_goto ( string  $a_target )

static

Definition at line 607 of file class.ilObjFileBasedLMGUI.php.

References $DIC, ilObjectGUI\$lng, ilObjectGUI\_gotoRepositoryNode(), ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ROOT_FOLDER_ID, and ilLanguage\txt().

                                                  : void
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();

        $lng = $DIC->language();
        $ilAccess = $DIC->access();

        if ($ilAccess->checkAccess("read", "", $a_target) ||
            $ilAccess->checkAccess("visible", "", $a_target)) {
            ilObjectGUI::_gotoRepositoryNode($a_target, "infoScreen");
        } elseif ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
            $main_tpl->setOnScreenMessage('failure', sprintf(
                $lng->txt("msg_no_perm_read_item"),
                ilObject::_lookupTitle(ilObject::_lookupObjId($a_target))
            ), true);
            ilObjectGUI::_gotoRepositoryRoot();
        }

        throw new ilPermissionException($lng->txt("msg_no_perm_read_lm"));
    }

Here is the call graph for this function:

addLocatorItems()

ilObjFileBasedLMGUI::addLocatorItems ( )

protected

Definition at line 629 of file class.ilObjFileBasedLMGUI.php.

References ilObjectGUI\$locator, ilObjectGUI\$requested_ref_id, ilLocatorGUI\addItem(), ILIAS\Repository\ctrl(), and ILIAS\Repository\object().

                                        : void
    {
        $ilLocator = $this->locator;

        if (is_object($this->object)) {
            $ilLocator->addItem(
                $this->object->getTitle(),
                $this->ctrl->getLinkTargetByClass("ilinfoscreengui", "showSummary"),
                "",
                $this->requested_ref_id
            );
        }
    }

Here is the call graph for this function:

afterImport()

ilObjFileBasedLMGUI::afterImport ( ilObject  $new_object )

protected

Definition at line 653 of file class.ilObjFileBasedLMGUI.php.

References ILIAS\Repository\ctrl(), ilObject\getRefId(), and ILIAS\Repository\lng().

                                                        : void
    {
        $this->ctrl->setParameter($this, "ref_id", $new_object->getRefId());
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("object_added"), true);
        $this->ctrl->redirect($this, "properties");
    }

Here is the call graph for this function:

afterSave()

ilObjFileBasedLMGUI::afterSave ( ilObject  $new_object )

protected

Definition at line 385 of file class.ilObjFileBasedLMGUI.php.

References $valid, ilObject\getTitle(), ILIAS\Repository\lng(), ilFileUtils\recursive_dirscan(), redirectAfterCreation(), and ilObject\update().

Referenced by createFromDirectory().

                                                      : void
    {
        if (!$new_object->getStartFile()) {
            // try to set start file automatically
            $files = array();
            ilFileUtils::recursive_dirscan($new_object->getDataDirectory(), $files);
            if (isset($files["file"])) {
                $zip_file = null;
                if (stripos($new_object->getTitle(), ".zip") !== false) {
                    $zip_file = strtolower($new_object->getTitle());
                    $suffix = strrpos($zip_file, ".");
                    if ($suffix) {
                        $zip_file = substr($zip_file, 0, $suffix);
                    }
                }
                $valid = array("index.htm", "index.html", "start.htm", "start.html");
                foreach ($files["file"] as $idx => $file) {
                    $chk_file = null;
                    if (stripos($file, ".htm") !== false) {
                        $chk_file = strtolower($file);
                        $suffix = strrpos($chk_file, ".");
                        if ($suffix) {
                            $chk_file = substr($chk_file, 0, $suffix);
                        }
                    }
                    if (in_array($file, $valid) ||
                        ($chk_file && $zip_file && $chk_file == $zip_file)) {
                        $new_object->setStartFile(str_replace($new_object->getDataDirectory() . "/", "", $files["path"][$idx]) . $file);
                        $new_object->update();
                        break;
                    }
                }
            }
        }

        // always send a message
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("object_added"), true);
        $this->object = $new_object;
        $this->redirectAfterCreation();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cancel()

ilObjFileBasedLMGUI::cancel

(

)

Definition at line 380 of file class.ilObjFileBasedLMGUI.php.

References ilObjectGUI\cancelObject().

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

Here is the call graph for this function:

cancelCreationObject()

ilObjFileBasedLMGUI::cancelCreationObject ( )

final

Definition at line 222 of file class.ilObjFileBasedLMGUI.php.

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

                                                : void
    {
        $ilCtrl = $this->ctrl;

        $ilCtrl->redirectByClass("ilrepositorygui", "frameset");
    }

Here is the call graph for this function:

createFromDirectory()

ilObjFileBasedLMGUI::createFromDirectory

(

string

$a_dir

)

Definition at line 660 of file class.ilObjFileBasedLMGUI.php.

References $filename, afterSave(), ilObjectGUI\checkPermissionBool(), ILIAS\Repository\lng(), ilObjectGUI\putObjectInTree(), and ilUtil\stripSlashes().

Referenced by importFileObject().

                                                      : void
    {
        if ($a_dir === "" || !$this->checkPermissionBool("create", "", "htlm")) {
            throw new ilPermissionException($this->lng->txt("no_create_permission"));
        }

        // create instance
        $newObj = new ilObjFileBasedLM();
        $filename = ilUtil::stripSlashes($_FILES["importfile"]["name"]);
        $newObj->setTitle($filename);
        $newObj->setDescription("");
        $newObj->create();
        $newObj->populateByDirectoy($a_dir, $filename);
        $this->putObjectInTree($newObj);

        $this->afterSave($newObj);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

edit()

ilObjFileBasedLMGUI::edit

(

)

Definition at line 374 of file class.ilObjFileBasedLMGUI.php.

References editObject(), and ilObjectGUI\prepareOutput().

                          : void
    {
        $this->prepareOutput();
        $this->editObject();
    }

Here is the call graph for this function:

editObject()

ilObjFileBasedLMGUI::editObject

(

)

Definition at line 367 of file class.ilObjFileBasedLMGUI.php.

References ILIAS\Repository\lng().

Referenced by edit().

                                : void
    {
        if (!$this->rbac_system->checkAccess("visible,write", $this->object->getRefId())) {
            throw new ilPermissionException($this->lng->txt("permission_denied"));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilObjFileBasedLMGUI::executeCommand

(

)

Definition at line 72 of file class.ilObjFileBasedLMGUI.php.

References $ilUser, $tabs, ilObjectGUI\$user, ilFileSystemGUI\activateLabels(), ilObjectGUI\addHeaderAction(), ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), ilObjectGUI\getCreationMode(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), getTemplate(), ILIAS\Repository\lng(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, ILIAS\Repository\object(), ilObjectGUI\prepareOutput(), ilObjectGUI\setLocator(), setTabs(), and showInfoScreen().

                                    : void
    {
        $ilUser = $this->user;
        $ilTabs = $this->tabs;

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

        if (
            $this->getCreationMode() === true ||
            strtolower($this->lm_request->getBaseClass()) === "iladministrationgui"
        ) {
            $this->prepareOutput();
        } elseif (!in_array($cmd, array("", "framset")) || $next_class != "") {
            $this->getTemplate();
            $this->setLocator();
            $this->setTabs();
        }

        switch ($next_class) {
            case 'ilobjectmetadatagui':
                $this->checkPermission("write");
                $ilTabs->activateTab('id_meta_data');
                $md_gui = new ilObjectMetaDataGUI($this->object);
                $this->ctrl->forwardCommand($md_gui);
                break;

            case "ilfilesystemgui":
                $this->checkPermission("write");
                $ilTabs->activateTab('id_list_files');
                $fs_gui = new ilFileSystemGUI($this->object->getDataDirectory());
                $fs_gui->activateLabels(true, $this->lng->txt("cont_purpose"));
                $fs_gui->setUseUploadDirectory(true);
                $fs_gui->setTableId("htlmfs" . $this->object->getId());
                if ($this->object->getStartFile() !== "") {
                    $fs_gui->labelFile(
                        (string) $this->object->getStartFile(),
                        $this->lng->txt("cont_startfile")
                    );
                }
                $fs_gui->addCommand($this, "setStartFile", $this->lng->txt("cont_set_start_file"));

                $this->ctrl->forwardCommand($fs_gui);

                // try to set start file automatically
                /* this does not work anymore, see #33348
                if (!ilObjFileBasedLMAccess::_determineStartUrl($this->object->getId())) {
                    $do_update = false;

                    $pcommand = $fs_gui->getLastPerformedCommand();
                    $last_cmd = $pcommand["cmd"] ?? "";
                    $valid = array("index.htm", "index.html", "start.htm", "start.html");
                    if ($last_cmd === "create_file") {
                        $file = strtolower(basename($pcommand["name"]));
                        if (in_array($file, $valid)) {
                            $this->object->setStartFile($pcommand["name"]);
                            $do_update = $pcommand["name"];
                        }
                    } elseif ($last_cmd === "unzip_file") {
                        $zip_file = strtolower(basename($pcommand["name"]));
                        $suffix = strrpos($zip_file, ".");
                        if ($suffix) {
                            $zip_file = substr($zip_file, 0, $suffix);
                        }
                        foreach ($pcommand["added"] as $file) {
                            $chk_file = null;
                            if (stripos($file, ".htm") !== false) {
                                $chk_file = strtolower(basename($file));
                                $suffix = strrpos($chk_file, ".");
                                if ($suffix) {
                                    $chk_file = substr($chk_file, 0, $suffix);
                                }
                            }
                            if (in_array(basename($file), $valid) ||
                                ($zip_file && $chk_file && $chk_file == $zip_file)) {
                                $this->object->setStartFile($file);
                                $do_update = $file;
                                break;
                            }
                        }
                    }

                    if ($do_update) {
                        $this->tpl->setOnScreenMessage('info', sprintf($this->lng->txt("cont_start_file_set_to"), $do_update), true);

                        $this->object->update();
                        $this->ctrl->redirectByClass("ilfilesystemgui", "listFiles");
                    }
                }*/
                break;

            case "ilinfoscreengui":
                $this->showInfoScreen();
                break;

            case "illearningprogressgui":
                $ilTabs->activateTab('id_learning_progress');
                $user_id = ($this->lm_request->getUserId() > 0)
                    ? $this->lm_request->getUserId()
                    : $ilUser->getId();
                $new_gui = new ilLearningProgressGUI(
                    ilLearningProgressBaseGUI::LP_CONTEXT_REPOSITORY,
                    $this->object->getRefId(),
                    $user_id
                );
                $this->ctrl->forwardCommand($new_gui);
                break;

            case 'ilpermissiongui':
                $ilTabs->activateTab('id_permissions');
                $perm_gui = new ilPermissionGUI($this);
                $ret = $this->ctrl->forwardCommand($perm_gui);
                break;

            case "ilexportgui":
                $ilTabs->activateTab("export");
                $exp_gui = new ilExportGUI($this);
                $exp_gui->addFormat("xml");
                $exp_gui->addFormat("html", "", $this, "exportHTML");
                $ret = $this->ctrl->forwardCommand($exp_gui);
                break;

            case "ilcommonactiondispatchergui":
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;

            default:
                $cmd = $this->ctrl->getCmd("listFiles");
                if (
                    $this->getCreationMode() === true ||
                    strtolower($this->lm_request->getBaseClass()) === "iladministrationgui"
                ) {
                    $cmd .= "Object";
                }
                $ret = $this->$cmd();
                break;
        }

        $this->addHeaderAction();
    }

Here is the call graph for this function:

exportHTML()

ilObjFileBasedLMGUI::exportHTML

(

)

Definition at line 683 of file class.ilObjFileBasedLMGUI.php.

References ilExport\_createExportDirectory(), ilExport\_getExportDirectory(), ilFileUtils\delDir(), IL_INST_ID, ilFileUtils\makeDir(), ILIAS\Repository\object(), ilFileUtils\rCopy(), and ilFileUtils\zip().

                                : void
    {
        ilExport::_createExportDirectory(
            $this->object->getId(),
            "html",
            $this->object->getType()
        );
        $export_dir = ilExport::_getExportDirectory(
            $this->object->getId(),
            "html",
            $this->object->getType()
        );

        $subdir = $this->object->getType() . "_" . $this->object->getId();

        $target_dir = $export_dir . "/" . $subdir;

        ilFileUtils::delDir($target_dir);
        ilFileUtils::makeDir($target_dir);

        $source_dir = $this->object->getDataDirectory();

        ilFileUtils::rCopy($source_dir, $target_dir);

        // zip it all
        $date = time();
        $zip_file = $export_dir . "/" . $date . "__" . IL_INST_ID . "__" .
            $this->object->getType() . "_" . $this->object->getId() . ".zip";
        ilFileUtils::zip($target_dir, $zip_file);

        ilFileUtils::delDir($target_dir);
    }

Here is the call graph for this function:

getSettingsFormValues()

ilObjFileBasedLMGUI::getSettingsFormValues

(

)

Definition at line 306 of file class.ilObjFileBasedLMGUI.php.

References ilObjFileBasedLMAccess\_determineStartUrl(), ILIAS\Repository\form(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by properties().

                                           : void
    {
        $startfile = ilObjFileBasedLMAccess::_determineStartUrl($this->object->getId());

        $values = array();
        $values['cobj_online'] = !$this->object->getOfflineStatus();
        if ($startfile !== "") {
            $startfile = basename($startfile);
        } else {
            $startfile = $this->lng->txt("no_start_file");
        }

        $values["startfile"] = $startfile;
        $values["title"] = $this->object->getTitle();
        $values["desc"] = $this->object->getLongDescription();
        $values["cont_show_info_tab"] = $this->object->isInfoEnabled();

        $this->form->setValuesByArray($values);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTabs()

ilObjFileBasedLMGUI::getTabs ( )

protected

Definition at line 525 of file class.ilObjFileBasedLMGUI.php.

References ilObjectGUI\$access, $help, ilObjectGUI\$lng, $tabs, ilObjFileBasedLMAccess\_determineStartUrl(), ilLearningProgressAccess\checkAccess(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilHelpGUI\setScreenIdComponent(), and ilLanguage\txt().

Referenced by setTabs().

                                : void
    {
        $ilAccess = $this->access;
        $ilTabs = $this->tabs;
        $lng = $this->lng;
        $ilHelp = $this->help;

        $ilHelp->setScreenIdComponent("htlm");

        if ($ilAccess->checkAccess('write', '', $this->ref_id)) {
            $ilTabs->addTab(
                "id_list_files",
                $lng->txt("cont_list_files"),
                $this->ctrl->getLinkTargetByClass("ilfilesystemgui", "listFiles")
            );
        }

        if ($ilAccess->checkAccess('visible', '', $this->ref_id) && $this->object->isInfoEnabled()) {
            $ilTabs->addTab(
                "id_info",
                $lng->txt("info_short"),
                $this->ctrl->getLinkTargetByClass(array("ilobjfilebasedlmgui", "ilinfoscreengui"), "showSummary")
            );
        }

        if ($ilAccess->checkAccess('write', '', $this->ref_id)) {
            $ilTabs->addTab(
                "id_settings",
                $lng->txt("settings"),
                $this->ctrl->getLinkTarget($this, "properties")
            );
        }

        if (ilLearningProgressAccess::checkAccess($this->object->getRefId())) {
            $ilTabs->addTab(
                "id_learning_progress",
                $lng->txt("learning_progress"),
                $this->ctrl->getLinkTargetByClass(array('ilobjfilebasedlmgui','illearningprogressgui'), '')
            );
        }

        if ($ilAccess->checkAccess('write', '', $this->ref_id)) {
            $mdgui = new ilObjectMetaDataGUI($this->object);
            $mdtab = $mdgui->getTab();
            if ($mdtab) {
                $ilTabs->addTab(
                    "id_meta_data",
                    $lng->txt("meta_data"),
                    $mdtab
                );
            }
        }


        // export
        if ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
            $ilTabs->addTab(
                "export",
                $lng->txt("export"),
                $this->ctrl->getLinkTargetByClass("ilexportgui", "")
            );
        }

        if ($ilAccess->checkAccess('edit_permission', '', $this->object->getRefId())) {
            $ilTabs->addTab(
                "id_permissions",
                $lng->txt("perm_settings"),
                $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm")
            );
        }

        $startfile = ilObjFileBasedLMAccess::_determineStartUrl($this->object->getId());
        if ($startfile !== "" && $ilAccess->checkAccess('read', '', $this->ref_id)) {
            $ilTabs->addNonTabbedLink(
                "presentation_view",
                $this->lng->txt("glo_presentation_view"),
                "ilias.php?baseClass=ilHTLMPresentationGUI&ref_id=" . $this->object->getRefId(),
                "_blank"
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplate()

ilObjFileBasedLMGUI::getTemplate

(

)

Definition at line 438 of file class.ilObjFileBasedLMGUI.php.

Referenced by executeCommand().

                                 : void
    {
        $this->tpl->loadStandardTemplate();
    }

Here is the caller graph for this function:

importFileObject()

ilObjFileBasedLMGUI::importFileObject ( int  $parent_id = null )

protected

Definition at line 643 of file class.ilObjFileBasedLMGUI.php.

References Vendor\Package\$e, createFromDirectory(), and ilManifestFileNotFoundImportException\getTmpDir().

                                                              : void
    {
        try {
            parent::importFileObject();
        } catch (ilManifestFileNotFoundImportException $e) {
            // since there is no manifest xml we assume that this is an HTML export file
            $this->createFromDirectory($e->getTmpDir());
        }
    }

Here is the call graph for this function:

infoScreen()

ilObjFileBasedLMGUI::infoScreen

(

)

this one is called from the info button in the repository

Definition at line 469 of file class.ilObjFileBasedLMGUI.php.

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

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

Here is the call graph for this function:

initCreationForms()

ilObjFileBasedLMGUI::initCreationForms ( string  $new_type )

protected

Definition at line 214 of file class.ilObjFileBasedLMGUI.php.

References ilObjectGUI\initCreateForm(), and ilObjectGUI\initImportForm().

                                                          : array
    {
        return [
            self::CFORM_NEW => $this->initCreateForm($new_type),
            self::CFORM_IMPORT => $this->initImportForm($new_type)
        ];
    }

Here is the call graph for this function:

initSettingsForm()

ilObjFileBasedLMGUI::initSettingsForm

(

)

Definition at line 241 of file class.ilObjFileBasedLMGUI.php.

References ilObjectGUI\$ctrl, $form, ilObjectGUI\$lng, ilObjFileBasedLMAccess\_determineStartUrl(), ILIAS\Repository\form(), ilObjectGUI\getObjectService(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, ilObjectServiceSettingsGUI\initServiceSettingsForm(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilTextAreaInputGUI\setCols(), ilCheckboxInputGUI\setOptionTitle(), ilNonEditableValueGUI\setValue(), ilObject\TITLE_LENGTH, and ilLanguage\txt().

Referenced by properties(), and saveProperties().

                                      : void
    {
        $obj_service = $this->getObjectService();
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

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

        // description
        $ta = new ilTextAreaInputGUI($this->lng->txt("description"), "desc");
        $ta->setCols(40);
        $ta->setRows(2);
        $this->form->addItem($ta);

        // online
        $cb = new ilCheckboxInputGUI($lng->txt("cont_online"), "cobj_online");
        $cb->setOptionTitle($lng->txt(""));
        $cb->setValue("y");
        $this->form->addItem($cb);

        // startfile
        $startfile = ilObjFileBasedLMAccess::_determineStartUrl($this->object->getId());

        $ne = new ilNonEditableValueGUI($lng->txt("cont_startfile"), "");
        if ($startfile !== "") {
            $ne->setValue(basename($startfile));
        } else {
            $ne->setValue(basename($this->lng->txt("no_start_file")));
        }
        $this->form->addItem($ne);

        $pres = new ilFormSectionHeaderGUI();
        $pres->setTitle($this->lng->txt('obj_presentation'));
        $this->form->addItem($pres);

        // tile image
        $obj_service->commonSettings()->legacyForm($this->form, $this->object)->addTileImage();

        $this->form->addCommandButton("saveProperties", $lng->txt("save"));
        $this->form->addCommandButton("toFilesystem", $lng->txt("cont_set_start_file"));

        $this->form->setTitle($lng->txt("cont_lm_properties"));
        $this->form->setFormAction($ilCtrl->getFormAction($this, "saveProperties"));

        // additional features
        $section = new ilFormSectionHeaderGUI();
        $section->setTitle($this->lng->txt('obj_features'));
        $this->form->addItem($section);

        ilObjectServiceSettingsGUI::initServiceSettingsForm(
            $this->object->getId(),
            $this->form,
            [
                ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY
            ]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

learningProgress()

ilObjFileBasedLMGUI::learningProgress

(

)

Definition at line 724 of file class.ilObjFileBasedLMGUI.php.

References ILIAS\Repository\ctrl().

                                      : void
    {
        $this->ctrl->redirectByClass("illearningprogressgui", "");
    }

Here is the call graph for this function:

properties()

ilObjFileBasedLMGUI::properties

(

)

Definition at line 229 of file class.ilObjFileBasedLMGUI.php.

References $tabs, ilObjectGUI\$tpl, ilTabsGUI\activateTab(), ILIAS\Repository\form(), getSettingsFormValues(), initSettingsForm(), and ilGlobalTemplateInterface\setContent().

                                : void
    {
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;

        $ilTabs->activateTab("id_settings");

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

Here is the call graph for this function:

redirectAfterCreation()

ilObjFileBasedLMGUI::redirectAfterCreation

(

)

Definition at line 716 of file class.ilObjFileBasedLMGUI.php.

References ilObjectGUI\$ctrl, ILIAS\Repository\object(), ilCtrl\redirectByClass(), and ilCtrl\setParameterByClass().

Referenced by afterSave().

                                           : void
    {
        $ctrl = $this->ctrl;
        $ctrl->setParameterByClass("ilObjFileBasedLMGUI", "ref_id", $this->object->getRefId());
        $ctrl->redirectByClass(["ilrepositorygui", "ilObjFileBasedLMGUI"], "properties");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

redrawHeaderAction()

ilObjFileBasedLMGUI::redrawHeaderAction

(

)

Definition at line 729 of file class.ilObjFileBasedLMGUI.php.

References ilObjectGUI\redrawHeaderActionObject().

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

Here is the call graph for this function:

saveProperties()

ilObjFileBasedLMGUI::saveProperties

(

)

Definition at line 332 of file class.ilObjFileBasedLMGUI.php.

References $form, $tabs, ilObjectGUI\$tpl, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilObjectGUI\getObjectService(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, initSettingsForm(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilGlobalTemplateInterface\setContent(), and ilObjectServiceSettingsGUI\updateServiceSettingsForm().

                                    : void
    {
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        $obj_service = $this->getObjectService();

        $this->initSettingsForm();
        if ($this->form->checkInput()) {
            $this->object->setTitle($this->form->getInput("title"));
            $this->object->setDescription($this->form->getInput("desc"));
            $this->object->setOfflineStatus(!(bool) $this->form->getInput("cobj_online"));

            $this->object->update();

            // tile image
            $obj_service->commonSettings()->legacyForm($this->form, $this->object)->saveTileImage();

            // services
            ilObjectServiceSettingsGUI::updateServiceSettingsForm(
                $this->object->getId(),
                $this->form,
                array(
                    ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY
                )
            );

            $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
            $this->ctrl->redirect($this, "properties");
        }

        $ilTabs->activateTab("id_settings");
        $this->form->setValuesByPost();
        $tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

setStartFile()

ilObjFileBasedLMGUI::setStartFile

(

string

$a_file

)

Definition at line 431 of file class.ilObjFileBasedLMGUI.php.

References ILIAS\Repository\ctrl().

                                                : void
    {
        $this->object->setStartFile($a_file);
        $this->object->update();
        $this->ctrl->redirectByClass("ilfilesystemgui", "listFiles");
    }

Here is the call graph for this function:

setTabs()

ilObjFileBasedLMGUI::setTabs ( )

protected

Definition at line 519 of file class.ilObjFileBasedLMGUI.php.

References getTabs(), and ilObjectGUI\setTitleAndDescription().

Referenced by executeCommand().

                                : void
    {
        $this->getTabs();
        $this->setTitleAndDescription();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showInfoScreen()

ilObjFileBasedLMGUI::showInfoScreen

(

)

Definition at line 476 of file class.ilObjFileBasedLMGUI.php.

References ilObjectGUI\$access, $tabs, ilObjectGUI\$toolbar, ilTabsGUI\activateTab(), ILIAS\Repository\ctrl(), ilLinkButton\getInstance(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by executeCommand(), and infoScreen().

                                    : void
    {
        $ilToolbar = $this->toolbar;
        $ilAccess = $this->access;
        $ilTabs = $this->tabs;

        $ilTabs->activateTab('id_info');

        $this->lng->loadLanguageModule("meta");

        $info = new ilInfoScreenGUI($this);
        $info->enablePrivateNotes();
        $info->enableLearningProgress();

        $info->enableNews();
        if ($ilAccess->checkAccess("write", "", $this->requested_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);
            }
        }

        // add read / back button
        if ($ilAccess->checkAccess("read", "", $this->requested_ref_id)) {
            // #15127
            $button = ilLinkButton::getInstance();
            $button->setCaption("view");
            $button->setPrimary(true);
            $button->setUrl("ilias.php?baseClass=ilHTLMPresentationGUI&ref_id=" . $this->object->getRefId());
            $button->setTarget("ilContObj" . $this->object->getId());
            $ilToolbar->addButtonInstance($button);
        }

        // 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:

showLearningModule()

ilObjFileBasedLMGUI::showLearningModule

(

)

Definition at line 443 of file class.ilObjFileBasedLMGUI.php.

References $ilUser, ilObjectGUI\$user, ilObjFileBasedLMAccess\_determineStartUrl(), ilLearningProgress\_tracProgress(), ilLPStatusWrapper\_updateStatus(), ANONYMOUS_USER_ID, ILIAS\Repository\object(), ilUtil\redirect(), and ilWACSignedPath\signFolderOfStartFile().

                                        : void
    {
        $ilUser = $this->user;

        // #9483
        if ($ilUser->getId() !== ANONYMOUS_USER_ID) {
            ilLearningProgress::_tracProgress(
                $ilUser->getId(),
                $this->object->getId(),
                $this->object->getRefId(),
                "htlm"
            );

            ilLPStatusWrapper::_updateStatus($this->object->getId(), $ilUser->getId());
        }

        $startfile = ilObjFileBasedLMAccess::_determineStartUrl($this->object->getId());
        ilWACSignedPath::signFolderOfStartFile($startfile);
        if ($startfile !== "") {
            ilUtil::redirect($startfile);
        }
    }

Here is the call graph for this function:

toFilesystem()

ilObjFileBasedLMGUI::toFilesystem

(

)

Definition at line 326 of file class.ilObjFileBasedLMGUI.php.

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

                                  : void
    {
        $ilCtrl = $this->ctrl;
        $ilCtrl->redirectByClass("ilfilesystemgui", "listFiles");
    }

Here is the call graph for this function:

update()

ilObjFileBasedLMGUI::update

(

)

Definition at line 426 of file class.ilObjFileBasedLMGUI.php.

References ilObjectGUI\updateObject().

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

Here is the call graph for this function:

Field Documentation

$form

ilPropertyFormGUI ilObjFileBasedLMGUI::$form

protected

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

Referenced by initSettingsForm(), and saveProperties().

$help

ilHelpGUI ilObjFileBasedLMGUI::$help

protected

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

Referenced by getTabs().

$lm_request

StandardGUIRequest ilObjFileBasedLMGUI::$lm_request

protected

Definition at line 30 of file class.ilObjFileBasedLMGUI.php.

$output_prepared

bool ilObjFileBasedLMGUI::$output_prepared

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

$tabs

ilTabsGUI ilObjFileBasedLMGUI::$tabs

protected

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

Referenced by executeCommand(), getTabs(), properties(), saveProperties(), and showInfoScreen().

---

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

• Modules/HTMLLearningModule/classes/class.ilObjFileBasedLMGUI.php