Inheritance diagram for ilObjFileServicesGUI:

Collaboration diagram for ilObjFileServicesGUI:

Public Member Functions
	__construct (int $id=0, int $id_type=self::REPOSITORY_NODE_ID, int $parent_node_id=0)
	Constructor public. More...

	getType ()

	executeCommand ()
	Execute command public. More...

	getAdminTabs ()
	Get tabs. More...

	setTitleAndDescription ()

Public Member Functions inherited from ilObject2GUI
	__construct (int $id=0, int $id_type=self::REPOSITORY_NODE_ID, int $parent_node_id=0)

	executeCommand ()
	execute command More...

	getIdType ()

	delete ()
	Display delete confirmation form (repository/workspace switch) More...

	confirmedDelete ()
	Delete objects (repository/workspace switch) More...

	getHTML ()

	withReferences ()
	Final/Private declaration of unchanged parent methods. More...

	setCreationMode (bool $mode=true)

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	isVisible (int $ref_id, string $type)

	setColumnSettings (ilColumnGUI $column_gui)

	cancelDelete ()

	view ()
	view object content (repository/workspace switch) More...

	getType ()
	Functions that must be overwritten. More...

	create ()
	CRUD. More...

	save ()

	edit ()

	update ()

	cancel ()

	importFile ()

	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...

