ilObjWorkspaceFolderGUI Class Reference

Class ilObjWorkspaceFolderGUI. More...

Inheritance diagram for ilObjWorkspaceFolderGUI:

Collaboration diagram for ilObjWorkspaceFolderGUI:

Public Member Functions
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
	Constructor. More...
	getType ()
	setTabs ($a_show_settings=true)
	executeCommand ()
	render ()
	Render folder. More...
	edit ()
	update ()
	cut ()
	Move node preparation. More...
	cut_for_repository ()
	Move node preparation (to repository) More...
	copy ()
	Copy node preparation. More...
	copyShared ()
	copy_to_repository ()
	Copy node preparation (to repository) More...
	showMoveIntoObjectTree ()
	Move node: select target (via explorer) More...
	performPasteIntoMultipleObjects ()
	Move node: target has been selected, execute. More...
	shareFilter ()
	share ($a_load_data=true)
	applyShareFilter ()
	resetShareFilter ()
	listSharedResourcesOfOtherUser ()
	Entry point for awareness tool. 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...
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...

Static Public Member Functions
static	_goto ($a_target)
	Deep link. More...
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...

Protected Member Functions
	initCreationForms ($a_new_type)
	passwordForm ($a_node_id, $form=null)
	initPasswordForm ($a_node_id)
	checkPassword ()
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
	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...
	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
	$help
	$tabs
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
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service

Additional Inherited Members
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

Detailed Description

Class ilObjWorkspaceFolderGUI.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Stefan Hecken stefa.nosp@m.n.he.nosp@m.cken@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Id

class.ilObjFolderGUI.php 25134 2010-08-13 14:22:11Z smeyer

ilObjWorkspaceFolderGUI: ilCommonActionDispatcherGUI, ilObjectOwnershipManagementGUI

Definition at line 18 of file class.ilObjWorkspaceFolderGUI.php.

Constructor & Destructor Documentation

__construct()

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

Constructor.

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

References $DIC, and user().

    {
        global $DIC;
        parent::__construct($a_id, $a_id_type, $a_parent_node_id);

        $this->lng = $DIC->language();
        $this->help = $DIC["ilHelp"];
        $this->tpl = $DIC["tpl"];
        $this->user = $DIC->user();
        $this->tabs = $DIC->tabs();
        $this->ctrl = $DIC->ctrl();
    }

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilObjWorkspaceFolderGUI::_goto (   $a_target )

static

Deep link.

Parameters

string

$a_target

Definition at line 715 of file class.ilObjWorkspaceFolderGUI.php.

References $_GET, $id, and exit.

    {
        $id = explode("_", $a_target);
        
        $_GET["baseClass"] = "ilsharedresourceGUI";
        $_GET["wsp_id"] = $id[0];
        include("ilias.php");
        exit;
    }

applyShareFilter()

ilObjWorkspaceFolderGUI::applyShareFilter

(

)

Definition at line 611 of file class.ilObjWorkspaceFolderGUI.php.

References $tbl, ilObject2GUI\getAccessHandler(), and share().

    {
        include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceShareTableGUI.php";
        $tbl = new ilWorkspaceShareTableGUI($this, "share", $this->getAccessHandler(), $this->node_id);
        $tbl->resetOffset();
        $tbl->writeFilterToSession();
        
        $this->share();
    }

Here is the call graph for this function:

checkPassword()

ilObjWorkspaceFolderGUI::checkPassword ( )

protected

Definition at line 679 of file class.ilObjWorkspaceFolderGUI.php.

