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 ()
	infoScreen ()
	this one is called from the info button in the repository More...
	showInfoScreen ()
	createFromDirectory (string $a_dir)
	exportHTML ()
	redirectAfterCreation ()
	learningProgress ()
	redrawHeaderAction ()
	importFromUploadDir ()
	getUploadDirectory ()
	getUploadFiles ()
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)
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
const	CMD_LIST_FILES = "listFiles"
const	CMD_IMPORT_FROM_UPLOAD_DIR = 'importFromUploadDir'
bool	$output_prepared
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 Member Functions
	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...
	setTabs ()
	set admin tabs More...
	getTabs ()
	@abstract overwrite in derived GUI class of your object type More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	importFileObject (?int $parent_id=null)
	afterImport (ilObject $new_object)
	Post (successful) object import hook. 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 ()
	@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...
	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)

Protected Attributes
ILIAS HTMLLearningModule InternalGUIService	$gui
StandardGUIRequest	$lm_request
ilPropertyFormGUI	$form
ilTabsGUI	$tabs
ilHelpGUI	$help
Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service
GlobalHttpState	$http
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
CustomIconFactory	$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 = ""

Private Member Functions
	listFiles ()

Private Attributes
const	PARAM_PATH = "path"
ILIAS ResourceStorage Services	$irss

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 @ilCtrl_Calls ilObjFileBasedLMGUI: ilObjectMetaDataGUI, ilPermissionGUI, ilLearningProgressGUI, ilInfoScreenGUI @ilCtrl_Calls ilObjFileBasedLMGUI: ilCommonActionDispatcherGUI @ilCtrl_Calls ilObjFileBasedLMGUI: ilExportGUI @ilCtrl_Calls ilObjFileBasedLMGUI: ilContainerResourceGUI

Definition at line 35 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 48 of file class.ilObjFileBasedLMGUI.php.

      {
        global $DIC;
 
        $this->irss = $DIC->resourceStorage();
        $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");
        $lng->loadLanguageModule("htlm");
 
        parent::__construct($a_data, $a_id, $a_call_by_reference, false);
        $this->output_prepared = $a_prepare_output;
        $this->gui = $DIC->htmlLearningModule()->internal()->gui();
    }

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().

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilObjFileBasedLMGUI::_goto ( string  $a_target )

static

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

                                                  : void
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();
 
        $lng = $DIC->language();
        $access = $DIC->access();
 
        if ($access->checkAccess("read", "", $a_target) ||
            $access->checkAccess("visible", "", $a_target)) {
            ilObjectGUI::_gotoRepositoryNode($a_target, "infoScreen");
        } elseif ($access->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"));
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

addLocatorItems()

ilObjFileBasedLMGUI::addLocatorItems ( )

protected

should be overwritten to add object specific items (repository items are preloaded)

Reimplemented from ilObjectGUI.

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

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

References ilObjectGUI\$locator, and ILIAS\Repository\object().

Here is the call graph for this function:

afterImport()

ilObjFileBasedLMGUI::afterImport ( ilObject  $new_object )

protected

Post (successful) object import hook.

Reimplemented from ilObjectGUI.

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

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

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

Here is the call graph for this function:

afterSave()

ilObjFileBasedLMGUI::afterSave ( ilObject  $new_object )

protected

Post (successful) object creation hook.

Reimplemented from ilObjectGUI.

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

                                                      : void
    {
        if (!$new_object->getStartFile()) {
            $new_object->maybeDetermineStartFile();
        }
 
        // always send a message
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("object_added"), true);
        $this->object = $new_object;
        $this->redirectAfterCreation();
    }

References ILIAS\Repository\lng(), and redirectAfterCreation().

Referenced by createFromDirectory().

Here is the call graph for this function:

Here is the caller graph for this function:

cancel()

ilObjFileBasedLMGUI::cancel

(

)

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

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

References ilObjectGUI\cancelObject().

Here is the call graph for this function:

cancelCreationObject()

ilObjFileBasedLMGUI::cancelCreationObject ( )

