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 ()
	file versions/history More...
	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...
	deleteVersions ()
	Displays a confirmation screen with selected file versions that should be deleted. More...
	confirmDeleteVersions ()
	Deletes the file versions that were confirmed by the user. More...
	cancelDeleteVersions ()
	Cancels the file version deletion. More...
	confirmDeleteFile ()
	Deletes this file object. More...
	cancelDeleteFile ()
	Cancels the file deletion. More...
	compareHistoryIds ($v1, $v2)
	Compares two versions either by passing a history entry or an id. More...
	rollbackVersion ()
	Performs a rollback with the selected file version. 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 ()
	list childs of current object More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...

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
	$object
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 ()
	handleFileUpload ($file_upload)
	Handles the upload of a single file and adds it to the parent object. More...
	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...
	deleteConfirmation ()
	Display delete confirmation form (workspace specific) 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
	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...
	showMountWebfolderIcon ()
	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
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
	$settings
	$rbacreview
	$toolbar
	$rbacsystem
	$tmp_import_dir
	$tabs_gui = null
	$ctrl

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

Definition at line 17 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 34 of file class.ilObjFileGUI.php.

References ilLoggerFactory\getLogger().

    {
        $this->log = ilLoggerFactory::getLogger('file');
        parent::__construct($a_id, $a_id_type, $a_parent_node_id);
    }

Here is the call graph for this function:

Member Function Documentation

_goto()

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

static

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

References $_GET, $DIC, ilObjectGUI\$ilErr, ilObjectGUI\$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 963 of file class.ilObjFileGUI.php.

References $DIC, ilObject2GUI\$node_id, and object.

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

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

cancelDeleteFile()

ilObjFileGUI::cancelDeleteFile

(

)

Cancels the file deletion.

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

    {
        $this->ctrl->redirect($this, "versions");
    }

cancelDeleteVersions()

ilObjFileGUI::cancelDeleteVersions

(

)

Cancels the file version deletion.

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

    {
        $this->ctrl->redirect($this, "versions");
    }

compareHistoryIds()

ilObjFileGUI::compareHistoryIds	(		$v1,
			$v2
	)

Compares two versions either by passing a history entry or an id.

Parameters

$v1	The first version to compare.
$v2	The second version to compare.

Returns

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

    {
        if (is_array($v1)) {
            $v1 = (int) $v1["hist_entry_id"];
        } else {
            if (!is_int($v1)) {
                $v1 = (int) $v1;
            }
        }

        if (is_array($v2)) {
            $v2 = (int) $v2["hist_entry_id"];
        } else {
            if (!is_int($v2)) {
                $v2 = (int) $v2;
            }
        }

        return $v1 - $v2;
    }

confirmDeleteFile()

ilObjFileGUI::confirmDeleteFile

(

)

Deletes this file object.

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

References array, and ilObject2GUI\checkPermissionBool().

    {
        // has the user the rights to delete the file?
        if (!$this->checkPermissionBool("write")) {
            $this->ilErr->raiseError($this->lng->txt("permission_denied"), $this->ilErr->MESSAGE);
        }

        // delete this file object
        include_once("./Services/Repository/classes/class.ilRepUtilGUI.php");
        $ru = new ilRepUtilGUI($this);
        $ru->deleteObjects($this->parent_id, array($this->ref_id));

        // redirect to parent object
        $this->ctrl->setParameterByClass("ilrepositorygui", "ref_id", $this->parent_id);
        $this->ctrl->redirectByClass("ilrepositorygui");
    }

Here is the call graph for this function:

confirmDeleteVersions()

ilObjFileGUI::confirmDeleteVersions

(

)

Deletes the file versions that were confirmed by the user.

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

References $_POST, $DIC, ilObject2GUI\checkPermissionBool(), and ilUtil\sendSuccess().

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

        // has the user the rights to delete versions?
        if (!$this->checkPermissionBool("write")) {
            $this->ilErr->raiseError($this->lng->txt("permission_denied"), $this->ilErr->MESSAGE);
        }

        // delete versions after confirmation
        if (count($_POST["hist_id"]) > 0) {
            $this->object->deleteVersions($_POST["hist_id"]);
            ilUtil::sendSuccess($this->lng->txt("file_versions_deleted"), true);
        }

        $this->ctrl->setParameter($this, "hist_id", "");
        $this->ctrl->redirect($this, "versions");
    }

Here is the call graph for this function:

deleteVersions()

ilObjFileGUI::deleteVersions

(

)

Displays a confirmation screen with selected file versions that should be deleted.

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