References $form, $input, ilObjectGUI\$lng, ilObject2GUI\$node_id, $password, ilWorkspaceAccessHandler\getSharedNodePassword(), initPasswordForm(), ilWorkspaceAccessHandler\keepSharedSessionPassword(), passwordForm(), and ilUtil\sendFailure().

    {
        $lng = $this->lng;
        
        $node_id = $_REQUEST["item_ref_id"];
        if (!$node_id) {
            $this->ctrl->redirect($this, "share");
        }
         
        $form = $this->initPasswordForm($node_id);
        if ($form->checkInput()) {
            include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceAccessHandler.php";
            $password = ilWorkspaceAccessHandler::getSharedNodePassword($node_id);
            $input = md5($form->getInput("password"));
            if ($input == $password) {
                // we save password and start over
                ilWorkspaceAccessHandler::keepSharedSessionPassword($node_id, $input);
                
                $this->ctrl->setParameter($this, "item_ref_id", $node_id);
                $this->ctrl->redirect($this, "copyShared");
            } else {
                $item = $form->getItemByPostVar("password");
                $item->setAlert($lng->txt("wsp_invalid_password"));
                ilUtil::sendFailure($lng->txt("form_input_not_valid"));
            }
        }
        
        $form->setValuesByPost();
        $this->passwordForm($node_id, $form);
    }

Here is the call graph for this function:

copy()

ilObjWorkspaceFolderGUI::copy

(

)

Copy node preparation.

cioy object(s) out from a container and write the information to clipboard

Definition at line 279 of file class.ilObjWorkspaceFolderGUI.php.

References $_SESSION, $ilUser, ilObject2GUI\$node_id, ilObjectGUI\$user, ilUtil\sendFailure(), and showMoveIntoObjectTree().

