ilObjFileGUI Class Reference

GUI class for file objects. More...

Inheritance diagram for ilObjFileGUI:

Collaboration diagram for ilObjFileGUI:

Public Member Functions
	__construct (int $a_id=0, int $a_id_type=self::REPOSITORY_NODE_ID, int $a_parent_node_id=0)
	Constructor. More...
	getType ()
	getParentId ()
	initUploadForm ()
	putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
	edit ()
	sendFile ()
	showSummary ()
	showSummaryForced ()
	versions ()
	unzipCurrentRevision ()
	infoScreenForward ()
	show information screen More...
	buildInfoScreen (bool $kiosk_mode)
Public Member Functions inherited from ilObject2GUI
	__construct (int $id=0, int $id_type=self::REPOSITORY_NODE_ID, int $parent_node_id=0)
	executeCommand ()
	execute command More...
	getIdType ()
	delete ()
	Display delete confirmation form (repository/workspace switch) More...
	confirmedDelete ()
	Delete objects (repository/workspace switch) More...
	getHTML ()
	withReferences ()
	Final/Private declaration of unchanged parent methods. More...
	setCreationMode (bool $mode=true)
	getCreationMode ()
	prepareOutput (bool $show_sub_objects=true)
	isVisible (int $ref_id, string $type)
	setColumnSettings (ilColumnGUI $column_gui)
	view ()
	view object content (repository/workspace switch) More...
	getType ()
	Functions that must be overwritten. More...
	create ()
	CRUD. More...
	save ()
	edit ()
	update ()
	cancel ()
	putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
	Add object to tree at given position. More...
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 ($a_target, $a_additional=null)
Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $obj, ?int $callback_ref_id)
	After creation callback. More...
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode (int $ref_id, string $cmd="")
static	_gotoSharedWorkspaceNode (int $wsp_id)

Data Fields
const	UPLOAD_MAX_FILES = 100
const	PARAM_FILES = 'files'
const	PARAM_TITLE = 'title'
const	PARAM_DESCRIPTION = 'description'
const	PARAM_COPYRIGHT_ID = "copyright_id"
const	PARAM_UPLOAD_ORIGIN = 'origin'
const	UPLOAD_ORIGIN_STANDARD = 'standard'
const	UPLOAD_ORIGIN_DROPZONE = 'dropzone'
const	CMD_EDIT = Capabilities::EDIT_SETTINGS->value
const	CMD_VERSIONS = Capabilities::MANAGE_VERSIONS->value
const	CMD_UPLOAD_FILES = "uploadFiles"
const	CMD_SEND_FILE = Capabilities::DOWNLOAD->value
ilObject	$object = null
ilLanguage	$lng
Data Fields inherited from ilObject2GUI
const	OBJECT_ID = 0
const	REPOSITORY_NODE_ID = 1
const	WORKSPACE_NODE_ID = 2
const	REPOSITORY_OBJECT_ID = 3
const	WORKSPACE_OBJECT_ID = 4
const	PORTFOLIO_OBJECT_ID = 5
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
	updateLearningProgress ()
	addUIFormToAccordion (ilAccordionGUI $accordion, Standard $form, int $form_type)
	addLegacyFormToAccordion (ilAccordionGUI $accordion, ilPropertyFormGUI $form, int $form_type)
	initCreateForm (string $new_type)
	getCreationFormTitle ()
	uploadFiles ()
	MUST be protected, since this is Called from ilObject2GUI when used in Personal Workspace. More...
	initPropertiesForm ()
	editExternal ()
	viewExternal ()
	toggleLearningProgress ()
	setTabs ()
	initSettingsTab ()
	addLocatorItems ()
	initHeaderAction (?string $a_sub_type=null, ?int $a_sub_id=null)
	getCtrl ()
	getFileObj ()
	getFileStakeholder ()
	getGeneralSettings ()
	getLanguage ()
	getNodeID ()
	getRefinery ()
	getUIFactory ()
	getUser ()
Protected Member Functions inherited from ilObject2GUI
	afterConstructor ()
	Do anything that should be done after constructor in here. More...
	assignObject ()
	create object instance as internal property (repository/workspace switch) More...
	getAccessHandler ()
	setLocator ()
	set Locator More...
	deleteConfirmedObjects ()
	Delete objects (workspace specific) This should probably be moved elsewhere as done with RepUtil. More...
	setTitleAndDescription ()
	omitLocator (bool $omit=true)
	getTargetFrame (string $cmd, string $target_frame="")
	setTargetFrame (string $cmd, string $target_frame)
	getCenterColumnHTML ()
	getRightColumnHTML ()
	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	showPossibleSubObjects ()
	redirectToRefId (int $ref_id, string $cmd="")
	addAdminLocatorItems (bool $do_not_add_object=false)
	setTabs ()
	create tabs (repository/workspace switch) More...
	getReturnLocation (string $cmd, string $location="")
	Deprecated functions. More...
	setReturnLocation (string $cmd, string $location)
	showActions ()
	getTabs ()
	addLocatorItems ()
	Functions to be overwritten. More...
	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $node_id=null)
	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...
	redrawHeaderAction ()
	Updating icons after ajax call. More...
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	assignObject ()
	setTitleAndDescription ()
	createActionDispatcherGUI ()
	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...
	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	setTabs ()
	set admin tabs More...
	setAdminTabs ()
	set admin tabs More...
	setLocator ()
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator (bool $omit=true)
	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	getCreationFormsHTML (StandardForm|ilPropertyFormGUI|array $form)
	getTitleForCreationFormPage ()
	getCreationFormTitle ()
	initCreateForm (string $new_type)
	didacticTemplatesToForm ()
	initDidacticTemplate (ilPropertyFormGUI $form)
	retrieveAdditionalDidacticTemplateOptions ()
	addAdoptContentLinkToToolbar ()
	addImportButtonToToolbar ()
	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)
	parseDidacticTemplateVar (string $var, string $type)
	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	routeImportCmdObject ()
	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)
	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)
	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...
	setFormAction (string $cmd, string $form_action)
	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...
	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...
	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...
	getTabs ()
	overwrite in derived GUI class of your object type More...
	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	getCreatableObjectTypes ()
	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)
	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Protected Attributes