final

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

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

createFromDirectory()

ilObjFileBasedLMGUI::createFromDirectory

(

string

$a_dir

)

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

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

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

Referenced by importFileObject().

Here is the call graph for this function:

Here is the caller graph for this function:

edit()

ilObjFileBasedLMGUI::edit

(

)

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

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

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

Here is the call graph for this function:

editObject()

ilObjFileBasedLMGUI::editObject

(

)

Reimplemented from ilObjectGUI.

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

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

References ILIAS\Repository\lng().

Referenced by edit().

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilObjFileBasedLMGUI::executeCommand

(

)

Reimplemented from ilObjectGUI.

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

                                    : void
    {
        $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->tpl->loadStandardTemplate();
            $this->setLocator();
            $this->setTabs();
        }
 
        switch ($next_class) {
            case strtolower(ilContainerResourceGUI::class):
                $this->tabs->activateTab('id_list_files');
                // Check wite access to determine upload and manage capabilities
                $check_access = $this->access->checkAccess('write', '', $this->object->getRefId());
 
                // Build the view configuration
                $view_configuration = (new HTMLModuleViewConfig(
                    $this->object->getResource(),
                    $this->lng->txt('files'),
                    $check_access,
                    $this->object->getStartFile(),
                    $this->lng->txt('start_file'),
                ))->getConfiguration();
 
                // Add a single action for text-files to set as startfile
                $view_configuration = $view_configuration->withExternalAction(
                    $this->lng->txt('cont_set_start_file'),
                    self::class,
                    'setStartFile',
                    'lm',
                    self::PARAM_PATH,
                    false,
                    ['text/*']
                );
 
                if ($this->getUploadDirectory()) {
                    foreach ($this->getUploadFiles() as $file) {
                        $options[$file] = $file;
                    }
 
                    $modal = $this->ui_factory->modal()->roundtrip(
                        $this->lng->txt('import_from_upload_dir'),
                        [],
                        [
                            $this->ui_factory->input()->field()->select(
                                $this->lng->txt('import_from_upload_dir_file_name'),
                                $options,
                                $this->lng->txt('import_from_upload_dir_info'),
                            )->withRequired(true)
                        ],
                        $this->ctrl->getFormActionByClass(
                            \ilObjFileBasedLMGUI::class,
                            \ilObjFileBasedLMGUI::CMD_IMPORT_FROM_UPLOAD_DIR
                        )
                    );
 
                    $top_action = new TopAction(
                        $this->lng->txt('import_from_upload_dir'),
                        $modal->getShowSignal()
                    );
                    $view_configuration = $view_configuration->withExternalTopAction(
                        'import_from_upload_dir',
                        $top_action,
                        $modal
                    );
                }
                // build the collection GUI
                $container_gui = new ilContainerResourceGUI(
                    $view_configuration
                );
 
                // forward the command
                $this->ctrl->forwardCommand($container_gui);
                break;
            case 'ilobjectmetadatagui':
                $this->checkPermission("write");
                $this->tabs->activateTab('id_meta_data');
                $md_gui = new ilObjectMetaDataGUI($this->object);
                $this->ctrl->forwardCommand($md_gui);
                break;
 
            case "ilinfoscreengui":
                $this->showInfoScreen();
                break;
 
            case "illearningprogressgui":
                $this->tabs->activateTab('id_learning_progress');
                $user_id = ($this->lm_request->getUserId() > 0)
                    ? $this->lm_request->getUserId()
                    : $this->user->getId();
                $new_gui = new ilLearningProgressGUI(
                    ilLearningProgressBaseGUI::LP_CONTEXT_REPOSITORY,
                    $this->object->getRefId(),
                    $user_id
                );
                $this->ctrl->forwardCommand($new_gui);
                break;
 
            case 'ilpermissiongui':
                $this->tabs->activateTab('id_permissions');
                $perm_gui = new ilPermissionGUI($this);
                $ret = $this->ctrl->forwardCommand($perm_gui);
                break;
 
            case "ilexportgui":
                $this->tabs->activateTab("export");
                $exp_gui = new ilExportGUI($this);
                $ret = $this->ctrl->forwardCommand($exp_gui);
                break;
 
            case "ilcommonactiondispatchergui":
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;
 
            default:
                $cmd = $this->ctrl->getCmd(self::CMD_LIST_FILES);
                if (
                    $this->getCreationMode() === true ||
                    strtolower($this->lm_request->getBaseClass()) === "iladministrationgui"
                ) {
                    $cmd .= "Object";
                }
                $ret = $this->$cmd();
                break;
        }
 
        $this->addHeaderAction();
    }