Referenced by copy_to_repository().

    {
        $ilUser = $this->user;
        
        if (!$_REQUEST["item_ref_id"]) {
            ilUtil::sendFailure($this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this);
        }

        $current_node = $_REQUEST["item_ref_id"];
        $owner = $this->tree->lookupOwner($current_node);
        if ($owner == $ilUser->getId()) {
            $parent_node = $this->tree->getParentId($current_node);

            // on cancel or fail we return to parent node
            $this->ctrl->setParameter($this, "wsp_id", $parent_node);

            // open current position
            // using the explorer session storage directly is basically a hack
            // as we do not use setExpanded() [see below]
            $_SESSION['paste_copy_wspexpand'] = array();
            foreach ((array) $this->tree->getPathId($parent_node) as $node_id) {
                $_SESSION['paste_copy_wspexpand'][] = $node_id;
            }
        } else {
            // see copyShared()
            ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
            $this->ctrl->redirect($this);
        }

        // remember source node
        $_SESSION['clipboard']['source_id'] = $current_node;
        $_SESSION['clipboard']['cmd'] = 'copy';

        return $this->showMoveIntoObjectTree();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

copy_to_repository()

ilObjWorkspaceFolderGUI::copy_to_repository

(

)

Copy node preparation (to repository)

copy object(s) out from a container and write the information to clipboard

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

References $_SESSION, and copy().

    {
        $_SESSION['clipboard']['wsp2repo'] = true;
        $this->copy();
    }

Here is the call graph for this function:

copyShared()

ilObjWorkspaceFolderGUI::copyShared

(

)

Definition at line 316 of file class.ilObjWorkspaceFolderGUI.php.

References $_SESSION, $handler, ilObject2GUI\getAccessHandler(), passwordForm(), ilWorkspaceAccessGUI\PERMISSION_ALL_PASSWORD, ilUtil\sendFailure(), and showMoveIntoObjectTree().

    {
        if (!$_REQUEST["item_ref_id"]) {
            $this->ctrl->redirect($this, "share");
        }
        
        $current_node = $_REQUEST["item_ref_id"];
        $handler = $this->getAccessHandler();
        
        // see ilSharedRessourceGUI::hasAccess()
        if ($handler->checkAccess("read", "", $current_node)) {
            // remember source node
            $_SESSION['clipboard']['source_id'] = $current_node;
            $_SESSION['clipboard']['cmd'] = 'copy';
            $_SESSION['clipboard']['shared'] = true;

            return $this->showMoveIntoObjectTree();
        } else {
            $perms = $handler->getPermissions($current_node);
            if (in_array(ilWorkspaceAccessGUI::PERMISSION_ALL_PASSWORD, $perms)) {
                return $this->passwordForm($current_node);
            }
        }
        
        ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
        $this->ctrl->redirect($this, "share");
    }

Here is the call graph for this function:

cut()

ilObjWorkspaceFolderGUI::cut

(

)

Move node preparation.

cut object(s) out from a container and write the information to clipboard

Definition at line 221 of file class.ilObjWorkspaceFolderGUI.php.

References $_SESSION, ilObject2GUI\$node_id, ilObject2GUI\checkPermissionBool(), ilObjectFactory\getInstanceByObjId(), ilUtil\sendFailure(), and showMoveIntoObjectTree().

Referenced by cut_for_repository().

    {
        if (!$_REQUEST["item_ref_id"]) {
            ilUtil::sendFailure($this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this);
        }

        $current_node = $_REQUEST["item_ref_id"];
        $parent_node = $this->tree->getParentId($current_node);

        // on cancel or fail we return to parent node
        $this->ctrl->setParameter($this, "wsp_id", $parent_node);

        // check permission
        $no_cut = array();
        foreach ($this->tree->getSubTree($this->tree->getNodeData($current_node)) as $node) {
            if (!$this->checkPermissionBool("delete", "", "", $node["wsp_id"])) {
                $obj = ilObjectFactory::getInstanceByObjId($node["obj_id"]);
                $no_cut[$node["wsp_id"]] = $obj->getTitle();
                unset($obj);
            }
        }
        if (count($no_cut)) {
            ilUtil::sendFailure($this->lng->txt("msg_no_perm_cut") . " " . implode(',', $no_cut), true);
            $this->ctrl->redirect($this);
        }

        // open current position
        // using the explorer session storage directly is basically a hack
        // as we do not use setExpanded() [see below]
        $_SESSION['paste_cut_wspexpand'] = array();
        foreach ((array) $this->tree->getPathId($parent_node) as $node_id) {
            $_SESSION['paste_cut_wspexpand'][] = $node_id;
        }

        // remember source node
        $_SESSION['clipboard']['source_id'] = $current_node;
        $_SESSION['clipboard']['cmd'] = 'cut';

        return $this->showMoveIntoObjectTree();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cut_for_repository()

ilObjWorkspaceFolderGUI::cut_for_repository

(

)

Move node preparation (to repository)

cut object(s) out from a container and write the information to clipboard

Definition at line 268 of file class.ilObjWorkspaceFolderGUI.php.

References $_SESSION, and cut().

    {
        $_SESSION['clipboard']['wsp2repo'] = true;
        $this->cut();
    }

Here is the call graph for this function:

edit()

ilObjWorkspaceFolderGUI::edit

(

)

Definition at line 200 of file class.ilObjWorkspaceFolderGUI.php.

    {
        parent::edit();
      
        $this->tabs_gui->activateTab("wsp");
        $this->tabs_gui->activateSubTab("settings");
    }

executeCommand()

ilObjWorkspaceFolderGUI::executeCommand

(

)

Definition at line 112 of file class.ilObjWorkspaceFolderGUI.php.

References ilObjectGUI\addHeaderAction(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), and ilObject2GUI\prepareOutput().

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

        switch ($next_class) {
            case "ilcommonactiondispatchergui":
                include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;
            
            case "ilobjectownershipmanagementgui":
                $this->prepareOutput();
                $this->tabs_gui->activateTab("ownership");
                include_once("Services/Object/classes/class.ilObjectOwnershipManagementGUI.php");
                $gui = new ilObjectOwnershipManagementGUI();
                $this->ctrl->forwardCommand($gui);
                break;
            
            default:
                $this->prepareOutput();
                if ($this->type != "wsrt") {
                    $this->addHeaderAction();
                }
                if (!$cmd) {
                    $cmd = "render";
                }
                $this->$cmd();
                break;
        }
        
        return true;
    }

Here is the call graph for this function:

getType()

ilObjWorkspaceFolderGUI::getType

(

)

Definition at line 47 of file class.ilObjWorkspaceFolderGUI.php.

    {
        return "wfld";
    }

initCreationForms()

ilObjWorkspaceFolderGUI::initCreationForms (   $a_new_type )

protected

Definition at line 147 of file class.ilObjWorkspaceFolderGUI.php.

References ilObjectGUI\initCreateForm().

    {
        $forms = array(
            self::CFORM_NEW => $this->initCreateForm($a_new_type)
            );

        return $forms;
    }

Here is the call graph for this function:

initPasswordForm()

ilObjWorkspaceFolderGUI::initPasswordForm (   $a_node_id )

protected

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

References ilObjectGUI\$ctrl, $form, $ilCtrl, ilObjectGUI\$lng, $password, and ilObject2GUI\getAccessHandler().

Referenced by checkPassword(), and passwordForm().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
                        
        $this->ctrl->setParameter($this, "item_ref_id", $a_node_id);
        
        $object_data = $this->getAccessHandler()->getObjectDataFromNode($a_node_id);
        
        include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this, "checkPassword"));
        $form->setTitle($lng->txt("wsp_password_for") . ": " . $object_data["title"]);
        
        $password = new ilPasswordInputGUI($lng->txt("password"), "password");
        $password->setRetype(false);
        $password->setRequired(true);
        $password->setSkipSyntaxCheck(true);
        $form->addItem($password);
        
        $form->addCommandButton("checkPassword", $lng->txt("submit"));
        $form->addCommandButton("share", $lng->txt("cancel"));
        
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listSharedResourcesOfOtherUser()