UIServices	$ui
UploadHandler	$upload_handler
ResourceStakeholder	$stakeholder
Services	$storage
ilLogger	$log = null
ilObjectService	$obj_service
ILIAS Refinery Factory	$refinery
General	$general_settings
ilFileServicesSettings	$file_service_settings
IconDatabaseRepository	$icon_repo
ILIAS UI Component Input Factory	$inputs
Renderer	$renderer
ServerRequestInterface	$request
Factory	$data_factory
LOMServices	$lom_services
Protected Attributes inherited from ilObject2GUI
ilObjectDefinition	$obj_definition
ilGlobalTemplateInterface	$tpl
ilCtrl	$ctrl
ilLanguage	$lng
ilTabsGUI	$tabs_gui
ilFavouritesManager	$favourites
ilErrorHandling	$error
ilLocatorGUI	$locator
ilObjUser	$user
ilAccessHandler	$access
ilToolbarGUI	$toolbar
Factory	$refinery
ilRbacAdmin	$rbac_admin
ilRbacSystem	$rbac_system
ilRbacReview	$rbac_review
int	$request_ref_id
int	$id_type
int	$parent_id
string	$type
string	$html
int	$object_id
int	$node_id = null
array	$creation_forms = []
	$access_handler
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 Attributes
CapabilityCollection	$capabilities
ActionDBRepository	$action_repo

Detailed Description

GUI class for file objects.

Author

Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Stefan Born stefa.nosp@m.n.bo.nosp@m.rn@ph.nosp@m.zh.c.nosp@m.h

Version

$Id$ ilObjFileGUI: ilObjectMetaDataGUI, ilInfoScreenGUI, ilPermissionGUI, ilObjectCopyGUI ilObjFileGUI: ilExportGUI, ilWorkspaceAccessGUI, ilPortfolioPageGUI, ilCommonActionDispatcherGUI ilObjFileGUI: ilLearningProgressGUI, ilFileVersionsGUI, ilWOPIEmbeddedApplicationGUI ilObjFileGUI: ilFileCommonSettingsGUI

Definition at line 52 of file class.ilObjFileGUI.php.

Constructor & Destructor Documentation

__construct()

ilObjFileGUI::__construct	(	int	$a_id = 0,
		int	$a_id_type = self::REPOSITORY_NODE_ID,
		int	$a_parent_node_id = 0
	)

Constructor.

Definition at line 100 of file class.ilObjFileGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilLoggerFactory\getLogger(), ILIAS\Repository\lng(), ilObjFile\OBJECT_TYPE, ILIAS\Repository\refinery(), renderer(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

    {
        global $DIC;
        $this->refinery = $DIC->refinery();
        $this->file_service_settings = $DIC->fileServiceSettings();
        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        $this->log = ilLoggerFactory::getLogger(ilObjFile::OBJECT_TYPE);
        $this->ui = $DIC->ui();
        $this->storage = $DIC->resourceStorage();
        $this->upload_handler = new ilObjFileUploadHandlerGUI();
        $this->stakeholder = new ilObjFileStakeholder();
        $this->general_settings = new General();
        parent::__construct($a_id, $a_id_type, $a_parent_node_id);
        $this->obj_service = $DIC->object();
        $this->lng->loadLanguageModule(ilObjFile::OBJECT_TYPE);
        $this->icon_repo = new IconDatabaseRepository();
        $this->inputs = $DIC->ui()->factory()->input();
        $this->renderer = $DIC->ui()->renderer();
        $this->request = $DIC->http()->request();
        $this->data_factory = new Factory();
        $this->action_repo = new ActionDBRepository($DIC->database());
        $this->lom_services = $DIC->learningObjectMetadata();

        $capability_builder = new CapabilityBuilder(
            new ilObjFileInfoRepository(),
            $this->access,
            $this->ctrl,
            $this->action_repo,
            $DIC->http(),
            $DIC['static_url.uri_builder']
        );

        $capability_context = new Context(
            $this->object_id,
            $this->ref_id,
            ($a_id_type === self::WORKSPACE_NODE_ID) ? Context::CONTEXT_WORKSPACE : Context::CONTEXT_REPO
        );

        $this->capabilities = $capability_builder->get($capability_context);
    }

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilObjFileGUI::_goto (   $a_target,   $a_additional = null  )

static

Definition at line 1084 of file class.ilObjFileGUI.php.

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

                                                                 : void
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();
        $ilErr = $DIC['ilErr'];
        $lng = $DIC['lng'];
        $ilAccess = $DIC['ilAccess'];

        if ($a_additional && str_ends_with((string) $a_additional, "wsp")) {
            ilObjectGUI::_gotoSharedWorkspaceNode((int) $a_target);
        }

        // added support for direct download goto links
        if ($a_additional && str_ends_with((string) $a_additional, "download")) {
            ilObjectGUI::_gotoRepositoryNode($a_target, "sendfile");
        }

        // static method, no workspace support yet

        if ($ilAccess->checkAccess("visible", "", $a_target)
            || $ilAccess->checkAccess("read", "", $a_target)) {
            ilObjectGUI::_gotoRepositoryNode($a_target, Capabilities::INFO_PAGE->value);
        } 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();
        }

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

Here is the call graph for this function:

addLegacyFormToAccordion()

ilObjFileGUI::addLegacyFormToAccordion ( ilAccordionGUI  $accordion, ilPropertyFormGUI  $form, int  $form_type  )

protected

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

References ilObject2GUI\$tpl, ilAccordionGUI\addItem(), ILIAS\UICore\GlobalTemplate\get(), ilPropertyFormGUI\getHTML(), ilPropertyFormGUI\getTitle(), ILIAS\Repository\lng(), ilPropertyFormGUI\setTitle(), and ILIAS\UICore\GlobalTemplate\setVariable().

     : void {
        // abort if form-type is unknown
        if (!in_array($form_type, [self::CFORM_NEW, self::CFORM_CLONE, self::CFORM_IMPORT], true)) {
            return;
        }
        $title = $form->getTitle();
        $form->setTitle(''); // see https://mantis.ilias.de/view.php?id=37786

        $tpl = new ilTemplate("tpl.creation_acc_head.html", true, true, "components/ILIAS/ILIASObject");
        $tpl->setVariable("TITLE", $this->lng->txt("option") . " " . $form_type . ": " . $title);

        $accordion->addItem($tpl->get(), $form->getHTML());
    }

Here is the call graph for this function:

addLocatorItems()

ilObjFileGUI::addLocatorItems ( )

protected