References $DIC, $html, $table, ilObject\_getIcon(), array, object, ilUtil\sendFailure(), and ilUtil\sendQuestion().

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

        // get ids either from GET (if single item was clicked) or
        // from POST (if multiple items were selected)
        $request = $DIC->http()->request();

        $version_ids = [];
        if (isset($request->getQueryParams()['hist_id'])) {
            $version_ids = [$request->getQueryParams()['hist_id']];
        } elseif (isset($request->getParsedBody()['hist_id'])) {
            $version_ids = (array) $request->getParsedBody()['hist_id'];
        }

        if (count($version_ids) < 1) {
            ilUtil::sendFailure($this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "versions");
        } else {
            $ilTabs->activateTab("id_versions");

            // check if all versions are selected
            $versionsToKeep = array_udiff($this->object->getVersions(), $version_ids, array($this, "compareHistoryIds"));
            if (count($versionsToKeep) < 1) {
                // set our message
                ilUtil::sendQuestion($this->lng->txt("file_confirm_delete_all_versions"));

                // show confirmation gui
                include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
                $conf_gui = new ilConfirmationGUI();
                $conf_gui->setFormAction($this->ctrl->getFormAction($this, "versions"));
                $conf_gui->setCancel($this->lng->txt("cancel"), "cancelDeleteFile");
                $conf_gui->setConfirm($this->lng->txt("confirm"), "confirmDeleteFile");

                $conf_gui->addItem(
                    "id[]",
                    $this->ref_id,
                    $this->object->getTitle(),
                    ilObject::_getIcon($this->object->getId(), "small", $this->object->getType()),
                    $this->lng->txt("icon") . " " . $this->lng->txt("obj_" . $this->object->getType())
                );

                $html = $conf_gui->getHTML();
            } else {
                include_once("./Modules/File/classes/class.ilFileVersionTableGUI.php");

                ilUtil::sendQuestion($this->lng->txt("file_confirm_delete_versions"));
                $versions = $this->object->getVersions($version_ids);

                $table = new ilFileVersionTableGUI($this, 'versions', true);
                $table->setMaxCount(sizeof($versions));
                $table->setData($versions);

                $html = $table->getHTML();
            }

            $this->tpl->setVariable('ADM_CONTENT', $html);
        }
    }

Here is the call graph for this function:

edit()

ilObjFileGUI::edit

(

)

edit object

public

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

References $DIC, $form, ilObjectGUI\$ilErr, array, 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();

        $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 47 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, object, 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;

            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 41 of file class.ilObjFileGUI.php.

    {
        return "file";
    }

handleFileUpload()

ilObjFileGUI::handleFileUpload (   $file_upload )

protected

Handles the upload of a single file and adds it to the parent object.

Parameters

array

$file_upload

An array containing the file upload parameters.

Returns

object The response object.

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

References ilObject2GUI\$access_handler, $description, $DIC, $filename, $ilUser, $object, $response, $result, $size, $title, ilObject2GUI\$tree, $type, ilObjFileAccess\_getFileExtension(), ilObject\_lookupType(), ilChangeEvent\_recordWriteEvent(), ilObject2GUI\checkPermissionBool(), ilUtil\delDir(), ilObject2GUI\getAccessHandler(), ilMimeTypeUtil\getMimeType(), ilFileUtils\getNewObjects(), ilObject2GUI\handleAutoRating(), ilUtil\ilTempnam(), ilUtil\makeDir(), ilFileUtils\processZipFile(), ilObject2GUI\putObjectInTree(), and ilUtil\stripSlashes().