ilObjWorkspaceFolderGUI::listSharedResourcesOfOtherUser

(

)

Entry point for awareness tool.

Definition at line 728 of file class.ilObjWorkspaceFolderGUI.php.

References $_GET, $_POST, ilObjectGUI\$ctrl, $ilCtrl, $tbl, ilObject2GUI\getAccessHandler(), and share().

    {
        $ilCtrl = $this->ctrl;

        include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceShareTableGUI.php";
        $tbl = new ilWorkspaceShareTableGUI($this, "share", $this->getAccessHandler(), $this->node_id);
        $tbl->resetOffset();
        $tbl->resetFilter();
        $_POST["user"] = $_GET["user"];
        $tbl->writeFilterToSession();
        $this->share();
    }

Here is the call graph for this function:

passwordForm()

ilObjWorkspaceFolderGUI::passwordForm (   $a_node_id,   $form = null  )

protected

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

References $form, ilObjectGUI\$lng, $tabs, ilObjectGUI\$tpl, and initPasswordForm().

Referenced by checkPassword(), and copyShared().

    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilTabs = $this->tabs;
        
        $tpl->setTitle($lng->txt("wsp_password_protected_resource"));
        $tpl->setDescription($lng->txt("wsp_password_protected_resource_info"));
        
        $ilTabs->clearTargets();
        $ilTabs->setBackTarget(
            $lng->txt("back"),
            $this->ctrl->getLinkTarget($this, "share")
        );
        
        if (!$form) {
            $form = $this->initPasswordForm($a_node_id);
        }
    
        $tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

performPasteIntoMultipleObjects()

ilObjWorkspaceFolderGUI::performPasteIntoMultipleObjects

(

)

Move node: target has been selected, execute.

Definition at line 439 of file class.ilObjWorkspaceFolderGUI.php.