Public Member Functions inherited from ilObjectGUI
	__construct ($data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true)

	getRefId ()

	setAdminMode (string $mode)

	getAdminMode ()

	getObject ()

	executeCommand ()

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	setCreationMode (bool $mode=true)
	if true, a creation screen is displayed the current [ref_id] don't belong to the current class! The mode is determined in ilRepositoryGUI More...

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	getHTML ()

	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...

	cancelDeleteObject ()
	cancel deletion of object More...

	cancelObject ()
	cancel action and go back to previous page More...

	createObject ()
	create new object form More...

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()

	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()

	addExternalEditFormCustom (ilPropertyFormGUI $form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...

	isVisible (int $ref_id, string $type)

	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...

	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...

	setColumnSettings (ilColumnGUI $column_gui)

	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen. More...

	addToDeskObject ()

	removeFromDeskObject ()

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Data Fields
const	CMD_EDIT_SETTINGS = 'editSettings'

ilLanguage	$lng

ilErrorHandling	$error_handling

ilGlobalTemplateInterface	$tpl

Data Fields inherited from ilObject2GUI
const	OBJECT_ID = 0

const	REPOSITORY_NODE_ID = 1

const	WORKSPACE_NODE_ID = 2

const	REPOSITORY_OBJECT_ID = 3

const	WORKSPACE_OBJECT_ID = 4

const	PORTFOLIO_OBJECT_ID = 5

Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION

const	ADMIN_MODE_NONE = ""

const	ADMIN_MODE_SETTINGS = "settings"

const	ADMIN_MODE_REPOSITORY = "repository"

const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

Protected Member Functions
	checkPermissionOrFail (string $str)

	hasUserPermissionTo (string $str)

	editSettings ()

	saveSettings ()

Protected Member Functions inherited from ilObject2GUI
	afterConstructor ()
	Do anything that should be done after constructor in here. More...

	assignObject ()
	create object instance as internal property (repository/workspace switch) More...

	getAccessHandler ()

	setLocator ()
	set Locator More...

	deleteConfirmedObjects ()
	Delete objects (workspace specific) This should probably be moved elsewhere as done with RepUtil. More...

	setTitleAndDescription ()

	omitLocator (bool $omit=true)

	getTargetFrame (string $cmd, string $target_frame="")

	setTargetFrame (string $cmd, string $target_frame)

	getCenterColumnHTML ()

	getRightColumnHTML ()

	checkPermission (string $perm, string $cmd="", string $type="", int $ref_id=null)

	showPossibleSubObjects ()

	redirectToRefId (int $ref_id, string $cmd="")

	fillCloneTemplate (?string $tpl_varname, string $type)

	addAdminLocatorItems (bool $do_not_add_object=false)

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

	getReturnLocation (string $cmd, string $location="")
	Deprecated functions. More...

	setReturnLocation (string $cmd, string $location)

	showActions ()

	getTabs ()

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

	initCreationForms (string $new_type)
	Init creation forms. More...

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $node_id=null)

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	redrawHeaderAction ()
	Updating icons after ajax call. More...

	getPermanentLinkWidget (string $append=null, bool $center=false)

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()

	assignObject ()

	setTitleAndDescription ()

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...

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

	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...

	setTabs ()
	set admin tabs More...

	setAdminTabs ()
	set admin tabs More...

	setLocator ()

	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...

	omitLocator (bool $omit=true)

	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	initCreationForms (string $new_type)
	Init creation forms. More...

	getCreationFormsHTML (array $forms)
	Get HTML for creation forms (accordion) More...

	initCreateForm (string $new_type)

	initDidacticTemplate (ilPropertyFormGUI $form)

	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...

	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...

	initEditForm ()

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormValues ()

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	initImportForm (string $new_type)

	importFileObject (int $parent_id=null)

	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...

	setFormAction (string $cmd, string $form_action)

	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...

	getTabs ()
	overwrite in derived GUI class of your object type More...

	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...

	fillCloneTemplate (?string $tpl_name, string $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...

	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

	showCustomIconsEditing ( $input_colspan=1, ilPropertyFormGUI $form=null, $as_section=true)
	show edit section of custom icons for container More...

Protected Attributes
ilTabsGUI	$tabs

ilCtrl	$ctrl

ilSetting	$settings

Factory	$refinery

WrapperFactory	$http

ilFileServicesSettings	$file_service_settings

Protected Attributes inherited from ilObject2GUI
ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ilObjectService	$object_service

ilFavouritesManager	$favourites

ilErrorHandling	$error

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilToolbarGUI	$toolbar

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Factory	$refinery

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

int	$request_ref_id

int	$id_type

int	$parent_id

string	$type

string	$html

int	$object_id

int	$node_id = null

array	$creation_forms = array()

	$access_handler

Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service

ServerRequestInterface	$request

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilSetting	$settings

ilToolbarGUI	$toolbar

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

ilObjectService	$object_service

ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilTree	$tree

ilCtrl	$ctrl

ilErrorHandling	$error

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ILIAS	$ilias

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Factory	$refinery

ilFavouritesManager	$favourites

ilObjectCustomIconFactory	$custom_icon_factory

ilObject	$object = null

bool	$creation_mode = false

	$data

int	$id

bool	$call_by_reference = false

bool	$prepare_output

int	$ref_id

int	$obj_id

int	$maxcount

array	$form_action = []

array	$return_location = []

array	$target_frame = []

string	$tmp_import_dir

string	$sub_objects = ""

bool	$omit_locator = false

string	$type = ""

string	$admin_mode = self::ADMIN_MODE_NONE

int	$requested_ref_id = 0

int	$requested_crtptrefid = 0

int	$requested_crtcb = 0

string	$requested_new_type = ""

string	$link_params

string	$html = ""

Private Member Functions
	initSettingsForm ()

Additional Inherited Members
Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $obj, ?int $callback_ref_id)
	After creation callback. More...

Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode (int $ref_id, string $cmd="")

static	_gotoSharedWorkspaceNode (int $wsp_id)

Detailed Description

Class ilObjFileServicesGUI.

Author: Lukas Zehnder lz@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch ilObjFileServicesGUI: ilAdministrationGUI ilObjFileServicesGUI: ilPermissionGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjFileServicesGUI::__construct	(	int	$id = `0`,
		int	$id_type = `self::REPOSITORY_NODE_ID`,
		int	$parent_node_id = `0`
	)

Constructor public.

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

