ilObjFileGUI Class Reference

GUI class for file objects. More...

Inheritance diagram for ilObjFileGUI:

Collaboration diagram for ilObjFileGUI:

Public Member Functions
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
	Constructor. More...
	getType ()
	executeCommand ()
	initSingleUploadForm ()
	FORM: Init single upload form. More...
	save ()
	save object More...
	saveAndMeta ()
	save object More...
	initZipUploadForm ($a_mode="create")
	FORM: Init zip upload form. More...
	saveUnzip ()
	saveUnzip object More...
	update ()
	updates object entry in object_data More...
	edit ()
	edit object More...
	sendFile ()
	versions ()
	infoScreen ()
	this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed More...
	infoScreenForward ()
	show information screen More...
	setTabs ()
	addLocatorItems ()
	initMultiUploadForm ()
	Initializes the upload form for multiple files. More...
	uploadFiles ()
	Called after a file was uploaded. More...
Public Member Functions inherited from ilObject2GUI
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
	Constructor. More...
	executeCommand ()
	execute command More...
	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 ($a_mode=true)
	getCreationMode ()
	prepareOutput ($a_show_subobjects=true)
	isVisible ($a_ref_id, $a_type)
	trash ()
	undelete ()
	cancelDelete ()
	removeFromSystem ()
	cloneAll ()
	view ()
	view object content (repository/workspace switch) More...
	getType ()
	Functions that must be overwritten. More...
	create ()
	Deleted in ilObject. More...
	save ()
	edit ()
	update ()
	cancel ()
	importFile ()
	Import. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...
	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
	cancelDeleteObject ()
	cancel deletion of object More...
	cancelObject ()
	cancel action and go back to previous page public More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	save object More...
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	edit object More...
	addExternalEditFormCustom (ilPropertyFormGUI $a_form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...
	addToDeskObject ()
	removeFromDeskObject ()

Static Public Member Functions
static	_goto ($a_target, $a_additional=null)
Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $a_obj, $a_callback_ref_id)
	After creation callback. More...
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Data Fields
const	CMD_EDIT = "edit"
const	CMD_VERSIONS = "versions"
	$object
	$lng
Data Fields inherited from ilObject2GUI
	$tree
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	COPY_WIZARD_NEEDS_PAGE = 1
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3