References $_SESSION, $ilUser, ilObject2GUI\$node_id, ilObject2GUI\$parent_id, ilObjectGUI\$user, ilCopyWizardOptions\_allocateCopyId(), ilCopyWizardOptions\_getInstance(), ilObject\_lookupObjId(), ilObject2GUI\checkPermissionBool(), ilObject2GUI\getAccessHandler(), ilObjectFactory\getInstanceByObjId(), and ilUtil\sendFailure().

    {
        $ilUser = $this->user;
        
        $mode = $_SESSION['clipboard']['cmd'];
        $source_node_id = $_SESSION['clipboard']['source_id'];
        $target_node_id = $_REQUEST['node'];

        if (!$source_node_id) {
            ilUtil::sendFailure($this->lng->txt('select_at_least_one_object'), true);
            $this->ctrl->redirect($this);
        }
        if (!$target_node_id) {
            ilUtil::sendFailure($this->lng->txt('select_at_least_one_object'), true);
            $this->ctrl->redirect($this, "showMoveIntoObjectTree");
        }

        // object instances
        $source_obj_id = $this->tree->lookupObjectId($source_node_id);
        $source_object = ilObjectFactory::getInstanceByObjId($source_obj_id);
        
        if (!$_SESSION['clipboard']['wsp2repo']) {
            $target_obj_id = $this->tree->lookupObjectId($target_node_id);
        } else {
            $target_obj_id = ilObject::_lookupObjId($target_node_id);
        }
        $target_object = ilObjectFactory::getInstanceByObjId($target_obj_id);


        // sanity checks

        $fail = array();

        if ($source_node_id == $target_node_id) {
            $fail[] = sprintf(
                $this->lng->txt('msg_obj_exists_in_folder'),
                $source_object->getTitle(),
                $target_object->getTitle()
            );
        }

        if (!in_array($source_object->getType(), array_keys($target_object->getPossibleSubObjects()))) {
            $fail[] = sprintf(
                $this->lng->txt('msg_obj_may_not_contain_objects_of_type'),
                $target_object->getTitle(),
                $source_object->getType()
            );
        }
                
        // if object is shared permission to copy has been checked above
        $owner = $this->tree->lookupOwner($source_node_id);
        if ($mode == "copy" && $ilUser->getId() == $owner && !$this->checkPermissionBool('copy', '', '', $source_node_id)) {
            $fail[] = $this->lng->txt('permission_denied');
        }

        if (!$_SESSION['clipboard']['wsp2repo']) {
            if ($mode == "cut" && $this->tree->isGrandChild($source_node_id, $target_node_id)) {
                $fail[] = sprintf(
                    $this->lng->txt('msg_paste_object_not_in_itself'),
                    $source_object->getTitle()
                );
            }
        }

        if ($_SESSION['clipboard']['wsp2repo'] == true) {               // see #22959
            global $ilAccess;
            if (!$ilAccess->checkAccess("create", "", $target_node_id, $source_object->getType())) {
                $fail[] = sprintf(
                    $this->lng->txt('msg_no_perm_paste_object_in_folder'),
                    $source_object->getTitle(),
                    $target_object->getTitle()
                );
            }
        } else {
            if (!$this->checkPermissionBool('create', '', $source_object->getType(), $target_node_id)) {
                $fail[] = sprintf(
                    $this->lng->txt('msg_no_perm_paste_object_in_folder'),
                    $source_object->getTitle(),
                    $target_object->getTitle()
                );
            }
        }

        if (sizeof($fail)) {
            ilUtil::sendFailure(implode("<br />", $fail), true);
            $this->ctrl->redirect($this);
        }


        // move the node
        if ($mode == "cut") {
            if (!$_SESSION['clipboard']['wsp2repo']) {
                $this->tree->moveTree($source_node_id, $target_node_id);
            } else {
                $parent_id = $this->tree->getParentId($source_node_id);

                // remove from personal workspace
                $this->getAccessHandler()->removePermission($source_node_id);
                $this->tree->deleteReference($source_node_id);
                $source_node = $this->tree->getNodeData($source_node_id);
                $this->tree->deleteTree($source_node);

                // add to repository
                $source_object->createReference();
                $source_object->putInTree($target_node_id);
                $source_object->setPermissions($target_node_id);

                $source_node_id = $parent_id;
            }
        }
        // copy the node
        elseif ($mode == "copy") {
            include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
            $copy_id = ilCopyWizardOptions::_allocateCopyId();
            $wizard_options = ilCopyWizardOptions::_getInstance($copy_id);
            
            if (!$_SESSION['clipboard']['wsp2repo']) {
                $wizard_options->disableTreeCopy();
            }
            $wizard_options->saveOwner($ilUser->getId());
            $wizard_options->saveRoot($source_node_id);
            $wizard_options->read();
            
            $new_obj = $source_object->cloneObject($target_node_id, $copy_id);
            
            // insert into workspace tree
            if ($new_obj && !$_SESSION['clipboard']['wsp2repo']) {
                $new_obj_node_id = $this->tree->insertObject($target_node_id, $new_obj->getId());
                $this->getAccessHandler()->setPermissions($target_node_id, $new_obj_node_id);
            }
 
            $wizard_options->deleteAll();
        }
        
        // redirect to target if not repository
        if (!$_SESSION['clipboard']['wsp2repo']) {
            $redirect_node = $target_node_id;
        } else {
            // reload current folder
            $redirect_node = $this->node_id;
        }
        
        unset($_SESSION['clipboard']['cmd']);
        unset($_SESSION['clipboard']['source_id']);
        unset($_SESSION['clipboard']['wsp2repo']);
        unset($_SESSION['clipboard']['shared']);
        
        // #17746
        if ($mode == 'cut') {
            ilUtil::sendSuccess($this->lng->txt('msg_cut_copied'), true);
        } else {
            ilUtil::sendSuccess($this->lng->txt('msg_cloned'), true);
        }
        
        $this->ctrl->setParameter($this, "wsp_id", $redirect_node);
        $this->ctrl->redirect($this);
    }