Referenced by uploadFiles().

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

        // file upload params
        $filename = ilUtil::stripSlashes($file_upload["name"]);
        $type = ilUtil::stripSlashes($file_upload["type"]);
        $size = ilUtil::stripSlashes($file_upload["size"]);
        $temp_name = $file_upload["tmp_name"];

        // additional params
        $title = ilUtil::stripSlashes($file_upload["title"]);
        $description = ilUtil::stripSlashes($file_upload["description"]);
        $extract = ilUtil::stripSlashes($file_upload["extract"]);
        $keep_structure = ilUtil::stripSlashes($file_upload["keep_structure"]);

        // create answer object
        $response = new stdClass();
        $response->fileName = $filename;
        $response->fileSize = intval($size);
        $response->fileType = $type;
        $response->fileUnzipped = $extract;
        $response->error = null;

        // extract archive?
        if ($extract) {
            $zip_file = $filename;
            $adopt_structure = $keep_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;
            }

            try {
                //      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?)
                ilFileUtils::processZipFile(
                    $newDir,
                    $temp_name,
                    ($adopt_structure && $permission),
                    $this->parent_id,
                    $containerType,
                    $tree,
                    $access_handler
                );
            } catch (ilFileUtilsException $e) {
                $response->error = $e->getMessage();
            } catch (Exception $ex) {
                $response->error = $ex->getMessage();
            }

            ilUtil::delDir($newDir);

            // #15404
            if ($this->id_type != self::WORKSPACE_NODE_ID) {
                foreach (ilFileUtils::getNewObjects() as $parent_ref_id => $objects) {
                    if ($parent_ref_id != $this->parent_id) {
                        continue;
                    }

                    foreach ($objects as $object) {
                        $this->after_creation_callback_objects[] = $object;
                    }
                }
            }
        } else {
            if (trim($title) == "") {
                $title = $filename;
            } else {
                // BEGIN WebDAV: Ensure that object title ends with the filename extension
                $fileExtension = ilObjFileAccess::_getFileExtension($filename);
                $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($filename);

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

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

            // see uploadFiles()
            if (is_array($this->after_creation_callback_objects)) {
                $this->after_creation_callback_objects[] = $fileObj;
            }

            // upload file to filesystem
            $fileObj->createDirectory();
            $fileObj->raiseUploadError(false);
            $result = $fileObj->getUploadFile($temp_name, $filename);
            if ($result) {
                //if no title for the file was set use the filename as title
                if (empty($fileObj->getTitle())) {
                    $fileObj->setTitle($result->getName());
                }
                $fileObj->setFileName($result->getName());
            }
            $fileObj->update();
            $this->handleAutoRating($fileObj);

            ilChangeEvent::_recordWriteEvent($fileObj->getId(), $ilUser->getId(), 'create');
        }

        return $response;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

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 716 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 727 of file class.ilObjFileGUI.php.

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

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")) {
            // #9876
            $this->lng->loadLanguageModule("file");

            // #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->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"];

        $this->lng->loadLanguageModule("file");
        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 175 of file class.ilObjFileGUI.php.

References array, 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()) {
                $this->lng->loadLanguageModule("file");
                ilUtil::sendFailure($this->lng->txt("personal_workspace_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 1431 of file class.ilObjFileGUI.php.

References $lg, array, and object.

    {
        $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 979 of file class.ilObjFileGUI.php.

References array, 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 ( )

protected

Parameters

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

References $file, $form, $title, ilDiskQuotaHandler\isUploadPossible(), object, ilRadioOption\setInfo(), ilFormPropertyGUI\setInfo(), and ilTextAreaInputGUI\setRows().

Referenced by edit(), and update().

    {
        include_once('./Services/Form/classes/class.ilPropertyFormGUI.php');

        $this->lng->loadLanguageModule('file');

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

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

        if ($upload_possible) {
            $file = new ilFileStandardDropzoneInputGUI($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);
        } else {
            $file = new ilNonEditableValueGUI($this->lng->txt('obj_file'));
            $file->setValue($this->lng->txt("personal_workspace_quota_exceeded_warning"));
            $form->addItem($file);
        }

        $desc = new ilTextAreaInputGUI($this->lng->txt('description'), 'description');
        $desc->setRows(3);
        #$desc->setCols(40);
        $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);
        }

        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 208 of file class.ilObjFileGUI.php.

References $DIC, ilObjectGUI\$lng, ilUtil\getImagePath(), ilObject2GUI\getTargetFrame(), ilFormPropertyGUI\setInfo(), 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 342 of file class.ilObjFileGUI.php.

References $DIC, ilObjectGUI\$lng, array, 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:

rollbackVersion()

ilObjFileGUI::rollbackVersion

(

)

Performs a rollback with the selected file version.

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

References $_GET, $_POST, $DIC, array, ilObject2GUI\checkPermissionBool(), ilUtil\sendInfo(), and ilUtil\sendSuccess().

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

        // has the user the rights to delete the file?
        if (!$this->checkPermissionBool("write")) {
            $this->ilErr->raiseError($this->lng->txt("permission_denied"), $this->ilErr->MESSAGE);
        }

        // get ids either from GET (if single item was clicked) or
        // from POST (if multiple items were selected)
        $version_ids = isset($_GET["hist_id"]) ? array($_GET["hist_id"]) : $_POST["hist_id"];

        // more than one entry selected?
        if (count($version_ids) != 1) {
            ilUtil::sendInfo($this->lng->txt("file_rollback_select_exact_one"), true);
            $this->ctrl->redirect($this, "versions");
        }

        // rollback the version
        $new_version = $this->object->rollback($version_ids[0]);

        ilUtil::sendSuccess(sprintf($this->lng->txt("file_rollback_done"), $new_version["rollback_version"]), true);
        $this->ctrl->redirect($this, "versions");
    }

Here is the call graph for this function:

save()

ilObjFileGUI::save

(

)

save object

public

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

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

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 333 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 383 of file class.ilObjFileGUI.php.

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

    {
        $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 643 of file class.ilObjFileGUI.php.

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

    {
        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 849 of file class.ilObjFileGUI.php.

References $DIC, ilObjectGUI\$lng, array, ilLearningProgressAccess\checkAccess(), ilObject2GUI\checkPermissionBool(), and object.

    {
        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("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("edit"),
                $this->ctrl->getLinkTarget($this, "edit")
            );
        }

        if ($this->checkPermissionBool("write")) {
            $ilTabs->addTab(
                "id_versions",
                $lng->txt("versions"),
                $this->ctrl->getLinkTarget($this, "versions")
            );
        }

        require_once 'Services/Tracking/classes/class.ilLearningProgressAccess.php';
        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")) {
            include_once "Services/Object/classes/class.ilObjectMetaDataGUI.php";
            $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 468 of file class.ilObjFileGUI.php.

References ilObjectGUI\$data, $DIC, $filename, $form, $ilUser, $result, $title, ilChangeEvent\_catchupWriteEvents(), ilChangeEvent\_recordWriteEvent(), initPropertiesForm(), object, ilUtil\redirect(), and ilUtil\sendSuccess().

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

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

            return false;
        }

        $data = $form->getInput('file');

        // delete trailing '/' in filename
        $data["name"] = rtrim($data["name"], '/');

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

        if (!empty($data["name"])) {
            $result = null;
            switch ($form->getInput('replace')) {
                case 1:
                    $this->object->deleteVersions();
                    $this->object->clearDataDirectory();
                    $result = $this->object->replaceFile($data['tmp_name'], $data['name']);
                    break;
                case 0:
                    $result = $this->object->addFileVersion($data['tmp_name'], $data['name']);
                    break;
            }
            if ($result) {
                $this->object->setFileType($result->getMimeType());
                $this->object->setFileSize($result->getSize());
                $this->object->setFilename($result->getName());
            }
        }

        $this->object->setDescription($form->getInput('description'));
        $this->object->setRating($form->getInput('rating'));

        $this->update = $this->object->update();

        // BEGIN ChangeEvent: Record update event.
        if (!empty($data["name"])) {
            require_once('Services/Tracking/classes/class.ilChangeEvent.php');
            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
        include_once 'Modules/File/classes/class.ilECSFileSettings.php';
        $ecs = new ilECSFileSettings($this->object);
        $ecs->handleSettingsUpdate();

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

Here is the call graph for this function:

uploadFiles()

ilObjFileGUI::uploadFiles

(

)

Called after a file was uploaded.

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

References $_POST, $DIC, $files, $response, $result, array, ilObject2GUI\checkPermissionBool(), exit, ilObject2GUI\handleAfterSaveCallback(), handleFileUpload(), ilFileUtils\hasValidExtension(), header, initMultiUploadForm(), object, and ilUtil\sendInfo().

    {
        global $DIC;

        $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 = $ex->getMessage();
            }
        } 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');

        foreach ($DIC->upload()->getResults() as $result) {
            if (!ilFileUtils::hasValidExtension($result->getName())) {
                $this->lng->loadLanguageModule('file');
                ilUtil::sendInfo($this->lng->txt('file_upload_info_file_with_critical_unknown_extension_later_renamed_when_downloading'), true);
            }
        }
        echo json_encode($response);
        // no further processing!
        exit;
    }

Here is the call graph for this function:

versions()

ilObjFileGUI::versions

(

)

file versions/history

public

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

References $DIC, $table, and ilObject2GUI\checkPermissionBool().

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

        $ilTabs->activateTab("id_versions");

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

        // get versions
        $versions = $this->object->getVersions();

        // build versions table
        require_once("Modules/File/classes/class.ilFileVersionTableGUI.php");
        $table = new ilFileVersionTableGUI($this, "versions");
        $table->setMaxCount(sizeof($versions));
        $table->setData($versions);

        $this->tpl->setVariable("ADM_CONTENT", $table->getHTML());
    }

Here is the call graph for this function:

Field Documentation

$log

ilObjFileGUI::$log = null

protected

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

$object

ilObjFileGUI::$object

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

Referenced by handleFileUpload().

---

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

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