Definition at line 1124 of file class.ilObjFileGUI.php.

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

                                        : void
    {
        global $DIC;
        $ilLocator = $DIC['ilLocator'];

        if (is_object($this->object)) {
            $ilLocator->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, ""), "", $this->node_id);
        }
    }

Here is the call graph for this function:

addUIFormToAccordion()

ilObjFileGUI::addUIFormToAccordion ( ilAccordionGUI  $accordion, Standard  $form, int  $form_type  )

protected

Definition at line 364 of file class.ilObjFileGUI.php.

References ilObject2GUI\$tpl, ilAccordionGUI\addItem(), ILIAS\UICore\GlobalTemplate\get(), ILIAS\UI\Component\Input\Container\Container\getInputs(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\setVariable(), and ILIAS\Repository\ui().

     : void {
        // abort if form-type is unknown
        if (!in_array($form_type, [self::CFORM_NEW, self::CFORM_CLONE, self::CFORM_IMPORT], true)) {
            return;
        }

        $inputs = $form->getInputs();
        // use label of first input as title, because UI Component forms don't support form-titles yet
        $title = ($inputs === []) ?
            '' : $inputs[array_key_first($inputs)]->getLabel();

        $tpl = new ilTemplate("tpl.creation_acc_head.html", true, true, "components/ILIAS/ILIASObject");
        $tpl->setVariable("TITLE", $this->lng->txt("option") . " " . $form_type . ": " . $title);

        $accordion->addItem($tpl->get(), $this->ui->renderer()->render($form));
    }

Here is the call graph for this function:

buildInfoScreen()

ilObjFileGUI::buildInfoScreen

(

bool

$kiosk_mode

)

Definition at line 864 of file class.ilObjFileGUI.php.

References $info, ilObjectGUI\$obj_id, $r, $url, ilObject\_getAllReferences(), ilObjFileAccess\_getPermanentDownloadLink(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\ILIASObject\Creation\Group, ILIAS\Repository\lng(), ilAdvancedMDRecordGUI\MODE_INFO, null, ILIAS\Repository\object(), renderer(), and ILIAS\Repository\ui().

Referenced by infoScreenForward().

                                                     : ilInfoScreenGUI
    {
        $info = new ilInfoScreenGUI($this);

        if (!$kiosk_mode) { // in kiosk mode we don't want to show the following sections
            $info->enablePrivateNotes();

            if ($this->capabilities->get(Capabilities::DOWNLOAD)->isUnlocked()) {
                $info->enableNews();
            }

            // no news editing for files, just notifications
            $info->enableNewsEditing(false);
            if ($this->capabilities->get(Capabilities::MANAGE_VERSIONS)->isUnlocked()) {
                $news_set = new ilSetting("news");
                $enable_internal_rss = $news_set->get("enable_rss_for_internal");

                if ($enable_internal_rss) {
                    $info->setBlockProperty("news", "settings", true);
                    $info->setBlockProperty("news", "public_notifications_option", true);
                }
            }

            $obj_id = $this->object->getId();
            $record_gui = new ilAdvancedMDRecordGUI(
                ilAdvancedMDRecordGUI::MODE_INFO,
                'file',
                $obj_id,
                '',
                0,
                $this->call_by_reference
            );
            $record_gui->setInfoObject($info);
            $record_gui->parse();
        }
        // show rating is not possible in kiosk mode

        // Important Information
        $important_info = $this->object->getImportantInfo();
        if (!empty($important_info)) {
            $group = new Group(new Factory(), $this->lng);
            $markdown_to_html = $group->markdown()->toHTML();

            $info->addSection($this->lng->txt("important_info"));
            $info->addProperty("", $markdown_to_html->transform($important_info));
        }

        // Download Launcher
        if ($this->capabilities->get(Capabilities::DOWNLOAD)->isUnlocked()) {
            // get permanent download link for repository
            if ($this->id_type === self::REPOSITORY_NODE_ID) {
                $download_target = ilObjFileAccess::_getPermanentDownloadLink($this->node_id);
            } else {
                $download_target = rtrim(ILIAS_HTTP_PATH, '/') . '/' . $this->ctrl->getLinkTarget(
                    $this,
                    self::CMD_SEND_FILE
                );
            }
            $url = $this->data_factory->uri($download_target);
            $link = $this->data_factory->link($this->lng->txt('file_download'), $url);
            $download_launcher = $this->ui->factory()->launcher()->inline($link);
            // create own section for download launcher if there is no important info section
            if (empty($important_info)) {
                $info->addSection("");
            }
            // add download launcher
            $info->addProperty("", $this->renderer->render($download_launcher));
        }

        // standard meta data
        $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());

        // in kiosk mode we don't want to show the following sections
        // links to resource
        if (!$kiosk_mode && ($this->access->checkAccess("write", "", $this->ref_id) ||
            $this->access->checkAccess("edit_permissions", "", $this->ref_id))) {
            $rs = ilObject::_getAllReferences($this->obj_id);
            $refs = [];
            foreach ($rs as $r) {
                if ($this->tree->isInTree($r)) {
                    $refs[] = $r;
                }
            }
            if (count($refs) > 1) {
                $links = $sep = "";
                foreach ($refs as $r) {
                    $cont_loc = new ilLocatorGUI();
                    $cont_loc->addContextItems($r, true);
                    $links .= $sep . $cont_loc->getHTML();
                    $sep = "<br />";
                }

                $info->addProperty(
                    $this->lng->txt("res_links"),
                    '<div class="small">' . $links . '</div>'
                );
            }
        }

        // File Info
        $info->addSection($this->lng->txt("file_info"));
        if ($kiosk_mode) {
            $file_info_for_users = $this->getFileInfoForUsers();
            foreach ($file_info_for_users as $file_info_entry_key => $file_info_entry_value) {
                if ($file_info_entry_value !== null) {
                    $info->addProperty($file_info_entry_key, $file_info_entry_value);
                }
            }
        } else {
            $file_info = $this->getAllFileInfoForCurrentUser();
            foreach ($file_info as $file_info_block) {
                foreach ($file_info_block as $file_info_entry_key => $file_info_entry_value) {
                    if ($file_info_entry_value !== null) {
                        $info->addProperty($file_info_entry_key, $file_info_entry_value);
                    }
                }
            }
        }

        $info->hideFurtherSections(false);

        return $info;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

edit()

ilObjFileGUI::edit

(

)

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

References $DIC, $ilErr, initPropertiesForm(), initSettingsTab(), ILIAS\Repository\lng(), and renderer().

                          : void
    {
        global $DIC;
        $ilErr = $DIC['ilErr'];

        if (!$this->capabilities->get(Capabilities::EDIT_SETTINGS)->isUnlocked()) {
            $ilErr->raiseError($this->lng->txt("msg_no_perm_write"));
        }

        $this->initSettingsTab();

        $form = $this->initPropertiesForm();

        //        $ecs = new ilECSFileSettings($this->object);
        //        $ecs->addSettingsToForm($form, ilObjFile::OBJECT_TYPE); TODO: reintroduce usage of ECS file settings once they have been made compatible with the new ui components

        $this->tpl->setContent($this->renderer->render($form));
    }

Here is the call graph for this function:

editExternal()

ilObjFileGUI::editExternal ( )

protected

Definition at line 785 of file class.ilObjFileGUI.php.

References ILIAS\Repository\ctrl().

                                     : void
    {
        $this->ctrl->redirectToURL(
            (string) $this->capabilities->get(Capabilities::EDIT_EXTERNAL)->getUri()
        );
    }

Here is the call graph for this function:

getCreationFormTitle()

ilObjFileGUI::getCreationFormTitle ( )

protected

Definition at line 413 of file class.ilObjFileGUI.php.

References ILIAS\Repository\lng().

                                             : string
    {
        return $this->lng->txt('upload_files');
    }

Here is the call graph for this function:

getCtrl()

ilObjFileGUI::getCtrl ( )

protected

Definition at line 1150 of file class.ilObjFileGUI.php.

References ilObject2GUI\$ctrl.

                                : \ilCtrl
    {
        return $this->ctrl;
    }

getFileObj()

ilObjFileGUI::getFileObj ( )

protected

Exceptions

ilFileException

Definition at line 1158 of file class.ilObjFileGUI.php.

References $object.

                                   : ilObjFile
    {
        if (!$this->object instanceof ilObjFile) {
            throw new ilFileException("Error: object is not of type ilObjFile or doesn't exist");
        }

        return $this->object;
    }

getFileStakeholder()

ilObjFileGUI::getFileStakeholder ( )

protected

Definition at line 1167 of file class.ilObjFileGUI.php.

References $stakeholder.

                                           : ilObjFileStakeholder
    {
        return $this->stakeholder;
    }

getGeneralSettings()

ilObjFileGUI::getGeneralSettings ( )

protected

Definition at line 1172 of file class.ilObjFileGUI.php.

References $general_settings.

                                           : General
    {
        return $this->general_settings;
    }

getLanguage()

ilObjFileGUI::getLanguage ( )

protected

Definition at line 1177 of file class.ilObjFileGUI.php.

References $lng.

Referenced by initUploadForm().

                                    : \ilLanguage
    {
        return $this->lng;
    }

Here is the caller graph for this function:

getNodeID()

ilObjFileGUI::getNodeID ( )

protected

Definition at line 1182 of file class.ilObjFileGUI.php.

References ilObject2GUI\$node_id.

                                  : int
    {
        return $this->node_id;
    }

getParentId()

ilObjFileGUI::getParentId

(

)

Definition at line 160 of file class.ilObjFileGUI.php.

References $DIC, $ilErr, $info, $object, ilObject2GUI\$parent_id, $user_id, ilObjectGUI\addHeaderAction(), ilWOPIEmbeddedApplicationGUI\CMD_EDIT, ilWOPIEmbeddedApplicationGUI\CMD_RETURN, ilWOPIEmbeddedApplicationGUI\CMD_VIEW, ILIAS\Repository\ctrl(), ilObject2GUI\executeCommand(), ilObject2GUI\getAccessHandler(), ilObject2GUI\getCreationMode(), ilWorkspaceAccessHandler\getGotoLink(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), infoScreenForward(), initSettingsTab(), ILIAS\Repository\lng(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, null, ILIAS\Repository\object(), ilObjFile\OBJECT_TYPE, ilObject2GUI\prepareOutput(), ILIAS\Repository\refinery(), and updateLearningProgress().

                                 : int
    {
        return $this->parent_id;
    }

Here is the call graph for this function:

getRefinery()

ilObjFileGUI::getRefinery ( )

protected

Definition at line 1187 of file class.ilObjFileGUI.php.

References $refinery.

                                    : \ILIAS\Refinery\Factory
    {
        return $this->refinery;
    }

getType()

ilObjFileGUI::getType

(

)

Definition at line 155 of file class.ilObjFileGUI.php.

References ilObjFile\OBJECT_TYPE.

Referenced by initUploadForm().

                             : string
    {
        return ilObjFile::OBJECT_TYPE;
    }

Here is the caller graph for this function:

getUIFactory()

ilObjFileGUI::getUIFactory ( )

protected

Definition at line 1192 of file class.ilObjFileGUI.php.

References ILIAS\Repository\ui().

                                     : ILIAS\UI\Factory
    {
        return $this->ui->factory();
    }

Here is the call graph for this function:

getUser()

ilObjFileGUI::getUser ( )

protected

Definition at line 1197 of file class.ilObjFileGUI.php.

References ilObject2GUI\$user.

                                : ilObjUser
    {
        return $this->user;
    }

infoScreenForward()

ilObjFileGUI::infoScreenForward

(

)

show information screen

Definition at line 801 of file class.ilObjFileGUI.php.

References $GLOBALS, $info, ilLPStatus\_hasUserCompleted(), buildInfoScreen(), ilWOPIEmbeddedApplicationGUI\CMD_EDIT, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilLPObjSettings\LP_MODE_MANUAL, ILIAS\Repository\object(), ILIAS\Repository\toolbar(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Referenced by getParentId().

                                       : void
    {
        $this->tabs_gui->activateTab("id_info");

        if (!$this->capabilities->get(Capabilities::INFO_PAGE)->isUnlocked()) {
            $GLOBALS['DIC']['ilErr']->raiseError(
                $this->lng->txt("msg_no_perm_read"),
                2
            ); // TODO remove magic number and old ilErr call
        }

        // add set completed button, if LP mode is active
        if ($this->object->getLPMode() === ilLPObjSettings::LP_MODE_MANUAL) {
            if (ilLPStatus::_hasUserCompleted($this->object->getId(), $this->user->getId())) {
                $label = $this->lng->txt('file_btn_lp_toggle_state_completed');
            } else {
                $label = $this->lng->txt('file_btn_lp_toggle_state_not_completed');
            }
            $this->toolbar->addComponent(
                $this->ui->factory()->button()->standard(
                    $label,
                    $this->ctrl->getLinkTarget($this, 'toggleLearningProgress')
                )
            );
        }

        // Add WOPI editor Button
        if ($this->capabilities->get(Capabilities::EDIT_EXTERNAL)->isUnlocked()) {
            $external_editor = $this->ui->factory()
                                        ->button()
                                        ->standard(
                                            $this->lng->txt('open_external_editor'),
                                            $this->ctrl->getLinkTargetByClass(
                                                \ilWOPIEmbeddedApplicationGUI::class,
                                                \ilWOPIEmbeddedApplicationGUI::CMD_EDIT
                                            )
                                        );
            $this->toolbar->addComponent($external_editor);
        }

        $info = $this->buildInfoScreen(false);
        $this->ctrl->forwardCommand($info);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initCreateForm()

ilObjFileGUI::initCreateForm ( string  $new_type )

protected

Returns

array

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

References initUploadForm().

                                                       : Standard
    {
        return $this->initUploadForm();
    }

Here is the call graph for this function:

initHeaderAction()

ilObjFileGUI::initHeaderAction ( ?string  $a_sub_type = null, ?int  $a_sub_id = null  )

protected

Definition at line 1135 of file class.ilObjFileGUI.php.

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

                                                                                          : ?\ilObjectListGUI
    {
        $lg = parent::initHeaderAction($a_sub_type, $a_sub_id);
        if ($lg instanceof ilObjectListGUI && $this->object->hasRating()) {
            $lg->enableRating(
                true,
                null,
                false,
                [ilCommonActionDispatcherGUI::class, ilRatingGUI::class]
            );
        }

        return $lg;
    }

Here is the call graph for this function:

initPropertiesForm()

ilObjFileGUI::initPropertiesForm ( )

protected

Definition at line 631 of file class.ilObjFileGUI.php.

References $inputs, $refinery, ilObjFile\CLICK_MODE_DOWNLOAD, ilObjFile\CLICK_MODE_INFOPAGE, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), null, ILIAS\Repository\object(), ILIAS\Repository\ui(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by edit(), and putObjectInTree().

                                           : Standard
    {
        $title_and_description = $this->object->getObjectProperties()->getPropertyTitleAndDescription()->toForm(
            $this->lng,
            $this->ui->factory()->input()->field(),
            $this->refinery
        );

        $important_info = $this->inputs->field()->markdown(
            new ilUIMarkdownPreviewGUI(),
            $this->lng->txt('important_info'),
            $this->lng->txt('important_info_byline')
        )->withValue(
            $this->object->getImportantInfo() ?? ""
        );

        $on_click_action = $this->inputs->field()->radio(
            $this->lng->txt('on_click_action')
        )->withOption(
            (string) ilObjFile::CLICK_MODE_DOWNLOAD,
            $this->lng->txt('file_action_download'),
            $this->lng->txt('file_action_download_info'),
        )->withOption(
            (string) ilObjFile::CLICK_MODE_INFOPAGE,
            $this->lng->txt('file_action_show'),
            $this->lng->txt('file_action_show_info'),
        )->withValue(
            (string) $this->object->getOnClickMode()
        );

        $input_groups = array_filter([
            "title_and_description" => $title_and_description,
            "important_info" => $important_info,
            "on_click_action" => $on_click_action
        ], static fn($input): bool => null !== $input);

        $file_info_section = $this->inputs->field()->section(
            $input_groups,
            $this->lng->txt('file_info')
        );

        $online_status = $this->object->getObjectProperties()->getPropertyIsOnline()->toForm(
            $this->lng,
            $this->ui->factory()->input()->field(),
            $this->refinery
        );
        $availability_section = $this->inputs->field()->section(
            ["online_status" => $online_status],
            $this->lng->txt('rep_activation_availability')
        );

        $presentation_section = null;
        if ($this->id_type === self::REPOSITORY_NODE_ID) {
            $tile_image = $this->object->getObjectProperties()->getPropertyTileImage()->toForm(
                $this->lng,
                $this->ui->factory()->input()->field(),
                $this->refinery
            );
            $presentation_section = $this->inputs->field()->section(
                ["tile_image" => $tile_image],
                $this->lng->txt('settings_presentation_header')
            );
        }

        $additional_features_section = null;
        if ($this->id_type === self::REPOSITORY_NODE_ID) {
            $this->lng->loadLanguageModule('rating');

            $enable_rating = $this->inputs->field()->checkbox(
                $this->lng->txt('rating_activate_rating'),
                $this->lng->txt('rating_activate_rating_info')
            )->withValue(
                $this->object->hasRating()
            );
            $additional_features_section = $this->inputs->field()->section(
                ["rating" => $enable_rating],
                $this->lng->txt('obj_features')
            );
        }

        $inputs = array_filter([
            "file_info" => $file_info_section,
            "availability" => $availability_section,
            "presentation" => $presentation_section,
            "obj_features" => $additional_features_section
        ], static fn($input): bool => null !== $input);

        return $this->inputs->container()->form()->standard(
            $this->ctrl->getLinkTargetByClass(self::class, 'update'),
            $inputs
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initSettingsTab()

ilObjFileGUI::initSettingsTab ( )

protected

Definition at line 1064 of file class.ilObjFileGUI.php.

References ilAdvancedMDRecord\_getActivatedObjTypes(), ilFileCommonSettingsGUI\CMD_EDIT, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by edit(), and getParentId().

                                        : void
    {
        $this->tabs_gui->activateTab("settings");
        // add subtab for common settings
        $this->tabs_gui->addSubTab(
            'file_settings',
            $this->lng->txt('settings'),
            $this->ctrl->getLinkTargetByClass(self::class, self::CMD_EDIT)
        );
        if (in_array('file', ilAdvancedMDRecord::_getActivatedObjTypes(), true)) {
            $this->tabs_gui->addSubTab(
                'service_settings',
                $this->lng->txt('service_settings'),
                $this->ctrl->getLinkTargetByClass(ilFileCommonSettingsGUI::class, ilFileCommonSettingsGUI::CMD_EDIT)
            );
        }

        $this->tabs_gui->activateSubTab("file_settings");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initUploadForm()

ilObjFileGUI::initUploadForm

(

)

Definition at line 418 of file class.ilObjFileGUI.php.

References $inputs, ILIAS\Repository\ctrl(), getLanguage(), getType(), ILIAS\Repository\lng(), null, ILIAS\Repository\ui(), and ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation().

Referenced by initCreateForm(), and uploadFiles().

                                    : Standard
    {
        $this->getLanguage()->loadLanguageModule('file');
        $inputs = [];

        $this->ctrl->setParameterByClass(self::class, 'new_type', $this->getType());
        $this->ctrl->setParameterByClass(
            self::class,
            self::PARAM_UPLOAD_ORIGIN,
            self::UPLOAD_ORIGIN_STANDARD
        );


        $inputs[self::PARAM_FILES] = $this->ui->factory()->input()->field()->file(
            $this->upload_handler,
            $this->lng->txt('upload_files'),
            null,
            $this->ui->factory()->input()->field()->group([
                self::PARAM_TITLE => $this->ui->factory()->input()->field()->text(
                    $this->lng->txt('title')
                )->withAdditionalTransformation(
                    $this->getEmptyStringToNullTransformation()
                ),
                self::PARAM_DESCRIPTION => $this->ui->factory()->input()->field()->textarea(
                    $this->lng->txt('description')
                )->withAdditionalTransformation(
                    $this->getEmptyStringToNullTransformation()
                ),
            ])
        )->withMaxFiles(
            self::UPLOAD_MAX_FILES
        )->withRequired(true);

        if ($this->lom_services->copyrightHelper()->isCopyrightSelectionActive()) {
            $inputs[self::PARAM_COPYRIGHT_ID] = $this->getCopyrightSelectionInput('set_license_for_all_files');
        }

        return $this->ui->factory()->input()->container()->form()->standard(
            $this->ctrl->getFormActionByClass(self::class, self::CMD_UPLOAD_FILES),
            $inputs
        )->withSubmitLabel($this->lng->txt('upload_files'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

putObjectInTree()

ilObjFileGUI::putObjectInTree	(	ilObject	$obj,
		?int	$parent_node_id = null
	)

Definition at line 543 of file class.ilObjFileGUI.php.

References ilObjectGUI\$data, $DIC, $filename, ilObject2GUI\$node_id, ilChangeEvent\_catchupWriteEvents(), ilChangeEvent\_recordWriteEvent(), ILIAS\Repository\ctrl(), initPropertiesForm(), ILIAS\Repository\lng(), null, ILIAS\Repository\object(), and ilObject2GUI\update().

                                                                               : void
    {
        // this is needed to support multi fileuploads in personal and shared resources
        $backup_node_id = $this->node_id;
        parent::putObjectInTree($obj, $parent_node_id);
        $this->node_id = $backup_node_id;
    }

Here is the call graph for this function:

sendFile()

ilObjFileGUI::sendFile

(

)

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

References Vendor\Package\$e, ilChangeEvent\_recordReadEvent(), ANONYMOUS_USER_ID, ILIAS\Repository\lng(), null, ILIAS\Repository\object(), ILIAS\Repository\refinery(), updateLearningProgress(), and ILIAS\Repository\user().

                              : bool
    {
        $hist_entry_id = $this->request_wrapper->has('hist_id')
            ? $this->request_wrapper->retrieve('hist_id', $this->refinery->kindlyTo()->int())
            : null;
        try {
            if (ANONYMOUS_USER_ID === $this->user->getId() && $this->request_wrapper->has('transaction')) {
                $this->object->sendFile($hist_entry_id);
            }

            if ($this->capabilities->get(Capabilities::DOWNLOAD)->isUnlocked()) {
                // Record read event and catchup with write events
                ilChangeEvent::_recordReadEvent(
                    $this->object->getType(),
                    $this->object->getRefId(),
                    $this->object->getId(),
                    $this->user->getId()
                );
                $this->updateLearningProgress();

                $this->object->sendFile($hist_entry_id);
            } else {
                $this->error->raiseError($this->lng->txt("permission_denied"), $this->error->MESSAGE);
            }
        } catch (FileNotFoundException $e) {
            $this->error->raiseError($e->getMessage(), $this->error->MESSAGE);
        }

        return true;
    }

Here is the call graph for this function:

setTabs()

ilObjFileGUI::setTabs ( )

protected

Definition at line 990 of file class.ilObjFileGUI.php.

References $c, $DIC, ilLearningProgressAccess\checkAccess(), ilFileVersionsGUI\CMD_DEFAULT, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), null, ILIAS\Repository\object(), and ilObjFile\OBJECT_TYPE.

                                : void
    {
        global $DIC;
        $ilHelp = $DIC['ilHelp'];
        $ilHelp->setScreenIdComponent(ilObjFile::OBJECT_TYPE);

        $this->ctrl->setParameter($this, "ref_id", $this->node_id);

        if (($c = $this->capabilities->get(Capabilities::VIEW_EXTERNAL)) && $c->isUnlocked()) {
            $this->tabs_gui->addTab(
                "content",
                $this->lng->txt("content"),
                $c->getURI()
            );
        }

        if (($c = $this->capabilities->get(Capabilities::MANAGE_VERSIONS)) && $c->isUnlocked()) {
            $this->tabs_gui->addTab(
                "id_versions",
                $this->lng->txt(self::CMD_VERSIONS),
                $this->ctrl->getLinkTargetByClass(ilFileVersionsGUI::class, ilFileVersionsGUI::CMD_DEFAULT)
            );
        }

        if (($c = $this->capabilities->get(Capabilities::INFO_PAGE)) && $c->isUnlocked()) {
            $this->tabs_gui->addTab(
                "id_info",
                $this->lng->txt("info_short"),
                $this->ctrl->getLinkTargetByClass(["ilobjfilegui", "ilinfoscreengui"], "showSummary")
            );
        }

        if (($c = $this->capabilities->get(Capabilities::EDIT_SETTINGS)) && $c->isUnlocked()) {
            $this->tabs_gui->addTab(
                "settings",
                $this->lng->txt("settings"),
                $this->ctrl->getLinkTarget($this, self::CMD_EDIT)
            );
        }

        if (ilLearningProgressAccess::checkAccess($this->object->getRefId())) {
            $this->tabs_gui->addTab(
                'learning_progress',
                $this->lng->txt('learning_progress'),
                $this->ctrl->getLinkTargetByClass([self::class, 'illearningprogressgui'], '')
            );
        }

        // meta data
        if (($c = $this->capabilities->get(Capabilities::EDIT_SETTINGS)) && $c->isUnlocked()) {
            $mdgui = new ilObjectMetaDataGUI($this->object, null, null, $this->call_by_reference);
            $mdtab = $mdgui->getTab();
            if ($mdtab) {
                $this->tabs_gui->addTab(
                    "id_meta",
                    $this->lng->txt("meta_data"),
                    $mdtab
                );
            }
        }

        // export
        if (($c = $this->capabilities->get(Capabilities::EDIT_SETTINGS)) && $c->isUnlocked()) {
            $this->tabs_gui->addTab(
                "export",
                $this->lng->txt("export"),
                $this->ctrl->getLinkTargetByClass("ilexportgui", "")
            );
        }

        // will add permission tab if needed
        parent::setTabs();
    }

Here is the call graph for this function:

showSummary()

ilObjFileGUI::showSummary

(

)

Deprecated:

PROXY COMMAND

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

References ILIAS\Repository\ctrl().

                                 : void
    {
        $this->ctrl->redirectToURL(
            (string) $this->capabilities->get(Capabilities::INFO_PAGE)->getUri()
        );
    }

Here is the call graph for this function:

showSummaryForced()

ilObjFileGUI::showSummaryForced

(

)

Definition at line 764 of file class.ilObjFileGUI.php.

References ILIAS\Repository\ctrl().

                                       : void
    {
        $this->ctrl->redirectToURL(
            (string) $this->capabilities->get(Capabilities::FORCED_INFO_PAGE)->getUri()
        );
    }

Here is the call graph for this function:

toggleLearningProgress()

ilObjFileGUI::toggleLearningProgress ( )

protected

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

References ilObjectGUI\$obj_id, ilObjectGUI\$ref_id, ilLPStatus\_hasUserCompleted(), ilLearningProgress\_tracProgress(), ilLPStatusWrapper\_updateStatus(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ILIAS\Repository\user().

                                               : void
    {
        ilLearningProgress::_tracProgress(
            $this->user->getId(),
            $this->obj_id,
            $this->ref_id,
            'file'
        );

        $lp_marks = new ilLPMarks($this->obj_id, $this->user->getId());
        $lp_marks->setCompleted(!ilLPStatus::_hasUserCompleted($this->object->getId(), $this->user->getId()));
        $lp_marks->update();

        ilLPStatusWrapper::_updateStatus($this->obj_id, $this->user->getId());

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
        $this->ctrl->redirect($this, Capabilities::INFO_PAGE->value);
    }

Here is the call graph for this function:

unzipCurrentRevision()

ilObjFileGUI::unzipCurrentRevision

(

)

Definition at line 778 of file class.ilObjFileGUI.php.

References ILIAS\Repository\ctrl().

                                          : void
    {
        $this->ctrl->redirectToURL(
            (string) $this->capabilities->get(Capabilities::UNZIP)->getUri()
        );
    }

Here is the call graph for this function:

updateLearningProgress()

ilObjFileGUI::updateLearningProgress ( )

protected

Definition at line 142 of file class.ilObjFileGUI.php.

References ilLPStatusWrapper\_updateStatus(), ilLPObjSettings\LP_MODE_CONTENT_VISITED, null, ILIAS\Repository\object(), and ILIAS\Repository\user().

Referenced by getParentId(), and sendFile().

                                               : void
    {
        if ($this->object->getLPMode() === ilLPObjSettings::LP_MODE_CONTENT_VISITED) {
            ilLPStatusWrapper::_updateStatus(
                $this->object->getId(),
                $this->user->getId(),
                null,
                false,
                true
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

uploadFiles()

ilObjFileGUI::uploadFiles ( )

protected

MUST be protected, since this is Called from ilObject2GUI when used in Personal Workspace.

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

References ilObjectGUI\$data, ILIAS\Repository\ctrl(), ilObjectGUI\getCreationFormsHTML(), initUploadForm(), ILIAS\Repository\lng(), null, and ILIAS\Repository\ui().

                                    : void
    {
        $origin = ($this->request_wrapper->has(self::PARAM_UPLOAD_ORIGIN)) ?
            $this->request_wrapper->retrieve(
                self::PARAM_UPLOAD_ORIGIN,
                $this->refinery->kindlyTo()->string()
            ) : self::UPLOAD_ORIGIN_STANDARD;

        if (self::UPLOAD_ORIGIN_DROPZONE === $origin) {
            $dropzone = new ilObjFileUploadDropzone($this->parent_id);
            $dropzone = $dropzone->getDropzone()->withRequest($this->request);
            $data = $dropzone->getData();
        } else {
            $form = $this->initUploadForm()->withRequest($this->request);
            $data = $form->getData();
        }
        $files = $data[self::PARAM_FILES] ?? $data[0] ?? null;

        if (empty($files)) {
            $form = $this->initUploadForm()->withRequest($this->request);
            $this->tpl->setContent($this->getCreationFormsHTML($form));
            return;
        }

        $processor = new ilObjFileProcessor(
            $this->stakeholder,
            $this,
            $this->storage,
            $this->file_service_settings
        );

        $errors = false;
        foreach ($files as $file_data) {
            $rid = $this->storage->manage()->find($file_data[0]);
            if (null !== $rid) {
                try {
                    $processor->process(
                        $rid,
                        $file_data[1][self::PARAM_TITLE] ?? null,
                        $file_data[1][self::PARAM_DESCRIPTION] ?? null,
                        $data[self::PARAM_COPYRIGHT_ID] ?? null
                    );
                } catch (Throwable $t) {
                    $errors = true;
                    if (null !== $this->log) {
                        $this->log->error($t->getMessage() . ": " . $t->getTraceAsString());
                    }
                }
            }
        }

        if ($errors) {
            $this->ui->mainTemplate()->setOnScreenMessage(
                'failure',
                $this->lng->txt('could_not_create_file_objs'),
                true
            );
        }

        if ($processor->getInvalidFileNames() !== []) {
            $this->ui->mainTemplate()->setOnScreenMessage(
                'info',
                sprintf(
                    $this->lng->txt('file_upload_info_file_with_critical_extension'),
                    implode(', ', $processor->getInvalidFileNames())
                ),
                true
            );
        }

        $link = match ($this->id_type) {
            self::WORKSPACE_NODE_ID => $this->ctrl->getLinkTargetByClass(ilObjWorkspaceRootFolderGUI::class),
            default => ilLink::_getLink($this->requested_ref_id),
        };

        $this->ctrl->redirectToURL($link);
    }

Here is the call graph for this function:

versions()

ilObjFileGUI::versions

(

)

Definition at line 771 of file class.ilObjFileGUI.php.

References ILIAS\Repository\ctrl().

                              : void
    {
        $this->ctrl->redirectToURL(
            (string) $this->capabilities->get(Capabilities::MANAGE_VERSIONS)->getUri()
        );
    }

Here is the call graph for this function:

viewExternal()

ilObjFileGUI::viewExternal ( )

protected

Definition at line 791 of file class.ilObjFileGUI.php.

References ILIAS\Repository\ctrl().

                                     : void
    {
        $this->ctrl->redirectToURL(
            (string) $this->capabilities->get(Capabilities::VIEW_EXTERNAL)->getUri()
        );
    }

Here is the call graph for this function:

Field Documentation

$action_repo

ActionDBRepository ilObjFileGUI::$action_repo

private

Definition at line 94 of file class.ilObjFileGUI.php.

$capabilities

CapabilityCollection ilObjFileGUI::$capabilities

private

Definition at line 73 of file class.ilObjFileGUI.php.

$data_factory

Factory ilObjFileGUI::$data_factory

protected

Definition at line 93 of file class.ilObjFileGUI.php.

$file_service_settings

ilFileServicesSettings ilObjFileGUI::$file_service_settings

protected

Definition at line 88 of file class.ilObjFileGUI.php.

$general_settings

General ilObjFileGUI::$general_settings

protected

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

Referenced by getGeneralSettings().

$icon_repo

IconDatabaseRepository ilObjFileGUI::$icon_repo

protected

Definition at line 89 of file class.ilObjFileGUI.php.

$inputs

ILIAS UI Component Input Factory ilObjFileGUI::$inputs

protected

Definition at line 90 of file class.ilObjFileGUI.php.

Referenced by initPropertiesForm(), and initUploadForm().

$lng

ilLanguage ilObjFileGUI::$lng

Definition at line 79 of file class.ilObjFileGUI.php.

Referenced by getLanguage().

$log

ilLogger ilObjFileGUI::$log = null

protected

Definition at line 84 of file class.ilObjFileGUI.php.

$lom_services

LOMServices ilObjFileGUI::$lom_services

protected

Definition at line 95 of file class.ilObjFileGUI.php.

$obj_service

ilObjectService ilObjFileGUI::$obj_service

protected

Definition at line 85 of file class.ilObjFileGUI.php.

$object

ilObjFile null ilObjFileGUI::$object = null

Definition at line 78 of file class.ilObjFileGUI.php.

Referenced by getFileObj(), and getParentId().

$refinery

ILIAS Refinery Factory ilObjFileGUI::$refinery

protected

Definition at line 86 of file class.ilObjFileGUI.php.

Referenced by getRefinery(), and initPropertiesForm().

$renderer

Renderer ilObjFileGUI::$renderer

protected

Definition at line 91 of file class.ilObjFileGUI.php.

$request

ServerRequestInterface ilObjFileGUI::$request

protected

Definition at line 92 of file class.ilObjFileGUI.php.

$stakeholder

ResourceStakeholder ilObjFileGUI::$stakeholder

protected

Definition at line 82 of file class.ilObjFileGUI.php.

Referenced by getFileStakeholder().

$storage

Services ilObjFileGUI::$storage

protected

Definition at line 83 of file class.ilObjFileGUI.php.

$ui

UIServices ilObjFileGUI::$ui

protected

Definition at line 80 of file class.ilObjFileGUI.php.

$upload_handler

UploadHandler ilObjFileGUI::$upload_handler

protected

Definition at line 81 of file class.ilObjFileGUI.php.

CMD_EDIT

const ilObjFileGUI::CMD_EDIT = Capabilities::EDIT_SETTINGS->value

Definition at line 68 of file class.ilObjFileGUI.php.

CMD_SEND_FILE

const ilObjFileGUI::CMD_SEND_FILE = Capabilities::DOWNLOAD->value

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

CMD_UPLOAD_FILES

const ilObjFileGUI::CMD_UPLOAD_FILES = "uploadFiles"

Definition at line 70 of file class.ilObjFileGUI.php.

Referenced by ilObjFileUploadDropzone\isCopyrightSelectionActive().

CMD_VERSIONS

const ilObjFileGUI::CMD_VERSIONS = Capabilities::MANAGE_VERSIONS->value

Definition at line 69 of file class.ilObjFileGUI.php.

PARAM_COPYRIGHT_ID

const ilObjFileGUI::PARAM_COPYRIGHT_ID = "copyright_id"

Definition at line 62 of file class.ilObjFileGUI.php.

PARAM_DESCRIPTION

const ilObjFileGUI::PARAM_DESCRIPTION = 'description'

Definition at line 61 of file class.ilObjFileGUI.php.

Referenced by ilObjFileUploadDropzone\isCopyrightSelectionActive().

PARAM_FILES

const ilObjFileGUI::PARAM_FILES = 'files'

Definition at line 59 of file class.ilObjFileGUI.php.

PARAM_TITLE

const ilObjFileGUI::PARAM_TITLE = 'title'

Definition at line 60 of file class.ilObjFileGUI.php.

Referenced by ilObjFileUploadDropzone\isCopyrightSelectionActive().

PARAM_UPLOAD_ORIGIN

const ilObjFileGUI::PARAM_UPLOAD_ORIGIN = 'origin'

Definition at line 64 of file class.ilObjFileGUI.php.

Referenced by ilObjFileUploadDropzone\isCopyrightSelectionActive().

UPLOAD_MAX_FILES

const ilObjFileGUI::UPLOAD_MAX_FILES = 100

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

Referenced by ilObjFileUploadDropzone\isCopyrightSelectionActive().

UPLOAD_ORIGIN_DROPZONE

const ilObjFileGUI::UPLOAD_ORIGIN_DROPZONE = 'dropzone'

Definition at line 66 of file class.ilObjFileGUI.php.

Referenced by ilObjFileUploadDropzone\isCopyrightSelectionActive().

UPLOAD_ORIGIN_STANDARD

const ilObjFileGUI::UPLOAD_ORIGIN_STANDARD = 'standard'

Definition at line 65 of file class.ilObjFileGUI.php.

---

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

• components/ILIAS/File/classes/class.ilObjFileGUI.php