Here is the call graph for this function:

render()

ilObjWorkspaceFolderGUI::render

(

)

Render folder.

Definition at line 159 of file class.ilObjWorkspaceFolderGUI.php.

References $_SESSION, ilObjectGUI\$ctrl, $ilCtrl, $ilUser, $table, $tabs, ilObjectGUI\$tpl, ilObjectGUI\$user, ilObject2GUI\getAccessHandler(), ilObjectDefinition\MODE_WORKSPACE, ilObjectListGUI\prepareJsLinks(), and ilTreeExplorerGUI\setTypeWhiteList().

    {
        $tpl = $this->tpl;
        $ilUser = $this->user;
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        
        unset($_SESSION['clipboard']['wsp2repo']);
        
        // add new item
        include_once "Services/Object/classes/class.ilObjectAddNewItemGUI.php";
        $gui = new ilObjectAddNewItemGUI($this->node_id);
        $gui->setMode(ilObjectDefinition::MODE_WORKSPACE);
        $gui->setCreationUrl($ilCtrl->getLinkTarget($this, "create"));
        $gui->render();
    
        include_once "Services/Object/classes/class.ilObjectListGUI.php";
        ilObjectListGUI::prepareJsLinks(
            "",
            $this->ctrl->getLinkTargetByClass(array("ilcommonactiondispatchergui", "ilnotegui"), "", "", true, false),
            $this->ctrl->getLinkTargetByClass(array("ilcommonactiondispatchergui", "iltagginggui"), "", "", true, false)
        );
        
        include_once "Modules/WorkspaceFolder/classes/class.ilObjWorkspaceFolderTableGUI.php";
        $table = new ilObjWorkspaceFolderTableGUI($this, "render", $this->node_id, $this->getAccessHandler());
        $tpl->setContent($table->getHTML());

        include_once("./Services/PersonalWorkspace/classes/class.ilWorkspaceExplorerGUI.php");
        $exp = new ilWorkspaceExplorerGUI($ilUser->getId(), $this, "render", $this, "", "wsp_id");
        $exp->setTypeWhiteList(array("wsrt", "wfld"));
        $exp->setSelectableTypes(array("wsrt", "wfld"));
        $exp->setLinkToNodeClass(true);
        $exp->setActivateHighlighting(true);
        if ($exp->handleCommand()) {
            return;
        }
        $left = $exp->getHTML();

        $tpl->setLeftNavContent($left);
    }