References $gui, ILIAS\UI\Implementation\Component\Input\Field\$options, $user_id, ILIAS\Repository\access(), ilObjectGUI\addHeaderAction(), ilObjectGUI\checkPermission(), CMD_IMPORT_FROM_UPLOAD_DIR, ILIAS\Repository\ctrl(), ilObjectGUI\getCreationMode(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), getUploadDirectory(), getUploadFiles(), ILIAS\Repository\lng(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, ILIAS\Repository\object(), PARAM_PATH, ilObjectGUI\prepareOutput(), ilObjectGUI\setLocator(), setTabs(), showInfoScreen(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

Here is the call graph for this function:

exportHTML()

ilObjFileBasedLMGUI::exportHTML

(

)

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

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

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

Here is the call graph for this function:

getSettingsFormValues()

ilObjFileBasedLMGUI::getSettingsFormValues

(

)

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

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

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

Referenced by properties().

Here is the call graph for this function:

Here is the caller graph for this function:

getTabs()

ilObjFileBasedLMGUI::getTabs ( )

protected

@abstract overwrite in derived GUI class of your object type

Reimplemented from ilObjectGUI.

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

                                : void
    {
        $lng = $this->lng;
        $ilHelp = $this->help;
 
        $ilHelp->setScreenIdComponent("htlm");
 
        if ($this->access->checkAccess('write', '', $this->ref_id)) {
            // Depending on whether the module has already been migrated to the IRSS, we add a tab to
            // ilContainerResourceGUI or internally. internally, it is only indicated that the files cannot be edited.
            $this->tabs->addTab(
                "id_list_files",
                $lng->txt("cont_list_files"),
                $this->ctrl->getLinkTarget($this, self::CMD_LIST_FILES)
            );
        }
 
        if ($this->access->checkAccess('visible', '', $this->ref_id) && $this->object->isInfoEnabled()) {
            $this->tabs->addTab(
                "id_info",
                $lng->txt("info_short"),
                $this->ctrl->getLinkTargetByClass([self::class, ilInfoScreenGUI::class], "showSummary")
            );
        }
 
        if ($this->access->checkAccess('write', '', $this->ref_id)) {
            $this->tabs->addTab(
                "id_settings",
                $lng->txt("settings"),
                $this->ctrl->getLinkTarget($this, "properties")
            );
        }
 
        if (ilLearningProgressAccess::checkAccess($this->object->getRefId())) {
            $this->tabs->addTab(
                "id_learning_progress",
                $lng->txt("learning_progress"),
                $this->ctrl->getLinkTargetByClass([self::class, ilLearningProgressGUI::class], '')
            );
        }
 
        if ($this->access->checkAccess('write', '', $this->ref_id)) {
            $mdgui = new ilObjectMetaDataGUI($this->object);
            $mdtab = $mdgui->getTab();
            if ($mdtab) {
                $this->tabs->addTab(
                    "id_meta_data",
                    $lng->txt("meta_data"),
                    $mdtab
                );
            }
        }
 
        // export
        if ($this->access->checkAccess("write", "", $this->object->getRefId())) {
            $this->tabs->addTab(
                "export",
                $lng->txt("export"),
                $this->ctrl->getLinkTargetByClass(ilExportGUI::class, "")
            );
        }
 
        if ($this->access->checkAccess('edit_permission', '', $this->object->getRefId())) {
            $this->tabs->addTab(
                "id_permissions",
                $lng->txt("perm_settings"),
                $this->ctrl->getLinkTargetByClass([self::class, ilPermissionGUI::class], "perm")
            );
        }
 
        $startfile = ilObjFileBasedLMAccess::_determineStartUrl($this->object->getId());
        if ($startfile !== "" && $this->access->checkAccess('read', '', $this->ref_id)) {
            $this->tabs->addNonTabbedLink(
                "presentation_view",
                $this->lng->txt("glo_presentation_view"),
                "ilias.php?baseClass=ilHTLMPresentationGUI&ref_id=" . $this->object->getRefId(),
                "_blank"
            );
        }
    }

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

Referenced by setTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

getUploadDirectory()

ilObjFileBasedLMGUI::getUploadDirectory

(

)

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

                                        : string
    {
        $lm_set = new ilSetting("lm");
        $upload_dir = $lm_set->get("cont_upload_dir");
 
        $import_file_factory = new ilImportDirectoryFactory();
        try {
            $import_directory = $import_file_factory->getInstanceForComponent(ilImportDirectoryFactory::TYPE_SAHS);
        } catch (InvalidArgumentException $e) {
            return '';
        }
        return $import_directory->getAbsolutePath();
    }

References Vendor\Package\$e, $lm_set, and ilImportDirectoryFactory\TYPE_SAHS.

Referenced by executeCommand(), getUploadFiles(), and importFromUploadDir().

Here is the caller graph for this function:

getUploadFiles()

ilObjFileBasedLMGUI::getUploadFiles

(

)

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

                                    : array
    {
        if (!$upload_dir = $this->getUploadDirectory()) {
            return array();
        }
 
        // get the sorted content of the upload directory
        $handle = opendir($upload_dir);
        $files = array();
        while (false !== ($file = readdir($handle))) {
            $full_path = $upload_dir . "/" . $file;
            if (is_file($full_path) and is_readable($full_path)) {
                $files[] = $file;
            }
        }
        closedir($handle);
        sort($files);
 
        return $files;
    }

References getUploadDirectory(), and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

importFileObject()

ilObjFileBasedLMGUI::importFileObject ( ?int  $parent_id = null )

protected

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

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

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

Here is the call graph for this function:

importFromUploadDir()

ilObjFileBasedLMGUI::importFromUploadDir

(

)

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

                                         : void
    {
        global $DIC;
        if (!$this->checkPermissionBool("write", "", "htlm")) {
            $main_tpl = $DIC->ui()->mainTemplate();
 
            $main_tpl->setOnScreenMessage(
                'failure',
                sprintf(
                    $this->lng->txt("msg_no_perm_write"),
                ),
                true
            );
            ilObjectGUI::_gotoRepositoryRoot();
        }
 
        $file = $this->lm_request->getString('form/input_0');
        $path = $this->getUploadDirectory() . DIRECTORY_SEPARATOR . $file;
        if ($file === '') {
            $DIC->ui()->mainTemplate()->setOnScreenMessage(
                'failure',
                $this->lng->txt('import_from_upload_dir_info'),
                true
            );
        } elseif (str_starts_with(realpath($path), $this->getUploadDirectory())) {
            $this->irss->manageContainer()->addStreamToContainer(
                $this->object->getResource()->getIdentification(),
                Streams::ofResource(fopen($path, 'rb')),
                $file
            );
            $DIC->ui()->mainTemplate()->setOnScreenMessage(
                'success',
                $this->lng->txt('file_imported_from_upload_dir'),
                true
            );
        } else {
            $DIC->ui()->mainTemplate()->setOnScreenMessage(
                'failure',
                $this->lng->txt('file_import_from_upload_dir_failed'),
                true
            );
        }
 
        $this->ctrl->setParameterByClass("ilObjFileBasedLMGUI", "ref_id", $this->object->getRefId());
        $this->ctrl->redirectByClass(["ilrepositorygui", "ilObjFileBasedLMGUI", "ilContainerResourceGUI"]);
    }

References $DIC, $path, ilObjectGUI\_gotoRepositoryRoot(), ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), getUploadDirectory(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

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 479 of file class.ilObjFileBasedLMGUI.php.

                                : void
    {
        $this->ctrl->redirectByClass(ilInfoScreenGUI::class, "showSummary");
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

initSettingsForm()

ilObjFileBasedLMGUI::initSettingsForm

(

)

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

                                      : void
    {
        $obj_service = $this->getObjectService();
 
        $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($this->lng->txt("cont_online"), "cobj_online");
        $cb->setOptionTitle($this->lng->txt(""));
        $cb->setValue("y");
        $this->form->addItem($cb);
 
        // startfile
        $startfile = ilObjFileBasedLMAccess::_determineStartUrl($this->object->getId());
 
        $ne = new ilNonEditableValueGUI($this->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", $this->lng->txt("save"));
        $this->form->addCommandButton("toFilesystem", $this->lng->txt("cont_set_start_file"));
 
        $this->form->setTitle($this->lng->txt("cont_lm_properties"));
        $this->form->setFormAction($this->ctrl->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
            ]
        );
    }

References ilObjFileBasedLMAccess\_determineStartUrl(), ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilObjectGUI\getObjectService(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, ilObjectServiceSettingsGUI\initServiceSettingsForm(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilObject\TITLE_LENGTH.

Referenced by properties(), and saveProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

learningProgress()

ilObjFileBasedLMGUI::learningProgress

(

)

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

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

listFiles()

ilObjFileBasedLMGUI::listFiles ( )

private

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

                                : void
    {
        if ($this->object->getResource() !== null) {
            $this->ctrl->redirectByClass(ilContainerResourceGUI::class);
            return;
        }
        $this->tabs->activateTab("id_list_files");
 
        $message_box = $this->gui->ui()->factory()->messageBox()->info(
            $this->lng->txt("infobox_files_not_migrated")
        );
 
        $this->tpl->setContent(
            $this->gui->ui()->renderer()->render([$message_box])
        );
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

properties()

ilObjFileBasedLMGUI::properties

(

)

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

                                : void
    {
        if (!$this->checkPermissionBool("write")) {
            $this->error->raiseError($this->lng->txt("permission_denied"), $this->error->MESSAGE);
        }
        $this->tabs->activateTab("id_settings");
 
        $this->initSettingsForm();
        $this->getSettingsFormValues();
        $this->tpl->setContent($this->form->getHTML());
    }

References ilObjectGUI\checkPermissionBool(), error(), ILIAS\Repository\form(), getSettingsFormValues(), initSettingsForm(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

redirectAfterCreation()

ilObjFileBasedLMGUI::redirectAfterCreation

(

)

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

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

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

Referenced by afterSave().

Here is the call graph for this function:

Here is the caller graph for this function:

redrawHeaderAction()

ilObjFileBasedLMGUI::redrawHeaderAction

(

)

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

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

References ilObjectGUI\redrawHeaderActionObject().

Here is the call graph for this function:

saveProperties()

ilObjFileBasedLMGUI::saveProperties

(

)

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

                                    : void
    {
        if (!$this->checkPermissionBool("write")) {
            $this->error->raiseError($this->lng->txt("permission_denied"), $this->error->MESSAGE);
        }
 
        $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");
        }
 
        $this->tabs->activateTab("id_settings");
        $this->form->setValuesByPost();
        $this->tpl->setContent($this->form->getHTML());
    }

References ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), error(), ILIAS\Repository\form(), ilObjectGUI\getObjectService(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, initSettingsForm(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ILIAS\Repository\tabs(), and ilObjectServiceSettingsGUI\updateServiceSettingsForm().

Here is the call graph for this function:

setStartFile()

ilObjFileBasedLMGUI::setStartFile

(

)

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

                                  : void
    {
        if (!$this->checkPermissionBool("write")) {
            $this->error->raiseError($this->lng->txt("permission_denied"), $this->error->MESSAGE);
        }
 
        // try to determine start file from request
        $start_file = $this->http->wrapper()->query()->has('lm_path')
            ? $start_file = $this->http->wrapper()->query()->retrieve(
                'lm_path',
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string())
            )[0] ?? ''
            : '';
        // the ContainerResourceGUI uses e bin2hex/hex2bin serialization of pathes. Due to the internals of
        // UI\Table\Data it's not possible to have a different handling for the parameter in case of external actions...
        try {
            $start_file = hex2bin($start_file);
        } catch (Throwable $e) {
            $start_file = '';
        }
 
        if ($start_file === '') {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('cont_no_start_file'), true);
        } else {
            $this->object->setStartFile($start_file);
            $this->object->update();
            $this->tpl->setOnScreenMessage('success', sprintf($this->lng->txt('cont_start_file_set_to'), $start_file), true);
        }
 
        $this->ctrl->redirectByClass(ilContainerResourceGUI::class);
    }

References Vendor\Package\$e, ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), error(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

setTabs()

ilObjFileBasedLMGUI::setTabs ( )

protected

set admin tabs

Reimplemented from ilObjectGUI.

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

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

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

showInfoScreen()

ilObjFileBasedLMGUI::showInfoScreen

(

)

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

                                    : void
    {
        $this->tabs->activateTab('id_info');
 
        $this->lng->loadLanguageModule("meta");
 
        $info = new ilInfoScreenGUI($this);
        $info->enablePrivateNotes();
        $info->enableLearningProgress();
 
        $info->enableNews();
        if ($this->access->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 ($this->access->checkAccess("read", "", $this->requested_ref_id)) {
            // #15127
            $this->gui->link(
                $this->lng->txt("view"),
                "ilias.php?baseClass=ilHTLMPresentationGUI&ref_id=" . $this->object->getRefId(),
                true
            )->primary()->toToolbar();
        }
 
        // show standard meta data section
        $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());
 
        // forward the command
        $this->ctrl->forwardCommand($info);
    }

References $info, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ILIAS\Repository\tabs().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

toFilesystem()

ilObjFileBasedLMGUI::toFilesystem

(

)

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

                                  : void
    {
        // If we already have a RID, we can redirect to Container GUI
        // otherwise we display an message which informs the user that the resource is not yet available
        if ($this->object->getRID() != "") {
            $this->ctrl->redirectByClass(ilContainerResourceGUI::class);
        } else {
            $this->ctrl->redirectByClass(static::class, "properties");
        }
    }

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

Here is the call graph for this function:

update()

ilObjFileBasedLMGUI::update

(

)

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

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

References ilObjectGUI\updateObject().

Here is the call graph for this function:

Field Documentation

$form

ilPropertyFormGUI ilObjFileBasedLMGUI::$form

protected

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

$gui

ILIAS HTMLLearningModule InternalGUIService ilObjFileBasedLMGUI::$gui

protected

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

Referenced by executeCommand().

$help

ilHelpGUI ilObjFileBasedLMGUI::$help

protected

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

Referenced by getTabs().

$irss

ILIAS ResourceStorage Services ilObjFileBasedLMGUI::$irss

private

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

$lm_request

StandardGUIRequest ilObjFileBasedLMGUI::$lm_request

protected

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

$output_prepared

bool ilObjFileBasedLMGUI::$output_prepared

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

$tabs

ilTabsGUI ilObjFileBasedLMGUI::$tabs

protected

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

CMD_IMPORT_FROM_UPLOAD_DIR

const ilObjFileBasedLMGUI::CMD_IMPORT_FROM_UPLOAD_DIR = 'importFromUploadDir'

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

Referenced by executeCommand().

CMD_LIST_FILES

const ilObjFileBasedLMGUI::CMD_LIST_FILES = "listFiles"

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

Referenced by ilObjFileBasedLMListGUI\getCommandLink().

PARAM_PATH

const ilObjFileBasedLMGUI::PARAM_PATH = "path"

private

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

Referenced by executeCommand().

---

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

• components/ILIAS/HTMLLearningModule/classes/class.ilObjFileBasedLMGUI.php