References $DIC, ilObjectGUI\$id, ilObject2GUI\$id_type, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), and ilObjFileServices\TYPE_FILE_SERVICES.

     {
         global $DIC;
 
         $this->type = ilObjFileServices::TYPE_FILE_SERVICES;
         parent::__construct($id, $id_type, $parent_node_id);
 
         $this->tabs = $DIC['ilTabs'];
         $this->lng = $DIC->language();
         $this->lng->loadLanguageModule('adn');
         $this->ctrl = $DIC['ilCtrl'];
         $this->tpl = $DIC['tpl'];
         $this->tree = $DIC['tree'];
         $this->settings = $DIC['ilSetting'];
         $this->error_handling = $DIC["ilErr"];
         $this->http = $DIC->http()->wrapper();
         $this->ref_id = $this->http->query()->retrieve('ref_id', $DIC->refinery()->kindlyTo()->int());
         $this->refinery = $DIC->refinery();
         $this->file_service_settings = $DIC->fileServiceSettings();
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkPermissionOrFail()

ilObjFileServicesGUI::checkPermissionOrFail ( string $str )

protected

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

References hasUserPermissionTo(), and ILIAS\Repository\lng().

Referenced by editSettings(), executeCommand(), and saveSettings().

                                                          : void
     {
         if (!$this->hasUserPermissionTo($str)) {
             $this->error_handling->raiseError(
                 $this->lng->txt('no_permission'),
                 $this->error->MESSAGE
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editSettings()

ilObjFileServicesGUI::editSettings ( )

protected

Definition at line 216 of file class.ilObjFileServicesGUI.php.

References checkPermissionOrFail(), and initSettingsForm().

                                      : void
     {
         $this->tabs_gui->setTabActive('settings');
 
         $this->checkPermissionOrFail("visible,read");
 
         // get form
         $form = $this->initSettingsForm();
 
         // set current values
         $val = [];
         $val["suffix_repl_additional"] = implode(", ", $this->file_service_settings->getWhiteListNegative());
         $val["suffix_custom_white_list"] = implode(", ", $this->file_service_settings->getWhiteListPositive());
         $val["suffix_custom_expl_black"] = implode(", ", $this->file_service_settings->getProhibited());
         $form->setValuesByArray($val);
 
         // set content
         $this->tpl->setContent($form->getHTML());
     }

Here is the call graph for this function:

◆ executeCommand()

ilObjFileServicesGUI::executeCommand ( )

Execute command public.

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

References checkPermissionOrFail(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilObject2GUI\prepareOutput().

                                     : void
     {
         $this->lng->loadLanguageModule("fils");
 
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd();
 
         $this->prepareOutput();
         $this->checkPermissionOrFail('read');
 
         switch ($next_class) {
             case 'ilpermissiongui':
                 $this->tabs_gui->setTabActive('perm_settings');
                 $perm_gui = new ilPermissionGUI($this);
                 $this->ctrl->forwardCommand($perm_gui);
                 break;
             default:
                 if (!$cmd || $cmd === 'view') {
                     $cmd = self::CMD_EDIT_SETTINGS;
                 }
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ getAdminTabs()

ilObjFileServicesGUI::getAdminTabs ( )

Get tabs.

Definition at line 120 of file class.ilObjFileServicesGUI.php.

References ILIAS\Repository\ctrl().

                                   : void
     {
         if ($this->rbac_system->checkAccess(
             "visible,read",
             $this->object->getRefId()
         )
         ) {
             $this->tabs_gui->addTarget(
                 'settings',
                 $this->ctrl->getLinkTarget($this, self::CMD_EDIT_SETTINGS),
                 [self::CMD_EDIT_SETTINGS, "view"]
             );
         }
         if ($this->rbac_system->checkAccess(
             'edit_permission',
             $this->object->getRefId()
         )
         ) {
             $this->tabs_gui->addTarget(
                 "perm_settings",
                 $this->ctrl->getLinkTargetByClass(ilPermissionGUI::class, "perm"),
                 [],
                 ilPermissionGUI::class
             );
         }
     }

Here is the call graph for this function:

◆ getType()

ilObjFileServicesGUI::getType ( )

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

References ilObjFileServices\TYPE_FILE_SERVICES.

                              : string
     {
         return ilObjFileServices::TYPE_FILE_SERVICES;
     }

◆ hasUserPermissionTo()

ilObjFileServicesGUI::hasUserPermissionTo ( string $str )

protected

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

References ILIAS\Repository\access().

Referenced by checkPermissionOrFail(), and initSettingsForm().

                                                        : bool
     {
         return $this->access->checkAccess($str, '', $this->ref_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSettingsForm()

ilObjFileServicesGUI::initSettingsForm ( )

private

Definition at line 153 of file class.ilObjFileServicesGUI.php.

References ILIAS\Repository\ctrl(), hasUserPermissionTo(), ILIAS\Repository\lng(), ilFormPropertyGUI\setInfo(), and ilNonEditableValueGUI\setValue().

Referenced by editSettings(), and saveSettings().

                                        : ilPropertyFormGUI
     {
         $permission_to_write = $this->hasUserPermissionTo('write');
 
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this));
         $form->setTitle($this->lng->txt("settings"));
 
         // default positive list
         $ne = new ilNonEditableValueGUI($this->lng->txt("file_suffix_default_positive"), "");
         $ne->setValue(implode(", ", $this->file_service_settings->getDefaultWhitelist()));
         $ne->setInfo($this->lng->txt("file_suffix_default_positive_info"));
         $form->addItem($ne);
 
         // file suffix custom negative list
         $ta = new ilTextAreaInputGUI(
             $this->lng->txt(
                 "file_suffix_custom_negative"
             ),
             "suffix_repl_additional"
         );
         $ta->setInfo($this->lng->txt("file_suffix_custom_negative_info"));
         $ta->setRows(5);
         $ta->setDisabled(!$permission_to_write);
         $form->addItem($ta);
 
         // file suffix custom positive list
         $ta = new ilTextAreaInputGUI(
             $this->lng->txt(
                 "file_suffix_custom_positive"
             ),
             "suffix_custom_white_list"
         );
         $ta->setInfo($this->lng->txt("file_suffix_custom_positive_info"));
         $ta->setRows(5);
         $ta->setDisabled(!$permission_to_write);
         $form->addItem($ta);
 
         // resulting overall positive list
         $ne = new ilNonEditableValueGUI($this->lng->txt("file_suffix_overall_positive"), "");
         $ne->setValue(implode(", ", $this->file_service_settings->getWhiteListedSuffixes()));
         $ne->setInfo($this->lng->txt("file_suffix_overall_positive_info"));
         $form->addItem($ne);
 
         // explicit negative list
         $ta = new ilTextAreaInputGUI(
             $this->lng->txt("file_suffix_custom_expl_negative"),
             "suffix_custom_expl_black"
         );
         $ta->setInfo($this->lng->txt("file_suffix_custom_expl_negative_info"));
         $ta->setRows(5);
         $ta->setDisabled(!$permission_to_write);
         $form->addItem($ta);
 
         // command buttons
         if ($permission_to_write) {
             $form->addCommandButton('saveSettings', $this->lng->txt('save'));
             $form->addCommandButton('view', $this->lng->txt('cancel'));
         }
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveSettings()

ilObjFileServicesGUI::saveSettings ( )

protected

Definition at line 236 of file class.ilObjFileServicesGUI.php.

References ilObjectGUI\$id, checkPermissionOrFail(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), initSettingsForm(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\settings().

                                      : void
     {
         $this->checkPermissionOrFail("write");
 
         // get form
         $form = $this->initSettingsForm();
         if ($form->checkInput()) {
             $trafo = function (string $id): ?string {
                 return $this->http->post()->has($id)
                     ? $this->http->post()->retrieve($id, $this->refinery->to()->string())
                     : null;
             };
 
 
             $this->settings->set("suffix_repl_additional", $trafo("suffix_repl_additional"));
             $this->settings->set("suffix_custom_white_list", $trafo("suffix_custom_white_list"));
             $this->settings->set("suffix_custom_expl_black", $trafo("suffix_custom_expl_black"));
 
             $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
             $this->ctrl->redirect($this, self::CMD_EDIT_SETTINGS);
         } else {
             $form->setValuesByPost();
             $this->tpl->setContent($form->getHTML());
         }
     }

Here is the call graph for this function:

◆ setTitleAndDescription()

ilObjFileServicesGUI::setTitleAndDescription ( )

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

References ILIAS\Repository\object().

                                             : void
     {
         parent::setTitleAndDescription();
         $this->tpl->setDescription($this->object->getDescription());
     }