Here is the call graph for this function:

resetShareFilter()

ilObjWorkspaceFolderGUI::resetShareFilter

(

)

Definition at line 621 of file class.ilObjWorkspaceFolderGUI.php.

References $tbl, ilObject2GUI\getAccessHandler(), and shareFilter().

    {
        include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceShareTableGUI.php";
        $tbl = new ilWorkspaceShareTableGUI($this, "share", $this->getAccessHandler(), $this->node_id);
        $tbl->resetOffset();
        $tbl->resetFilter();
        
        $this->shareFilter();
    }

Here is the call graph for this function:

setTabs()

ilObjWorkspaceFolderGUI::setTabs

(

$a_show_settings = true

)

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

References $help, ilObjectGUI\$lng, ilObject2GUI\checkPermissionBool(), and ilObject2GUI\getAccessHandler().

    {
        $lng = $this->lng;
        $ilHelp = $this->help;

        $ilHelp->setScreenIdComponent("wfld");
        
        $this->ctrl->setParameter($this, "wsp_id", $this->node_id);
        
        $this->tabs_gui->addTab(
            "wsp",
            $lng->txt("wsp_tab_personal"),
            $this->ctrl->getLinkTarget($this, "")
        );
        
        $this->ctrl->setParameterByClass(
            "ilObjWorkspaceRootFolderGUI",
            "wsp_id",
            $this->getAccessHandler()->getTree()->getRootId()
        );
        
        $this->tabs_gui->addTab(
            "share",
            $lng->txt("wsp_tab_shared"),
            $this->ctrl->getLinkTargetByClass("ilObjWorkspaceRootFolderGUI", "shareFilter")
        );
        
        $this->tabs_gui->addTab(
            "ownership",
            $lng->txt("wsp_tab_ownership"),
            $this->ctrl->getLinkTargetByClass(array("ilObjWorkspaceRootFolderGUI", "ilObjectOwnershipManagementGUI"), "listObjects")
        );
        
        if (!$this->ctrl->getNextClass($this)) {
            if (stristr($this->ctrl->getCmd(), "share")) {
                $this->tabs_gui->activateTab("share");
            } else {
                $this->tabs_gui->activateTab("wsp");

                if ($a_show_settings) {
                    if ($this->checkPermissionBool("read")) {
                        $this->tabs_gui->addSubTab(
                            "content",
                            $lng->txt("content"),
                            $this->ctrl->getLinkTarget($this, "")
                        );
                    }

                    if ($this->checkPermissionBool("write")) {
                        $this->tabs_gui->addSubTab(
                            "settings",
                            $lng->txt("settings"),
                            $this->ctrl->getLinkTarget($this, "edit")
                        );
                    }
                }
            }
        }
    }

Here is the call graph for this function:

share()

ilObjWorkspaceFolderGUI::share

(

$a_load_data = true

)

Definition at line 602 of file class.ilObjWorkspaceFolderGUI.php.

References $tbl, ilObjectGUI\$tpl, and ilObject2GUI\getAccessHandler().

