Inheritance diagram for ilObjCloudGUI:

Collaboration diagram for ilObjCloudGUI:

Public Member Functions
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)

	getType ()
	Get type. More...

	executeCommand ()

	getStandardCmd ()
	Get standard command. More...

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

	setTabs ()

	infoScreen ()
	show information screen More...

	render ()

	asyncGetBlock ()

	getFile ()

	asyncGetActionListContent ()

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

	isVisible ()

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

Public Member Functions inherited from ilObjectGUI
	ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor public. More...

&	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...

	getAdminTabs (&$tabs_gui)
	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 ($in_rep=false)
	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...

	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)
	_goto 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)
	Init creation froms. More...

	initCreateForm ($a_new_type)
	Init object creation form. More...

	afterSave (ilObjCloud $a_new_object)

	serviceAuth (ilObjCloud $object)

	afterServiceAuth ()

	addHeaderAction ()
	Add header action menu. More...

	addLocatorItems ()
	addLocatorItems More...

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

	prepareOutput ()

	setTitleAndDescription ()

	showUpperIcon ()

	omitLocator ($a_omit=true)

	getTargetFrame ($a_cmd, $a_target_frame="")

	setTargetFrame ($a_cmd, $a_target_frame)

	getCenterColumnHTML ()

	getRightColumnHTML ()

	setColumnSettings ($column_gui)

	checkPermission ($a_perm, $a_cmd="")

	showPossibleSubObjects ()

	redirectToRefId ()

	fillCloneTemplate ($a_tpl_varname, $a_type)

	fillCloneSearchTemplate ($a_tpl_varname, $a_type)

	searchCloneSource ()

	buildCloneSelect ($existing_objs)

	addAdminLocatorItems ()

	setTabs ()
	create tabs (repository/workspace switch) More...

	getReturnLocation ()
	Deprecated functions. More...

	setReturnLocation ()

	showActions ()

	getTitlesByRefId ()

	getTabs ()

	__showButton ()

	hitsperpageObject ()

	__initTableGUI ()

	__setTableGUIBasicData ()

	addLocatorItems ()
	Functions to be overwritten. More...

	initCreationForms ($a_new_type)
	Init creation froms. More...

	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. 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 ()

	prepareOutput ()
	prepare output More...

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

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

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

	getTitlesByRefId ($a_ref_ids)
	get Titles of objects this method is used for error messages in methods cut/copy/paste More...

	getTabs (&$tabs_gui)
	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 ($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
	$plugin_service
	ilCloudPluginService More...

Protected Attributes inherited from ilObject2GUI
	$object_id

	$node_id

	$creation_forms = array()

	$id_type = array()

	$parent_id

	$access_handler

Protected Attributes inherited from ilObjectGUI
	$tmp_import_dir

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

	$ilias

	$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 ilObjCloudGUI.

Author: Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

ilObjCloudGUI: ilPermissionGUI, ilNoteGUI, ilInfoScreenGUI, ilObjectCopyGUI, ilCommonActionDispatcherGUI ilObjCloudGUI: ilCloudPluginUploadGUI, ilCloudPluginCreateFolderGUI, ilCloudPluginSettingsGUI, ilObjCloudGUI: ilCloudPluginDeleteGUI, ilCloudPluginActionListGUI, ilCloudPluginItemCreationListGUI, ilObjCloudGUI: ilCloudPluginFileTreeGUI, ilCloudPluginInitGUI, ilCloudPluginHeaderActionGUI, ilCloudPluginInfoScreenGUI

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

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

int	$a_id
int	$a_id_type
int	$a_parent_node_id

Definition at line 36 of file class.ilObjCloudGUI.php.

References ilObjectGUI\$lng.

                                                                                                            {
                 global $lng;
 
                 parent::__construct($a_id, $a_id_type, $a_parent_node_id);
                 $lng->loadLanguageModule("cld");
         }

Member Function Documentation

◆ _goto()

static ilObjCloudGUI::_goto ( $a_target )

static

_goto Deep link

Parameters

string $a_target

Definition at line 196 of file class.ilObjCloudGUI.php.

References $_GET, and $_POST.

                                                 {
                 $content = explode("_", $a_target);
                 $_GET["ref_id"] = $content[0];
                 $_POST["path"] = $content[2];
                 $_GET["baseClass"] = "ilrepositorygUI";
                 $_GET["cmdClass"] = "ilobjcloudgui";
                 $_GET["cmd"] = "render";
                 include("ilias.php");
         }

◆ addHeaderAction()

ilObjCloudGUI::addHeaderAction ( )

protected

Add header action menu.

Definition at line 403 of file class.ilObjCloudGUI.php.

References $lg, ilCloudConnector\getHeaderActionGUIClass(), ilObject2GUI\initHeaderAction(), and ilObjectGUI\insertHeaderAction().

Referenced by executeCommand().

                                              {
                 $lg = $this->initHeaderAction();
                 if ($lg) {
                         $header_action_class = ilCloudConnector::getHeaderActionGUIClass($this->plugin_service);
                         $header_action_class->addCustomHeaderAction($lg);
                         $this->insertHeaderAction($lg);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addLocatorItems()

ilObjCloudGUI::addLocatorItems ( )

protected

addLocatorItems

Definition at line 416 of file class.ilObjCloudGUI.php.

References ilObject2GUI\$node_id.

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

◆ afterSave()

ilObjCloudGUI::afterSave ( ilObjCloud $a_new_object )

protected

Parameters

ilObjCloud $a_new_object

Definition at line 338 of file class.ilObjCloudGUI.php.

References ilCloudConnector\getCreationGUIClass(), ilObject2\getId(), ilObjCloud\getServiceName(), initCreateForm(), ilObjectGUI\redirectToRefId(), ilUtil\sendFailure(), serviceAuth(), ilObjCloud\setAuthComplete(), ilObjCloud\setOnline(), ilObjCloud\setRootFolder(), ilObjCloud\setServiceName(), and ilObject2\update().

                                                                {
                 try {
                         $form = $this->initCreateForm("cld");
 
                         if ($form->checkInput()) {
                                 $a_new_object->setServiceName($form->getInput("service"));
                                 $a_new_object->setRootFolder("/");
                                 $a_new_object->setOnline(false);
                                 $a_new_object->setAuthComplete(false);
                                 $this->plugin_service = new ilCloudPluginService($a_new_object->getServiceName(), $a_new_object->getId());
                                 $init_gui = ilCloudConnector::getCreationGUIClass($this->plugin_service);
                                 if ($init_gui) {
                                         $init_gui->afterSavePluginCreation($a_new_object, $form);
                                 }
                                 $a_new_object->update();
                                 $this->serviceAuth($a_new_object);
                         }
                 } catch (Exception $e) {
                         ilUtil::sendFailure($e->getMessage(), true);
                         ilObjectGUI::redirectToRefId($this->parent_id);
                 }
         }

Here is the call graph for this function:

◆ afterServiceAuth()

ilObjCloudGUI::afterServiceAuth ( )

protected

Definition at line 376 of file class.ilObjCloudGUI.php.

References $ilCtrl, ilObjectGUI\$lng, ilRepUtil\deleteObjects(), ilObjectGUI\redirectToRefId(), ilUtil\sendFailure(), and ilUtil\sendSuccess().

                                               {
                 global $ilCtrl, $lng;
 
                 try {
                         if ($this->plugin_service->afterAuthService()) {
                                 $this->object->setRootId("root", true);
                                 $this->object->setAuthComplete(true);
                                 $this->object->update();
                                 ilUtil::sendSuccess($lng->txt("cld_object_added"), true);
                                 $ilCtrl->redirectByClass("ilCloudPluginSettingsGUI", "editSettings");
                         } else {
                                 include_once("./Services/Repository/classes/class.ilRepUtil.php");
                                 ilRepUtil::deleteObjects($this->object->getRefId(), $this->object->getRefId());
 
                                 ilUtil::sendFailure($lng->txt("cld_auth_failed_no_object_created"), true);
                                 ilObjectGUI::redirectToRefId($this->parent_id);
                         }
                 } catch (Exception $e) {
                         ilUtil::sendFailure($e->getMessage(), true);
                         ilObjectGUI::redirectToRefId($this->parent_id);
                 }
         }

Here is the call graph for this function:

◆ asyncGetActionListContent()

ilObjCloudGUI::asyncGetActionListContent ( )

Definition at line 473 of file class.ilObjCloudGUI.php.

References $_GET, ilObject2GUI\checkPermissionBool(), ilCloudConnector\getActionListGUIClass(), and ilCloudFileTree\getFileTreeFromSession().

                                              {
                 $action_list = ilCloudConnector::getActionListGUIClass($this->plugin_service);
                 $file_tree = ilCloudFileTree::getFileTreeFromSession();
 
                 return $action_list->asyncGetContent($this->checkPermissionBool("delete_files"), $this->checkPermissionBool("delete_folders"), $file_tree->getNodeFromId($_GET["node_id"]));
         }

Here is the call graph for this function:

◆ asyncGetBlock()

ilObjCloudGUI::asyncGetBlock ( )

Definition at line 431 of file class.ilObjCloudGUI.php.

References $_POST, ilObjectGUI\$tpl, ilObject2GUI\checkPermissionBool(), ilJsonUtil\encode(), exit, ilCloudFileTree\getFileTreeFromSession(), and ilCloudConnector\getFileTreeGUIClass().

                                         {
                 global $tpl;
 
                 $response = new stdClass();
                 $response->message = NULL;
                 $response->locator = NULL;
                 $response->content = NULL;
                 $response->success = NULL;
 
                 try {
                         $file_tree = ilCloudFileTree::getFileTreeFromSession();
                         $file_tree->updateFileTree($_POST["path"]);
                         $node = $file_tree->getNodeFromPath($_POST["path"]);
                         $file_tree_gui = ilCloudConnector::getFileTreeGUIClass($this->plugin_service, $file_tree);
                         $response->content = $file_tree_gui->getFolderHtml($this, $node->getId(), $this->checkPermissionBool("delete_files"), $this->checkPermissionBool("delete_folders"), $this->checkPermissionBool("download"), $this->checkPermissionBool("files_visible"), $this->checkPermissionBool("folders_visible"));
 
                         $response->locator = $file_tree_gui->getLocatorHtml($file_tree->getNodeFromId($node->getId()));
                         $response->success = true;
                 } catch (Exception $e) {
                         $response->message = $tpl->getMessageHTML($e->getMessage(), "failure");
                 }
 
                 header('Content-type: application/json');
                 echo ilJsonUtil::encode($response);
                 exit;
         }

Here is the call graph for this function:

◆ executeCommand()

ilObjCloudGUI::executeCommand ( )

Returns: bool

Exceptions

ilCloudException

Definition at line 56 of file class.ilObjCloudGUI.php.

                                          {
                 global $ilCtrl, $ilTabs, $ilNavigationHistory, $lng;
 
                 // Navigation History
                 $link = $ilCtrl->getLinkTarget($this, "render");
 
                 try {
                         ilCloudConnector::getActiveServices();
                 } catch (Exception $e) {
                         ilUtil::sendFailure($lng->txt("cld_no_service_active"), true);
                         ilObjectGUI::redirectToRefId($this->parent_id);
                 }
 
                 if ($this->object != NULL) {
                         $ilNavigationHistory->addItem($this->object->getRefId(), $link, "cld");
 
                         try {
                                 ilCloudConnector::checkServiceActive($this->object->getServiceName());
                         } catch (Exception $e) {
                                 ilUtil::sendFailure($lng->txt("cld_plugin_not_active"), true);
                                 ilObjectGUI::redirectToRefId($this->parent_id);
                         }
 
                         if ($this->object->getAuthComplete() == false && !$_GET["authMode"]) {
                                 if ($this->checkPermissionBool("write")) {
                                         $this->serviceAuth($this->object);
                                 } else {
                                         ilUtil::sendFailure($lng->txt("cld_auth_failed"), true);
                                         ilObjectGUI::redirectToRefId($this->parent_id);
                                 }
                         }
                         $this->plugin_service = ilCloudConnector::getServiceClass($this->object->getServiceName(), $this->object->getId(), false);
                 }
 
                 $next_class = $ilCtrl->getNextClass($this);
 
                 $cmd = $ilCtrl->getCmd($this);
                 switch ($cmd) {
                         case "editSettings" :
                                 $next_class = "ilcloudpluginsettingsgui";
                                 break;
                         case "afterServiceAuth" :
                                 $this->checkPermission("write");
                                 $this->$cmd();
 
                                 return;
                         case "infoScreen":
                                 $this->prepareOutput();
                                 $this->infoScreenObject();
                                 return;
                         case "render" :
                                 $this->addHeaderAction();
                                 break;
                 }
 
                 switch ($next_class) {
                         case "ilinfoscreengui":
                                 $this->prepareOutput();
                                 $this->infoScreen();
                                 break;
                         case "ilcommonactiondispatchergui":
                                 include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
                                 $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                                 $this->ctrl->forwardCommand($gui);
                                 break;
                         case "ilpermissiongui":
                                 $this->prepareOutput();
                                 $ilTabs->activateTab("id_permissions");
                                 include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                                 $perm_gui = new ilPermissionGUI($this);
                                 $this->ctrl->forwardCommand($perm_gui);
                                 break;
                         case "ilcloudpluginuploadgui":
                                 if ($this->checkPermissionBool("upload")) {
                                         $upload_gui = ilCloudConnector::getUploadGUIClass($this->plugin_service);
                                         $this->ctrl->forwardCommand($upload_gui);
                                 }
                                 break;
                         case "ilcloudplugincreatefoldergui":
                                 if ($this->checkPermissionBool("folders_create")) {
                                         $folder_gui = ilCloudConnector::getCreateFolderGUIClass($this->plugin_service);
                                         $this->ctrl->forwardCommand($folder_gui);
                                 }
                                 break;
                         case "ilcloudplugindeletegui":
                                 if ($this->checkPermissionBool("delete_files") || $this->checkPermissionBool("delete_folders")) {
                                         $delete_gui = ilCloudConnector::getDeleteGUIClass($this->plugin_service);
                                         $this->ctrl->forwardCommand($delete_gui);
                                 }
                                 break;
                         case "ilcloudpluginsettingsgui":
                                 $this->prepareOutput();
                                 if ($this->checkPermissionBool("write")) {
                                         $settings_gui = ilCloudConnector::getSettingsGUIClass($this->plugin_service);
                                         $settings_gui->setCloudObject($this->object);
                                         $this->ctrl->forwardCommand($settings_gui);
                                 }
                                 break;
                         case "ilcloudpluginactionlistgui":
                                 $action_list_gui = ilCloudConnector::getActionListGUIClass($this->plugin_service);
                                 $this->ctrl->forwardCommand($action_list_gui);
                                 break;
                         case "ilcloudpluginitemcreationlistgui":
                                 $item_creation_gui = ilCloudConnector::getItemCreationListGUIClass($this->plugin_service);
                                 $this->ctrl->forwardCommand($item_creation_gui);
                                 break;
                         case "ilcloudpluginfiletreegui":
                                 $file_tree_gui = ilCloudConnector::getFileTreeGUIClass($this->plugin_service, ilCloudFileTree::getFileTreeFromSession());
                                 $this->ctrl->forwardCommand($file_tree_gui);
                                 break;
                         case "ilcloudpluginheaderactiongui":
                                 $header_action_gui = ilCloudConnector::getHeaderActionGUIClass($this->plugin_service);
                                 $this->ctrl->forwardCommand($header_action_gui);
                                 break;
                         case "ilcloudplugininitgui":
                                 $init_gui = ilCloudConnector::getInitGUIClass($this->plugin_service);
                                 $this->ctrl->forwardCommand($init_gui);
                                 break;
                         default:
                                 return parent::executeCommand();
                 }
 
                 return true;
         }

Here is the call graph for this function:

◆ getFile()

ilObjCloudGUI::getFile ( )

Definition at line 459 of file class.ilObjCloudGUI.php.

References $_GET, ilObject2GUI\checkPermissionBool(), ilCloudFileTree\getFileTreeFromSession(), and ilUtil\sendFailure().

                            {
                 global $ilTabs;
                 if ($this->checkPermissionBool("download")) {
                         try {
                                 $file_tree = ilCloudFileTree::getFileTreeFromSession();
                                 $file_tree->downloadFromService($_GET['id']);
                         } catch (Exception $e) {
                                 $ilTabs->activateTab("content");
                                 ilUtil::sendFailure($e->getMessage());
                         }
                 }
         }

Here is the call graph for this function:

◆ getStandardCmd()

ilObjCloudGUI::getStandardCmd ( )

Get standard command.

Definition at line 185 of file class.ilObjCloudGUI.php.

                                   {
                 return "render";
         }

◆ getType()

ilObjCloudGUI::getType ( )

final

Get type.

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

Referenced by ilCloudPluginInfoScreenGUI\getInfoScreen().

                                  {
                 return "cld";
         }

Here is the caller graph for this function:

◆ infoScreen()

ilObjCloudGUI::infoScreen ( )

show information screen

Definition at line 244 of file class.ilObjCloudGUI.php.

References $ilErr, $info, ilObject2GUI\checkPermissionBool(), and ilCloudConnector\getInfoScreenGUIClass().

Referenced by executeCommand(), and infoScreenObject().

                                      {
                 global $ilTabs, $ilErr;
 
                 $ilTabs->activateTab("id_info");
 
                 if (!$this->checkPermissionBool("visible")) {
                         $ilErr->raiseError($this->lng->txt("msg_no_perm_read"));
                 }
 
                 $plugin_info = ilCloudConnector::getInfoScreenGUIClass($this->plugin_service);
                 $info = $plugin_info->getInfoScreen($this);
                 $this->ctrl->forwardCommand($info);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ infoScreenObject()

ilObjCloudGUI::infoScreenObject ( )

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 211 of file class.ilObjCloudGUI.php.

References infoScreen().

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCreateForm()

ilObjCloudGUI::initCreateForm ( $a_new_type )

protected

Init object creation form.

Parameters

string $a_new_type

Returns: ilPropertyFormGUI

Definition at line 284 of file class.ilObjCloudGUI.php.

References ilObjectGUI\$lng, ilCloudConnector\getActiveServices(), ilCloudConnector\getCreationGUIClass(), ilCloudConnector\getPluginHookClass(), ilCloudConnector\getServiceClass(), ilObjectGUI\initDidacticTemplate(), ilTextAreaInputGUI\setCols(), ilFormPropertyGUI\setRequired(), ilTextInputGUI\setSize(), and ilObject\TITLE_LENGTH.

Referenced by afterSave(), and initCreationForms().

                                                        {
                 global $lng;
 
                 include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                 $form = new ilPropertyFormGUI();
                 $form->setTarget("_top");
                 $form->setFormAction($this->ctrl->getFormAction($this, "save"));
                 $form->setTitle($this->lng->txt($a_new_type . "_new"));
 
                 // title
                 $ti = new ilTextInputGUI($this->lng->txt("title"), "title");
                 $ti->setSize(min(40, ilObject::TITLE_LENGTH));
                 $ti->setMaxLength(ilObject::TITLE_LENGTH);
                 $ti->setRequired(true);
                 $form->addItem($ti);
 
                 // description
                 $ta = new ilTextAreaInputGUI($this->lng->txt("description"), "desc");
                 $ta->setCols(40);
                 $ta->setRows(2);
                 $form->addItem($ta);
 
                 $services_group = new ilRadioGroupInputGUI($lng->txt("cld_service"), "service");
                 $services_group->setRequired(true);
                 foreach (ilCloudConnector::getActiveServices() as $service) {
                         $option = new ilRadioOption($service, $service);
                         $hook_object = ilCloudConnector::getPluginHookClass($option->getValue());
                         $option->setTitle($hook_object->txt($service));
                         $option->setInfo($hook_object->txt("create_info"));
                         $this->plugin_service = ilCloudConnector::getServiceClass($service, 0, false);
                         $init_gui = ilCloudConnector::getCreationGUIClass($this->plugin_service);
                         if ($init_gui) {
                                 $init_gui->initPluginCreationFormSection($option);
                         }
                         $services_group->addOption($option);
                 }
 
                 //Select first radio-button by default
                 $services_group->setValue(array_shift($services_group->getOptions())->getValue());
 
                 $form->addItem($services_group);
 
                 $form = $this->initDidacticTemplate($form);
 
                 $form->addCommandButton("save", $this->lng->txt($a_new_type . "_add"));
                 $form->addCommandButton("cancel", $this->lng->txt("cancel"));
 
                 return $form;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCreationForms()

ilObjCloudGUI::initCreationForms ( $a_new_type )

protected

Init creation froms.

this will create the default creation forms: new, import, clone

Parameters

string $a_new_type

Returns: array

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

References initCreateForm().

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

Here is the call graph for this function:

◆ render()

ilObjCloudGUI::render ( )

Definition at line 425 of file class.ilObjCloudGUI.php.

References ilObject2GUI\checkPermissionBool(), and ilCloudConnector\getInitGUIClass().

                                  {
                 $init_gui = ilCloudConnector::getInitGUIClass($this->plugin_service);
                 $init_gui->initGUI($this, $this->checkPermissionBool("folders_create"), $this->checkPermissionBool("upload"), $this->checkPermissionBool("delete_files"), $this->checkPermissionBool("delete_folders"), $this->checkPermissionBool("download"), $this->checkPermissionBool("files_visible"), $this->checkPermissionBool("folders_visible"));
         }

Here is the call graph for this function:

◆ serviceAuth()

ilObjCloudGUI::serviceAuth ( ilObjCloud $object )

protected

Parameters

$object

Definition at line 365 of file class.ilObjCloudGUI.php.

References $ilCtrl, ilObject2\getId(), ilCloudConnector\getServiceClass(), ilObjCloud\getServiceName(), ilObjectGUI\redirectToRefId(), and ilUtil\sendFailure().

Referenced by afterSave(), and executeCommand().

                                                            {
                 global $ilCtrl;
                 try {
                         $service = ilCloudConnector::getServiceClass($object->getServiceName(), $object->getId());
                         $service->authService($ilCtrl->getLinkTarget($this, "afterServiceAuth") . "&authMode=true");
                 } catch (Exception $e) {
                         ilUtil::sendFailure($e->getMessage(), true);
                         ilObjectGUI::redirectToRefId($this->parent_id);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTabs()

ilObjCloudGUI::setTabs ( )

Definition at line 220 of file class.ilObjCloudGUI.php.

References $ilCtrl, and ilObjectGUI\$lng.

                                   {
                 global $ilTabs, $ilCtrl, $ilAccess, $lng;
 
                 // tab for the "show content" command
                 if ($ilAccess->checkAccess("read", "", $this->object->getRefId())) {
                         $ilTabs->addTab("content", $lng->txt("content"), $ilCtrl->getLinkTarget($this, "render"));
                         $ilTabs->addTab("id_info", $lng->txt("info_short"), $this->ctrl->getLinkTargetByClass("ilinfoscreengui", "showSummary"));
                 }
 
                 // a "properties" tab
                 if ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
                         $ilTabs->addTab("settings", $lng->txt("settings"), $ilCtrl->getLinkTargetByClass("ilcloudpluginsettingsgui", "editSettings"));
                 }
 
                 // edit permissions
                 if ($ilAccess->checkAccess('edit_permission', "", $this->object->getRefId())) {
                         $ilTabs->addTab("id_permissions", $lng->txt("perm_settings"), $this->ctrl->getLinkTargetByClass("ilpermissiongui", "perm"));
                 }
         }

Field Documentation

◆ $plugin_service

ilObjCloudGUI::$plugin_service

protected

ilCloudPluginService

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

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

Modules/Cloud/classes/class.ilObjCloudGUI.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _goto()

◆ addHeaderAction()

◆ addLocatorItems()

◆ afterSave()

◆ afterServiceAuth()

◆ asyncGetActionListContent()

◆ asyncGetBlock()

◆ executeCommand()

◆ getFile()

◆ getStandardCmd()

◆ getType()

◆ infoScreen()

◆ infoScreenObject()

◆ initCreateForm()

◆ initCreationForms()

◆ render()

◆ serviceAuth()

◆ setTabs()

Field Documentation

◆ $plugin_service