Protected Member Functions
	initCreationForms ($a_new_type)
	initPropertiesForm ($mode="create")
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
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 ()
	Get access handler. More...
	setLocator ()
	set Locator More...
	deleteConfirmedObjects ()
	Delete objects (workspace specific) More...
	setTitleAndDescription ()
	showUpperIcon ()
	omitLocator ($a_omit=true)
	getTargetFrame ($a_cmd, $a_target_frame="")
	setTargetFrame ($a_cmd, $a_target_frame)
	getCenterColumnHTML ()
	getRightColumnHTML ()
	setColumnSettings (ilColumnGUI $column_gui)
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	showPossibleSubObjects ()
	redirectToRefId ($a_ref_id, $a_cmd="")
	fillCloneTemplate ($a_tpl_varname, $a_type)
	fillCloneSearchTemplate ($a_tpl_varname, $a_type)
	searchCloneSource ()
	buildCloneSelect ($existing_objs)
	addAdminLocatorItems ($a_do_not_add_object=false)
	setTabs ()
	create tabs (repository/workspace switch) More...
	getReturnLocation ($a_cmd, $a_location="")
	Deprecated functions. More...
	setReturnLocation ($a_cmd, $a_location)
	showActions ()
	getTabs ()
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	addLocatorItems ()
	Functions to be overwritten. More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_node_id=null)
	Check permission. More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	redrawHeaderAction ()
	Updating icons after ajax call. More...
	getPermanentLinkWidget ($a_append=null, $a_center=false)
	handleAutoRating (ilObject $a_new_obj)
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...
	assignObject ()
	setTitleAndDescription ()
	called by prepare output More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	insertHeaderAction ($a_list_gui)
	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 public More...
	setAdminTabs ()
	set admin tabs public More...
	setLocator ()
	set Locator More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm ($a_new_type)
	Init object creation form. More...
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	Init object edit form. More...
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	Get values for edit form. More...
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm ($a_new_type)
	Init object import form. More...
	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...
	getTabs ()
	get tabs abstract method. More...
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...
	redirectToRefId ($a_ref_id, $a_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 $_GET["ref_id"] value More...
	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Protected Attributes
	$log = null
	$obj_service
Protected Attributes inherited from ilObject2GUI
	$object_id
	$node_id
	$creation_forms = array()
	$id_type = array()
	$parent_id
	$access_handler
Protected Attributes inherited from ilObjectGUI
	$ilErr
	$locator
	$user
	$access
	$rbacsystem
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service
	$favourites

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

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

int	$a_id
int	$a_id_type
int	$a_parent_node_id

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ilLoggerFactory\getLogger().

    {
        global $DIC;
        $this->lng = $DIC->language();
        $this->log = ilLoggerFactory::getLogger('file');
        parent::__construct($a_id, $a_id_type, $a_parent_node_id);
        $this->obj_service = $DIC->object();
        $this->lng->loadLanguageModule("file");
    }

Here is the call graph for this function:

Member Function Documentation

_goto()

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

static

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

References $_GET, $DIC, ilObjectGUI\$ilErr, $lng, ilObjectGUI\_gotoRepositoryNode(), ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), exit, and ilUtil\sendFailure().

    {
        global $DIC;
        $ilErr = $DIC['ilErr'];
        $lng = $DIC['lng'];
        $ilAccess = $DIC['ilAccess'];

        if ($a_additional && substr($a_additional, -3) == "wsp") {
            $_GET["baseClass"] = "ilsharedresourceGUI";
            $_GET["wsp_id"] = $a_target;
            include("ilias.php");
            exit;
        }

        // added support for direct download goto links
        if ($a_additional && substr($a_additional, -8) == "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, "infoScreen");
        } else {
            if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
                ilUtil::sendFailure(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:

addLocatorItems()

ilObjFileGUI::addLocatorItems

(

)

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

References $DIC, and ilObject2GUI\$node_id.

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

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

edit()

ilObjFileGUI::edit

(

)

edit object

public

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

References $DIC, ilObjectGUI\$ilErr, ilObject2GUI\checkPermissionBool(), and initPropertiesForm().

    {
        global $DIC;
        $ilTabs = $DIC['ilTabs'];
        $ilErr = $DIC['ilErr'];

        if (!$this->checkPermissionBool("write")) {
            $ilErr->raiseError($this->lng->txt("msg_no_perm_write"));
        }

        $ilTabs->activateTab("settings");

        $form = $this->initPropertiesForm(self::CMD_EDIT);

        $val = array();
        $val['title'] = $this->object->getTitle();
        $val['description'] = $this->object->getLongDescription();
        $val['rating'] = $this->object->hasRating();
        $form->setValuesByArray($val);

        // Edit ecs export settings
        include_once 'Modules/File/classes/class.ilECSFileSettings.php';
        $ecs = new ilECSFileSettings($this->object);
        $ecs->addSettingsToForm($form, 'file');

        $this->tpl->setContent($form->getHTML());

        return true;
    }

Here is the call graph for this function:

executeCommand()

ilObjFileGUI::executeCommand

(

)

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

References $_GET, $DIC, $ilCtrl, ilObjectGUI\$ilErr, $ilUser, $ret, ilObjectGUI\addHeaderAction(), ilObject2GUI\checkPermissionBool(), ilObject2GUI\getAccessHandler(), ilObject2GUI\getCreationMode(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), infoScreenForward(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, ilObject2GUI\prepareOutput(), and ilFileInputGUI\setPersonalWorkspaceQuotaCheck().

    {
        global $DIC;
        $ilNavigationHistory = $DIC['ilNavigationHistory'];
        $ilCtrl = $DIC['ilCtrl'];
        $ilUser = $DIC['ilUser'];
        $ilTabs = $DIC['ilTabs'];
        $ilAccess = $DIC['ilAccess'];
        $ilErr = $DIC['ilErr'];

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

        if ($this->id_type == self::WORKSPACE_NODE_ID) {
            ilFileInputGUI::setPersonalWorkspaceQuotaCheck(true);
        }

        if (!$this->getCreationMode()) {
            if ($this->id_type == self::REPOSITORY_NODE_ID
                && $this->checkPermissionBool("read")
            ) {
                $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $this->node_id);
                $link = $ilCtrl->getLinkTargetByClass("ilrepositorygui", "infoScreen");
                $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $_GET["ref_id"]);

                // add entry to navigation history
                $ilNavigationHistory->addItem(
                    $this->node_id,
                    $link,
                    "file"
                );
            }
        }

        $this->prepareOutput();

        switch ($next_class) {
            case "ilinfoscreengui":
                $this->infoScreenForward();    // forwards command
                break;

            case 'ilobjectmetadatagui':
                if (!$this->checkPermissionBool("write")) {
                    $ilErr->raiseError($this->lng->txt('permission_denied'), $ilErr->WARNING);
                }

                $ilTabs->activateTab("id_meta");

                $md_gui = new ilObjectMetaDataGUI($this->object);

                // todo: make this work
                // $md_gui->addMDObserver($this->object,'MDUpdateListener','Technical');

                $this->ctrl->forwardCommand($md_gui);
                break;

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

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

            case 'ilobjectcopygui':
                $cp = new ilObjectCopyGUI($this);
                $cp->setType('file');
                $this->ctrl->forwardCommand($cp);
                break;

            // personal workspace permissions
            case "ilworkspaceaccessgui":
                $ilTabs->activateTab("id_permissions");
                $wspacc = new ilWorkspaceAccessGUI($this->node_id, $this->getAccessHandler());
                $this->ctrl->forwardCommand($wspacc);
                break;

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

            case "illearningprogressgui":
                $ilTabs->activateTab('learning_progress');
                $new_gui = new ilLearningProgressGUI(
                    ilLearningProgressGUI::LP_CONTEXT_REPOSITORY,
                    $this->object->getRefId(),
                    $_GET['user_id'] ? $_GET['user_id'] : $ilUser->getId()
                );
                $this->ctrl->forwardCommand($new_gui);
                $this->tabs_gui->setTabActive('learning_progress');
                break;
            case strtolower(ilFileVersionsGUI::class):
                $this->tabs_gui->activateTab("id_versions");

                if (!$this->checkPermissionBool("write")) {
                    $this->ilErr->raiseError($this->lng->txt("permission_denied"), $this->ilErr->MESSAGE);
                }
                $this->ctrl->forwardCommand(new ilFileVersionsGUI($this->object));
                break;
            default:
                // in personal workspace use object2gui
                if ($this->id_type == self::WORKSPACE_NODE_ID) {
                    $this->addHeaderAction();

                    // coming from goto we need default command
                    if (empty($cmd)) {
                        $ilCtrl->setCmd("infoScreen");
                    }
                    $ilTabs->clearTargets();

                    return parent::executeCommand();
                }

                if (empty($cmd)) {
                    $cmd = "infoScreen";
                }

                $this->$cmd();
                break;
        }

        $this->addHeaderAction();
    }

Here is the call graph for this function:

getType()

ilObjFileGUI::getType

(

)

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

    {
        return "file";
    }

infoScreen()

ilObjFileGUI::infoScreen

(

)

this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed

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

References infoScreenForward().

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

Here is the call graph for this function:

infoScreenForward()

ilObjFileGUI::infoScreenForward

(

)

show information screen

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

References ilObject2GUI\$access_handler, $context, $DIC, ilObjectGUI\$ilErr, $preview, ilObjectGUI\$tpl, ilObjFileAccess\_getPermanentDownloadLink(), ilObjFile\_lookupFileSize(), ilObject2GUI\checkPermissionBool(), ilPreviewGUI\CONTEXT_REPOSITORY, ilPreviewGUI\CONTEXT_WORKSPACE, ilUtil\formatSize(), ilLinkButton\getInstance(), ilUserUtil\getNamePresentation(), ilObject2GUI\getPermanentLinkWidget(), and ilPreview\hasPreview().

Referenced by executeCommand(), and infoScreen().

    {
        global $DIC;
        $ilTabs = $DIC['ilTabs'];
        $ilErr = $DIC['ilErr'];
        $ilToolbar = $DIC['ilToolbar'];

        $ilTabs->activateTab("id_info");

        if (!$this->checkPermissionBool("visible") && !$this->checkPermissionBool("read")) {
            $ilErr->raiseError($this->lng->txt("msg_no_perm_read"));
        }

        include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
        $info = new ilInfoScreenGUI($this);

        if ($this->checkPermissionBool("read", "sendfile")) {
            // #14378
            include_once "Services/UIComponent/Button/classes/class.ilLinkButton.php";
            $button = ilLinkButton::getInstance();
            $button->setCaption("file_download");
            $button->setPrimary(true);

            // get permanent download link for repository
            if ($this->id_type == self::REPOSITORY_NODE_ID) {
                $button->setUrl(ilObjFileAccess::_getPermanentDownloadLink($this->node_id));
            } else {
                $button->setUrl($this->ctrl->getLinkTarget($this, "sendfile"));
            }

            $ilToolbar->addButtonInstance($button);
        }

        $info->enablePrivateNotes();

        if ($this->checkPermissionBool("read")) {
            $info->enableNews();
        }

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

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

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

        // File Info
        $info->addSection($this->lng->txt("file_info"));
        $info->addProperty($this->lng->txt("filename"), $this->secure($this->object->getFileName()));
        $info->addProperty($this->lng->txt("type"), $this->object->guessFileType());

        $info->addProperty($this->lng->txt("size"), ilUtil::formatSize(ilObjFile::_lookupFileSize($this->object->getId()), 'long'));
        $info->addProperty($this->lng->txt("version"), $this->object->getVersion());

        if ($this->object->getPageCount() > 0) {
            $info->addProperty($this->lng->txt("page_count"), $this->object->getPageCount());
        }

        // using getVersions function instead of ilHistory direct
        $uploader = $this->object->getVersions();
        $uploader = array_shift($uploader);
        $uploader = $uploader["user_id"];

        include_once "Services/User/classes/class.ilUserUtil.php";
        $info->addProperty($this->lng->txt("file_uploaded_by"), ilUserUtil::getNamePresentation($uploader));

        // download link added in repository
        if ($this->id_type == self::REPOSITORY_NODE_ID && $this->checkPermissionBool("read", "sendfile")) {
            $tpl = new ilTemplate("tpl.download_link.html", true, true, "Modules/File");
            $tpl->setVariable("LINK", ilObjFileAccess::_getPermanentDownloadLink($this->node_id));
            $info->addProperty($this->lng->txt("download_link"), $tpl->get());
        }

        if ($this->id_type == self::WORKSPACE_NODE_ID) {
            $info->addProperty($this->lng->txt("perma_link"), $this->getPermanentLinkWidget());
        }

        // display previews
        include_once("./Services/Preview/classes/class.ilPreview.php");
        if (!$this->ctrl->isAsynch()
            && ilPreview::hasPreview($this->object->getId(), $this->object->getType())
            && $this->checkPermissionBool("read")
        ) {
            include_once("./Services/Preview/classes/class.ilPreviewGUI.php");

            // get context for access checks later on
            $context;
            switch ($this->id_type) {
                case self::WORKSPACE_NODE_ID:
                case self::WORKSPACE_OBJECT_ID:
                    $context = ilPreviewGUI::CONTEXT_WORKSPACE;
                    break;

                default:
                    $context = ilPreviewGUI::CONTEXT_REPOSITORY;
                    break;
            }

            $preview = new ilPreviewGUI($this->node_id, $context, $this->object->getId(), $this->access_handler);
            $info->addProperty($this->lng->txt("preview"), $preview->getInlineHTML());
        }

        // forward the command
        // $this->ctrl->setCmd("showSummary");
        // $this->ctrl->setCmdClass("ilinfoscreengui");
        $this->ctrl->forwardCommand($info);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initCreationForms()

ilObjFileGUI::initCreationForms (   $a_new_type )

protected

Parameters

string

$a_new_type

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

References ilObject2GUI\fillCloneTemplate(), ilObjectGUI\initImportForm(), initMultiUploadForm(), initSingleUploadForm(), initZipUploadForm(), ilFileUploadSettings\isDragAndDropUploadEnabled(), ilDiskQuotaHandler\isUploadPossible(), and ilUtil\sendFailure().

    {
        $forms = array();

        if ($this->id_type == self::WORKSPACE_NODE_ID) {
            if (!ilDiskQuotaHandler::isUploadPossible()) {
                ilUtil::sendFailure($this->lng->txt("personal_resources_quota_exceeded_warning"), true);
                $this->ctrl->redirect($this, "cancel");
            }
        }

        // use drag-and-drop upload if configured
        if (ilFileUploadSettings::isDragAndDropUploadEnabled()) {
            $forms[] = $this->initMultiUploadForm();
        } else {
            $forms[] = $this->initSingleUploadForm();
            $forms[] = $this->initZipUploadForm();
        }

        // repository only
        if ($this->id_type != self::WORKSPACE_NODE_ID) {
            $forms[self::CFORM_IMPORT] = $this->initImportForm('file');
            $forms[self::CFORM_CLONE] = $this->fillCloneTemplate(null, "file");
        }

        return $forms;
    }

Here is the call graph for this function:

initHeaderAction()

ilObjFileGUI::initHeaderAction (   $a_sub_type = null,   $a_sub_id = null  )

protected

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

    {
        $lg = parent::initHeaderAction($a_sub_type, $a_sub_id);
        if (is_object($lg)) {
            if ($this->object->hasRating()) {
                $lg->enableRating(
                    true,
                    null,
                    false,
                    array("ilcommonactiondispatchergui", "ilratinggui")
                );
            }
        }

        return $lg;
    }

initMultiUploadForm()

ilObjFileGUI::initMultiUploadForm

(

)

Initializes the upload form for multiple files.

Returns

object The created property form.

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

References ilUtil\getImagePath(), ilObject2GUI\getTargetFrame(), and ilDragDropFileInputGUI\setArchiveSuffixes().

Referenced by initCreationForms(), and uploadFiles().

    {
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $dnd_form_gui = new ilPropertyFormGUI();
        $dnd_form_gui->setMultipart(true);
        $dnd_form_gui->setHideLabels();

        // file input
        include_once("Services/Form/classes/class.ilDragDropFileInputGUI.php");
        $dnd_input = new ilDragDropFileInputGUI($this->lng->txt("files"), "upload_files");
        $dnd_input->setArchiveSuffixes(array("zip"));
        $dnd_input->setCommandButtonNames("uploadFiles", "cancel");
        $dnd_form_gui->addItem($dnd_input);

        // add commands
        $dnd_form_gui->addCommandButton("uploadFiles", $this->lng->txt("upload_files"));
        $dnd_form_gui->addCommandButton("cancel", $this->lng->txt("cancel"));

        $dnd_form_gui->setTableWidth("100%");
        $dnd_form_gui->setTarget($this->getTargetFrame("save"));
        $dnd_form_gui->setTitle($this->lng->txt("upload_files_title"));
        $dnd_form_gui->setTitleIcon(ilUtil::getImagePath('icon_file.gif'), $this->lng->txt('obj_file'));

        $this->ctrl->setParameter($this, "new_type", "file");
        $dnd_form_gui->setFormAction($this->ctrl->getFormAction($this, "uploadFiles"));

        return $dnd_form_gui;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initPropertiesForm()

ilObjFileGUI::initPropertiesForm (   $mode = "create" )

protected

Parameters

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

References ilDiskQuotaHandler\isUploadPossible(), ilRadioOption\setInfo(), ilFormPropertyGUI\setInfo(), ilFormPropertyGUI\setRequired(), ilTextAreaInputGUI\setRows(), and ilNonEditableValueGUI\setValue().

Referenced by edit(), and update().

    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'update'));

        $form->setTitle($this->lng->txt('file_edit'));
        $form->addCommandButton('update', $this->lng->txt('save'));
        $form->addCommandButton('cancel', $this->lng->txt('cancel'));

        $title = new ilTextInputGUI($this->lng->txt('title'), 'title');
        $title->setValue($this->object->getTitle());
        $title->setInfo($this->lng->txt("if_no_title_then_filename"));
        $form->addItem($title);

        if ($mode === 'create') {
            $upload_possible = true;
            if ($this->id_type == self::WORKSPACE_NODE_ID) {
                $upload_possible = ilDiskQuotaHandler::isUploadPossible();
            }

            if ($upload_possible) {
                $file = new ilFileStandardDropzoneInputGUI(
                    'cancel',
                    $this->lng->txt('obj_file'),
                    'file'
                );
                $file->setRequired(false);
                $form->addItem($file);

                $group = new ilRadioGroupInputGUI('', 'replace');
                $group->setValue(0);

                $replace = new ilRadioOption($this->lng->txt('replace_file'), 1);
                $replace->setInfo($this->lng->txt('replace_file_info'));
                $group->addOption($replace);

                $keep = new ilRadioOption($this->lng->txt('file_new_version'), 0);
                $keep->setInfo($this->lng->txt('file_new_version_info'));
                $group->addOption($keep);

                $file->addSubItem($group);
            } elseif ($mode == 'create') {
                $file = new ilNonEditableValueGUI($this->lng->txt('obj_file'));
                $file->setValue($this->lng->txt("personal_resources_quota_exceeded_warning"));
                $form->addItem($file);
            }
        } else {
            $o = new ilNonEditableValueGUI($this->lng->txt('upload_info'));
            $o->setValue($this->lng->txt('upload_info_desc'));
            $form->addItem($o);
        }
        $desc = new ilTextAreaInputGUI($this->lng->txt('description'), 'description');
        $desc->setRows(3);
        $form->addItem($desc);

        if ($this->id_type == self::REPOSITORY_NODE_ID) {
            $this->lng->loadLanguageModule('rating');
            $rate = new ilCheckboxInputGUI($this->lng->txt('rating_activate_rating'), 'rating');
            $rate->setInfo($this->lng->txt('rating_activate_rating_info'));
            $form->addItem($rate);
        }

        $presentationHeader = new ilFormSectionHeaderGUI();
        $presentationHeader->setTitle($this->lng->txt('settings_presentation_header'));
        $form->addItem($presentationHeader);
        $this->obj_service->commonSettings()->legacyForm($form, $this->object)->addTileImage();

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initSingleUploadForm()

ilObjFileGUI::initSingleUploadForm

(

)

FORM: Init single upload form.

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

References $DIC, $lng, ilUtil\getImagePath(), ilObject2GUI\getTargetFrame(), ilFormPropertyGUI\setRequired(), and ilObject\TITLE_LENGTH.

Referenced by initCreationForms(), and save().

    {
        global $DIC;
        $lng = $DIC['lng'];

        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $single_form_gui = new ilPropertyFormGUI();
        $single_form_gui->setMultipart(true);

        // File Title
        $in_title = new ilTextInputGUI($lng->txt("title"), "title");
        $in_title->setInfo($this->lng->txt("if_no_title_then_filename"));
        $in_title->setSize(min(40, ilObject::TITLE_LENGTH));
        $in_title->setMaxLength(ilObject::TITLE_LENGTH);
        $single_form_gui->addItem($in_title);

        // File Description
        $in_descr = new ilTextAreaInputGUI($lng->txt("description"), "description");
        $single_form_gui->addItem($in_descr);

        // File
        $in_file = new ilFileInputGUI($lng->txt("file"), "upload_file");
        $in_file->setRequired(true);
        $single_form_gui->addItem($in_file);

        $single_form_gui->addCommandButton("save", $this->lng->txt($this->type . "_add"));
        $single_form_gui->addCommandButton("saveAndMeta", $this->lng->txt("file_add_and_metadata"));
        $single_form_gui->addCommandButton("cancel", $lng->txt("cancel"));

        $single_form_gui->setTableWidth("600px");
        $single_form_gui->setTarget($this->getTargetFrame("save"));
        $single_form_gui->setTitle($this->lng->txt($this->type . "_new"));
        $single_form_gui->setTitleIcon(ilUtil::getImagePath('icon_file.svg'), $this->lng->txt('obj_file'));

        $this->ctrl->setParameter($this, "new_type", "file");

        $single_form_gui->setFormAction($this->ctrl->getFormAction($this, "save"));

        return $single_form_gui;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initZipUploadForm()

ilObjFileGUI::initZipUploadForm

(

$a_mode = "create"

)

FORM: Init zip upload form.

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

References $DIC, $lng, ilUtil\getImagePath(), ilObject2GUI\getTargetFrame(), ilFormPropertyGUI\setInfo(), and ilFormPropertyGUI\setRequired().

Referenced by initCreationForms(), and saveUnzip().

    {
        global $DIC;
        $lng = $DIC['lng'];

        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $zip_form_gui = new ilPropertyFormGUI();
        $zip_form_gui->setMultipart(true);

        // File
        $in_file = new ilFileInputGUI($lng->txt("file"), "zip_file");
        $in_file->setRequired(true);
        $in_file->setSuffixes(array("zip"));
        $zip_form_gui->addItem($in_file);

        // Take over structure
        $in_str = new ilCheckboxInputGUI($this->lng->txt("take_over_structure"), "adopt_structure");
        $in_str->setInfo($this->lng->txt("take_over_structure_info"));
        $zip_form_gui->addItem($in_str);

        $zip_form_gui->addCommandButton("saveUnzip", $this->lng->txt($this->type . "_add"));
        $zip_form_gui->addCommandButton("cancel", $lng->txt("cancel"));

        $zip_form_gui->setTableWidth("600px");
        $zip_form_gui->setTarget($this->getTargetFrame("save"));
        $zip_form_gui->setTitle($this->lng->txt("header_zip"));
        $zip_form_gui->setTitleIcon(ilUtil::getImagePath('icon_file.svg'), $this->lng->txt('obj_file'));

        $this->ctrl->setParameter($this, "new_type", "file");

        $zip_form_gui->setFormAction($this->ctrl->getFormAction($this, "saveUnzip"));

        return $zip_form_gui;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilObjFileGUI::save

(

)

save object

public

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

References $DIC, $ilUser, $result, ilObjFileAccess\_getFileExtension(), ilChangeEvent\_recordWriteEvent(), ilObject2GUI\checkPermissionBool(), ilMimeTypeUtil\getMimeType(), ilObject2GUI\handleAutoRating(), initSingleUploadForm(), ilObject2GUI\putObjectInTree(), and ilUtil\redirect().

Referenced by saveAndMeta().

    {
        global $DIC;
        $ilUser = $DIC->user();

        if (!$this->checkPermissionBool("create", "", "file")) {
            $this->ilErr->raiseError($this->lng->txt("permission_denied"), $this->ilErr->MESSAGE);
        }

        $single_form_gui = $this->initSingleUploadForm();

        if ($single_form_gui->checkInput()) {
            $title = $single_form_gui->getInput("title");
            $description = $single_form_gui->getInput("description");
            $upload_file = $single_form_gui->getInput("upload_file");

            if (trim($title) == "") {
                $title = $upload_file["name"];
            } else {
                // BEGIN WebDAV: Ensure that object title ends with the filename extension
                $fileExtension = ilObjFileAccess::_getFileExtension($upload_file["name"]);
                $titleExtension = ilObjFileAccess::_getFileExtension($title);
                if ($titleExtension != $fileExtension && strlen($fileExtension) > 0) {
                    $title .= '.' . $fileExtension;
                }
                // END WebDAV: Ensure that object title ends with the filename extension
            }

            // create and insert file in grp_tree

            $fileObj = new ilObjFile();
            $fileObj->setTitle($title);
            $fileObj->setDescription($description);
            $fileObj->setFileName($upload_file["name"]);

            $fileObj->setFileType(ilMimeTypeUtil::getMimeType(
                "",
                $upload_file["name"],
                $upload_file["type"]
            ));
            $fileObj->setFileSize($upload_file["size"]);
            $this->object_id = $fileObj->create();

            $this->putObjectInTree($fileObj, $this->parent_id);

            // upload file to filesystem
            $fileObj->createDirectory();
            if ($result = $fileObj->getUploadFile($upload_file["tmp_name"], $upload_file["name"])) {
                $fileObj->setFileName($result->getName());
            }

            $this->handleAutoRating($fileObj);

            // BEGIN ChangeEvent: Record write event.
            ilChangeEvent::_recordWriteEvent($fileObj->getId(), $ilUser->getId(), 'create');
            // END ChangeEvent: Record write event.

            ilUtil::sendSuccess($this->lng->txt("file_added"), true);

            if ($this->ctrl->getCmd() == "saveAndMeta") {
                $this->ctrl->setParameter($this, "new_type", "");
                $target = $this->ctrl->getLinkTargetByClass(array("ilobjectmetadatagui", "ilmdeditorgui"), "listSection", "", false, false);
                ilUtil::redirect($target);
            } else {
                $this->ctrl->returnToParent($this);
            }
        } else {
            $single_form_gui->setValuesByPost();
            $this->tpl->setContent($single_form_gui->getHTML());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveAndMeta()

ilObjFileGUI::saveAndMeta

(

)

save object

public

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

References save().

    {
        $this->save();
    }

Here is the call graph for this function:

saveUnzip()

ilObjFileGUI::saveUnzip

(

)

saveUnzip object

public

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

References ilObject2GUI\$access_handler, Vendor\Package\$e, ilObject2GUI\$tree, $type, ilObject\_lookupType(), ilObject2GUI\checkPermissionBool(), ilUtil\delDir(), ilObject2GUI\getAccessHandler(), ilUtil\ilTempnam(), initZipUploadForm(), ilUtil\makeDir(), ilFileUtils\processZipFile(), and ilUtil\sendFailure().

    {
        $zip_form_gui = $this->initZipUploadForm();

        if ($this->checkPermissionBool("create", "", "file")) {
            if ($zip_form_gui->checkInput()) {
                $zip_file = $zip_form_gui->getInput("zip_file");
                $adopt_structure = $zip_form_gui->getInput("adopt_structure");

                include_once("Services/Utilities/classes/class.ilFileUtils.php");

                // Create unzip-directory
                $newDir = ilUtil::ilTempnam();
                ilUtil::makeDir($newDir);

                // Check if permission is granted for creation of object, if necessary
                if ($this->id_type != self::WORKSPACE_NODE_ID) {
                    $type = ilObject::_lookupType((int) $this->parent_id, true);
                } else {
                    $type = ilObject::_lookupType($this->tree->lookupObjectId($this->parent_id), false);
                }

                $tree = $access_handler = null;
                switch ($type) {
                    // workspace structure
                    case 'wfld':
                    case 'wsrt':
                        $permission = $this->checkPermissionBool("create", "", "wfld");
                        $containerType = "WorkspaceFolder";
                        $tree = $this->tree;
                        $access_handler = $this->getAccessHandler();
                        break;

                    // use categories as structure
                    case 'cat':
                    case 'root':
                        $permission = $this->checkPermissionBool("create", "", "cat");
                        $containerType = "Category";
                        break;

                    // use folders as structure (in courses)
                    default:
                        $permission = $this->checkPermissionBool("create", "", "fold");
                        $containerType = "Folder";
                        break;
                }
                //      processZipFile (
                //              Dir to unzip,
                //              Path to uploaded file,
                //              should a structure be created (+ permission check)?
                //              ref_id of parent
                //              object that contains files (folder or category)
                //              should sendInfo be persistent?)
                try {
                    $processDone = ilFileUtils::processZipFile(
                        $newDir,
                        $zip_file["tmp_name"],
                        ($adopt_structure && $permission),
                        $this->parent_id,
                        $containerType,
                        $tree,
                        $access_handler
                    );
                    ilUtil::sendSuccess($this->lng->txt("file_added"), true);
                } catch (ilFileUtilsException $e) {
                    ilUtil::sendFailure($e->getMessage(), true);
                }

                ilUtil::delDir($newDir);
                $this->ctrl->returnToParent($this);
            } else {
                $zip_form_gui->setValuesByPost();
                $this->tpl->setContent($zip_form_gui->getHTML());
            }
        } else {
            $this->ilErr->raiseError($this->lng->txt("permission_denied"), $this->ilErr->MESSAGE);
        }
    }

Here is the call graph for this function:

sendFile()

ilObjFileGUI::sendFile

(

)

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

References $_GET, $DIC, Vendor\Package\$e, ilChangeEvent\_recordReadEvent(), ilLPStatusWrapper\_updateStatus(), and ilObject2GUI\checkPermissionBool().

    {
        global $DIC;

        try {
            if (ANONYMOUS_USER_ID == $DIC->user()->getId() && isset($_GET['transaction'])) {
                $a_hist_entry_id = isset($_GET["hist_id"]) ? $_GET["hist_id"] : null;
                $this->object->sendFile($a_hist_entry_id);
            }

            if ($this->checkPermissionBool("read")) {
                // BEGIN ChangeEvent: Record read event.
                require_once('Services/Tracking/classes/class.ilChangeEvent.php');

                // Record read event and catchup with write events
                ilChangeEvent::_recordReadEvent(
                    $this->object->getType(),
                    $this->object->getRefId(),
                    $this->object->getId(),
                    $DIC->user()->getId()
                );
                // END ChangeEvent: Record read event.

                require_once 'Services/Tracking/classes/class.ilLPStatusWrapper.php';
                ilLPStatusWrapper::_updateStatus($this->object->getId(), $DIC->user()->getId());

                $a_hist_entry_id = isset($_GET["hist_id"]) ? $_GET["hist_id"] : null;
                $this->object->sendFile($a_hist_entry_id);
            } else {
                $this->ilErr->raiseError($this->lng->txt("permission_denied"), $this->ilErr->MESSAGE);
            }
        } catch (\ILIAS\Filesystem\Exception\FileNotFoundException $e) {
            $this->ilErr->raiseError($e->getMessage(), $this->ilErr->MESSAGE);
        }

        return true;
    }

Here is the call graph for this function:

setTabs()

ilObjFileGUI::setTabs

(

)

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

References $DIC, $lng, ilLearningProgressAccess\checkAccess(), ilObject2GUI\checkPermissionBool(), and ilFileVersionsGUI\CMD_DEFAULT.

    {
        global $DIC;
        $ilTabs = $DIC['ilTabs'];
        $lng = $DIC['lng'];
        $ilHelp = $DIC['ilHelp'];

        $ilHelp->setScreenIdComponent("file");

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

        if ($this->checkPermissionBool("write")) {
            $ilTabs->addTab(
                "id_versions",
                $lng->txt(self::CMD_VERSIONS),
                $this->ctrl->getLinkTargetByClass(ilFileVersionsGUI::class, ilFileVersionsGUI::CMD_DEFAULT)
            );
        }

        if ($this->checkPermissionBool("visible") || $this->checkPermissionBool("read")) {
            $ilTabs->addTab(
                "id_info",
                $lng->txt("info_short"),
                $this->ctrl->getLinkTargetByClass(array("ilobjfilegui", "ilinfoscreengui"), "showSummary")
            );
        }

        if ($this->checkPermissionBool("write")) {
            $ilTabs->addTab(
                "settings",
                $lng->txt("settings"),
                $this->ctrl->getLinkTarget($this, self::CMD_EDIT)
            );
        }

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

        // meta data
        if ($this->checkPermissionBool("write")) {
            $mdgui = new ilObjectMetaDataGUI($this->object);
            $mdtab = $mdgui->getTab();
            if ($mdtab) {
                $ilTabs->addTab(
                    "id_meta",
                    $lng->txt("meta_data"),
                    $mdtab
                );
            }
        }

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

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

Here is the call graph for this function:

update()

ilObjFileGUI::update

(

)

updates object entry in object_data

public

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

References ilObjectGUI\$data, $DIC, $filename, $ilUser, ilChangeEvent\_catchupWriteEvents(), ilChangeEvent\_recordWriteEvent(), initPropertiesForm(), and ilUtil\redirect().

    {
        global $DIC;
        $ilTabs = $DIC['ilTabs'];

        $form = $this->initPropertiesForm();
        if (!$form->checkInput()) {
            $ilTabs->activateTab("settings");
            $form->setValuesByPost();
            $this->tpl->setContent($form->getHTML());

            return false;
        }

        $title = $form->getInput('title');
        // bugfix mantis 26045:
        $filename = empty($data["name"]) ? $this->object->getFileName() : $data["name"];
        if (strlen(trim($title)) == 0) {
            $title = $filename;
        } else {
            $title = $this->object->checkFileExtension($filename, $title);
        }
        $this->object->setTitle($title);
        $this->object->setDescription($form->getInput('description'));
        $this->object->setRating($form->getInput('rating'));

        $this->update = $this->object->update();
        $this->obj_service->commonSettings()->legacyForm($form, $this->object)->saveTileImage();

        // BEGIN ChangeEvent: Record update event.
        if (!empty($data["name"])) {
            global $DIC;
            $ilUser = $DIC['ilUser'];
            ilChangeEvent::_recordWriteEvent($this->object->getId(), $ilUser->getId(), 'update');
            ilChangeEvent::_catchupWriteEvents($this->object->getId(), $ilUser->getId());
        }
        // END ChangeEvent: Record update event.

        // Update ecs export settings
        $ecs = new ilECSFileSettings($this->object);
        $ecs->handleSettingsUpdate();

        ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"), true);
        ilUtil::redirect($this->ctrl->getLinkTarget($this, self::CMD_EDIT, '', false, false));
    }

Here is the call graph for this function:

uploadFiles()

ilObjFileGUI::uploadFiles

(

)

Called after a file was uploaded.

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

References $_POST, ilObject2GUI\$access_handler, $DIC, Vendor\Package\$e, $filename, $ilUser, $object, $response, $result, $size, ilObject2GUI\$tree, $type, ilObject\_lookupType(), ilChangeEvent\_recordWriteEvent(), ilObject2GUI\checkPermissionBool(), ilUtil\delDir(), exit, ilObject2GUI\getAccessHandler(), ilFileUtils\getNewObjects(), ilObject2GUI\handleAfterSaveCallback(), ilObject2GUI\handleAutoRating(), ilFileUtils\hasValidExtension(), ilUtil\ilTempnam(), initMultiUploadForm(), ilUtil\makeDir(), ilFileUtils\processZipFile(), ilObject2GUI\putObjectInTree(), ilUtil\sendInfo(), and ilUtil\stripSlashes().

    {
        global $DIC;

        include_once("./Services/JSON/classes/class.ilJsonUtil.php");

        $response = new stdClass();
        $response->error = null;
        $response->debug = null;

        $files = $_FILES;

        // #14249 - race conditions because of concurrent uploads
        $after_creation_callback = (int) $_REQUEST["crtcb"];
        if ($after_creation_callback) {
            $this->after_creation_callback_objects = array();
            unset($_REQUEST["crtcb"]);
        }

        // load form
        $dnd_form_gui = $this->initMultiUploadForm();
        if ($dnd_form_gui->checkInput()) {
            try {
                if (!$this->checkPermissionBool("create", "", "file")) {
                    $response->error = $this->lng->txt("permission_denied");
                } else {
                    // handle the file
                    $inp = $dnd_form_gui->getInput("upload_files");
                    $this->log->debug("ilObjFileGUI::uploadFiles " . print_r($_POST, true));
                    $this->log->debug("ilObjFileGUI::uploadFiles " . print_r($_FILES, true));
                    $fileresult = $this->handleFileUpload($inp);
                    if ($fileresult) {
                        $response = (object) array_merge((array) $response, (array) $fileresult);
                    }
                }
            } catch (Exception $ex) {
                $response->error = $this->lng->txt('general_upload_error_occured');
            }
        } else {
            $dnd_input = $dnd_form_gui->getItemByPostVar("upload_files");
            $response->error = $dnd_input->getAlert();
        }

        if ($after_creation_callback
            && sizeof($this->after_creation_callback_objects)
        ) {
            foreach ($this->after_creation_callback_objects as $new_file_obj) {
                ilObject2GUI::handleAfterSaveCallback($new_file_obj, $after_creation_callback);
            }
            unset($this->after_creation_callback_objects);
        }

        // send response object (don't use 'application/json' as IE wants to download it!)
        header('Vary: Accept');
        header('Content-type: text/plain');

        if ($DIC->upload()->hasBeenProcessed()) {
            foreach ($DIC->upload()->getResults() as $result) {
                if (!ilFileUtils::hasValidExtension($result->getName()) && $result->getStatus()->getCode() == ProcessingStatus::OK) {
                    ilUtil::sendInfo(
                        $this->lng->txt('file_upload_info_file_with_critical_extension'),
                        true
                    );
                }
            }
        }
        echo json_encode($response);
        // no further processing!
        exit;
    }

Here is the call graph for this function:

versions()

ilObjFileGUI::versions

(

)

Deprecated:

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

    {
        $this->ctrl->redirectByClass(ilFileVersionsGUI::class);
    }

Field Documentation

$lng

ilObjFileGUI::$lng

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

Referenced by _goto(), initSingleUploadForm(), initZipUploadForm(), and setTabs().

$log

ilObjFileGUI::$log = null

protected

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

$obj_service

ilObjFileGUI::$obj_service

protected

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

$object

ilObjFileGUI::$object

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

Referenced by uploadFiles().

CMD_EDIT

const ilObjFileGUI::CMD_EDIT = "edit"

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

CMD_VERSIONS

const ilObjFileGUI::CMD_VERSIONS = "versions"

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

---

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

• Modules/File/classes/class.ilObjFileGUI.php