Referenced by applyShareFilter(), listSharedResourcesOfOtherUser(), and shareFilter().

    {
        $tpl = $this->tpl;
    
        include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceShareTableGUI.php";
        $tbl = new ilWorkspaceShareTableGUI($this, "share", $this->getAccessHandler(), $this->node_id, $a_load_data);
        $tpl->setContent($tbl->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

shareFilter()

ilObjWorkspaceFolderGUI::shareFilter

(

)

Definition at line 597 of file class.ilObjWorkspaceFolderGUI.php.

References share().

Referenced by resetShareFilter().

    {
        $this->share(false);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showMoveIntoObjectTree()

ilObjWorkspaceFolderGUI::showMoveIntoObjectTree

(

)

Move node: select target (via explorer)

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

References $_GET, $_POST, $_SESSION, $tabs, ilObject2GUI\$tree, ilPasteIntoMultipleItemsExplorer\SEL_TYPE_RADIO, ilUtil\sendInfo(), ilTreeExplorerGUI\setTypeWhiteList(), and user().

Referenced by copy(), copyShared(), and cut().

    {
        $ilTabs = $this->tabs;
        $tree = $this->tree;
        
        $ilTabs->clearTargets();

        if (!$_SESSION['clipboard']['shared']) {
            $ilTabs->setBackTarget(
                $this->lng->txt('back'),
                $this->ctrl->getLinkTarget($this)
            );
        } else {
            $ilTabs->setBackTarget(
                $this->lng->txt('back'),
                $this->ctrl->getLinkTarget($this, 'share')
            );
        }
        
        $mode = $_SESSION['clipboard']['cmd'];

        ilUtil::sendInfo($this->lng->txt('msg_' . $mode . '_clipboard'));
        
        $this->tpl->addBlockfile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.paste_into_multiple_objects.html',
            "Services/Object"
        );
        
        // move/copy in personal workspace
        if (!$_SESSION['clipboard']['wsp2repo']) {
            include_once("./Services/PersonalWorkspace/classes/class.ilWorkspaceExplorerGUI.php");
            $exp = new ilWorkspaceExplorerGUI($this->user->getId(), $this, "showMoveIntoObjectTree", $this, "");
            $exp->setTypeWhiteList(array("wsrt", "wfld"));
            $exp->setSelectableTypes(array("wsrt", "wfld"));
            $exp->setSelectMode("node", false);
            if ($exp->handleCommand()) {
                return;
            }
            $this->tpl->setVariable('OBJECT_TREE', $exp->getHTML());
        }
        // move/copy to repository
        else {
            require_once './Services/Object/classes/class.ilPasteIntoMultipleItemsExplorer.php';
            $exp = new ilPasteIntoMultipleItemsExplorer(
                ilPasteIntoMultipleItemsExplorer::SEL_TYPE_RADIO,
                '',
                'paste_' . $mode . '_repexpand'
            );
            $exp->setTargetGet('ref_id');
            
            if ($_GET['paste_' . $mode . '_repexpand'] == '') {
                $expanded = $tree->readRootId();
            } else {
                $expanded = $_GET['paste_' . $mode . '_repexpand'];
            }
            $exp->setCheckedItems(array((int) $_POST['node']));
            $exp->setExpandTarget($this->ctrl->getLinkTarget($this, 'showMoveIntoObjectTree'));
            $exp->setPostVar('node');
            $exp->setExpand($expanded);
            $exp->setOutput(0);
            $this->tpl->setVariable('OBJECT_TREE', $exp->getOutput());
        }
        

        unset($exp);

        $this->tpl->setVariable('FORM_TARGET', '_top');
        $this->tpl->setVariable(
            'FORM_ACTION',
            $this->ctrl->getFormAction($this, 'performPasteIntoMultipleObjects')
        );

        $this->tpl->setVariable('CMD_SUBMIT', 'performPasteIntoMultipleObjects');
        $this->tpl->setVariable('TXT_SUBMIT', $this->lng->txt('paste'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilObjWorkspaceFolderGUI::update

(

)

Definition at line 208 of file class.ilObjWorkspaceFolderGUI.php.

References League\Flysystem\Adapter\Polyfill\update().

    {
        parent::update();
        
        $this->tabs_gui->activateTab("wsp");
        $this->tabs_gui->activateSubTab("settings");
    }

Here is the call graph for this function:

Field Documentation

$help

ilObjWorkspaceFolderGUI::$help

protected

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

Referenced by ilObjWorkspaceRootFolderGUI\setTabs(), and setTabs().

$tabs

ilObjWorkspaceFolderGUI::$tabs

protected

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

Referenced by passwordForm(), render(), and showMoveIntoObjectTree().

---

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

• Modules/WorkspaceFolder/classes/class.ilObjWorkspaceFolderGUI.php