ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilObjFileAccessSettingsGUI Class Reference

Class ilObjFileAccessSettingsGUI. More...

+ Inheritance diagram for ilObjFileAccessSettingsGUI:
+ Collaboration diagram for ilObjFileAccessSettingsGUI:

Public Member Functions

 __construct ($a_data, int $a_id, bool $a_call_by_reference)
 Constructor. More...
 
 executeCommand ()
 
 getAdminTabs ()
 administration tabs show only permissions and trash folder More...
 
- Public Member Functions inherited from ilObjectGUI
 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] does belong to the parent 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...
 
 cancelObject ()
 cancel action and go back to previous page More...
 
 createObject ()
 create new object form More...
 
 editAvailabilityPeriodObject ()
 
 saveAvailabilityPeriodObject ()
 
 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)
 
 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'
 
const CMD_SHOW_PREVIEW_RENDERERS = 'showPreviewRenderers'
 
const SUBTAB_SUFFIX_SPECIFIC_ICONS = 'suffix_specific_icons'
 
const CMD_SAVE_SETTINGS = 'saveSettings'
 
const CMD_VIEW = 'view'
 
- Data Fields inherited from ilObjectGUI
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
 
const SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]
 

Protected Member Functions

 checkAccess (string $permission)
 
 addFileObjectsSubTabs ()
 
 editSettings ()
 
 saveSettings ()
 
- Protected Member Functions inherited from ilObjectGUI
 getObjectService ()
 
 assignObject ()
 
 setTitleAndDescription ()
 
 createActionDispatcherGUI ()
 
 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...
 
 getCreationFormsHTML (StandardForm|ilPropertyFormGUI|array $form)
 
 getTitleForCreationFormPage ()
 
 getCreationFormTitle ()
 
 initCreateForm (string $new_type)
 
 didacticTemplatesToForm ()
 
 initDidacticTemplate (ilPropertyFormGUI $form)
 
 retrieveAdditionalDidacticTemplateOptions ()
 
 addAdoptContentLinkToToolbar ()
 
 addImportButtonToToolbar ()
 
 addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)
 
 parseDidacticTemplateVar (string $var, string $type)
 
 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...
 
 routeImportCmdObject ()
 
 importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)
 
 deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)
 
 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 ()
 @abstract 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...
 
 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...
 
 getCreatableObjectTypes ()
 
 buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)
 
 buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)
 

Protected Attributes

Factory $ui_factory
 
Renderer $ui_renderer
 
- Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service $notes_service
 
GlobalHttpState $http
 
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
 
Refinery $refinery
 
ilFavouritesManager $favourites
 
CustomIconFactory $custom_icon_factory
 
UIFactory $ui_factory
 
UIRenderer $ui_renderer
 
Filesystem $temp_file_system
 
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

 buildForm ()
 

Private Attributes

ilLanguage $language
 
Form $preview_settings
 
ILIAS components File Settings Form $file_object_settings
 

Additional Inherited Members

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

Author
Werner Randelshofer, Hochschule Luzern, werne.nosp@m.r.ra.nosp@m.ndels.nosp@m.hofe.nosp@m.r@hsl.nosp@m.u.ch
Version
$Id$

@ilCtrl_Calls ilObjFileAccessSettingsGUI: ilPermissionGUI @ilCtrl_Calls ilObjFileAccessSettingsGUI: ILIAS\File\Icon\ilObjFileIconsOverviewGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjFileAccessSettingsGUI::__construct (   $a_data,
int  $a_id,
bool  $a_call_by_reference 
)

Constructor.

@access public

Definition at line 58 of file class.ilObjFileAccessSettingsGUI.php.

59 {
60 global $DIC;
61 $this->type = "facs";
62 parent::__construct($a_data, $a_id, $a_call_by_reference, false);
63 $this->preview_settings = new Form(new Settings());
64 $this->file_object_settings = new \ILIAS\components\File\Settings\Form(new General());
65 $this->ui_factory = $DIC->ui()->factory();
66 $this->ui_renderer = $DIC->ui()->renderer();
67 $this->language = $DIC->language();
68 }
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
global $DIC
Definition: shib_login.php:26

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

+ Here is the call graph for this function:

Member Function Documentation

◆ addFileObjectsSubTabs()

ilObjFileAccessSettingsGUI::addFileObjectsSubTabs ( )
protected

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

153 : void
154 {
155 $this->tabs_gui->addSubTabTarget(
156 "settings",
157 $this->ctrl->getLinkTarget($this, self::CMD_EDIT_SETTINGS),
158 [self::CMD_EDIT_SETTINGS, "view"]
159 );
160 $this->tabs_gui->addSubTabTarget(
161 self::SUBTAB_SUFFIX_SPECIFIC_ICONS,
162 $this->ctrl->getLinkTargetByClass(ilObjFileIconsOverviewGUI::class, ilObjFileIconsOverviewGUI::CMD_INDEX),
163 [ilObjFileIconsOverviewGUI::CMD_INDEX, "view"]
164 );
165 }

References ILIAS\Repository\ctrl().

Referenced by editSettings(), and executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ buildForm()

ilObjFileAccessSettingsGUI::buildForm ( )
private

Definition at line 80 of file class.ilObjFileAccessSettingsGUI.php.

80 : Standard
81 {
82 return $this->ui_factory->input()->container()->form()->standard(
83 $this->ctrl->getLinkTarget($this, self::CMD_SAVE_SETTINGS),
84 [
85 $this->file_object_settings->asFormSection(),
86 $this->preview_settings->asFormSection(),
87 ]
88 );
89 }
This describes a standard form.
Definition: Standard.php:29

References ILIAS\Repository\ctrl().

Referenced by editSettings(), and saveSettings().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ checkAccess()

ilObjFileAccessSettingsGUI::checkAccess ( string  $permission)
protected

Definition at line 70 of file class.ilObjFileAccessSettingsGUI.php.

70 : void
71 {
72 if (!$this->access->checkAccess($permission, '', $this->object->getRefId())) {
73 $this->ilias->raiseError(
74 $this->lng->txt('no_permission'),
75 $this->ilias->error_obj->MESSAGE
76 );
77 }
78 }
Class ilObjForumAdministration.

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

Referenced by executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ editSettings()

ilObjFileAccessSettingsGUI::editSettings ( )
protected

Definition at line 168 of file class.ilObjFileAccessSettingsGUI.php.

168 : void
169 {
170 $this->addFileObjectsSubTabs();
171 $this->tabs_gui->setSubTabActive("settings");
172 $form = $this->buildForm();
173 $this->tpl->setContent($this->ui_renderer->render($this->buildForm()));
174 }

References addFileObjectsSubTabs(), and buildForm().

Referenced by executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ executeCommand()

ilObjFileAccessSettingsGUI::executeCommand ( )

Reimplemented from ilObjectGUI.

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

92 : void
93 {
94 $this->lng->loadLanguageModule("file");
95
96 $this->prepareOutput();
97
98 $this->checkAccess('read');
99
100 switch ($this->ctrl->getNextClass($this)) {
101 case 'ilpermissiongui':
102 $this->tabs_gui->setTabActive('perm_settings');
103 $perm_gui = new ilPermissionGUI($this);
104 $this->ctrl->forwardCommand($perm_gui);
105 break;
106 case strtolower(ilObjFileIconsOverviewGUI::class):
107 $this->tabs_gui->setTabActive('file_objects');
108 $this->addFileObjectsSubTabs();
109 $this->tabs_gui->setSubTabActive(self::SUBTAB_SUFFIX_SPECIFIC_ICONS);
110 $icon_overview = new ilObjFileIconsOverviewGUI();
111 $this->ctrl->forwardCommand($icon_overview);
112 break;
113 default:
114 $cmd = $this->ctrl->getCmd(self::CMD_EDIT_SETTINGS);
115 $this->tabs_gui->setTabActive('file_objects');
116 switch ($cmd) {
117 case self::CMD_VIEW:
119 $this->checkAccess('read');
120 $this->editSettings();
121 break;
123 $this->checkAccess('write');
124 $this->saveSettings();
125 break;
126 default:
127 throw new ilException("ilObjFileAccessSettingsGUI: Command not found: $cmd");
128 }
129 break;
130 }
131 }
Base class for ILIAS Exception handling.
prepareOutput(bool $show_sub_objects=true)

References addFileObjectsSubTabs(), checkAccess(), CMD_EDIT_SETTINGS, CMD_SAVE_SETTINGS, CMD_VIEW, ILIAS\Repository\ctrl(), editSettings(), ILIAS\Repository\lng(), ilObjectGUI\prepareOutput(), and saveSettings().

+ Here is the call graph for this function:

◆ getAdminTabs()

ilObjFileAccessSettingsGUI::getAdminTabs ( )

administration tabs show only permissions and trash folder

Reimplemented from ilObjectGUI.

Definition at line 134 of file class.ilObjFileAccessSettingsGUI.php.

134 : void
135 {
136 if ($this->rbac_system->checkAccess("visible,read", $this->object->getRefId())) {
137 $this->tabs_gui->addTarget(
138 'file_objects',
139 $this->ctrl->getLinkTarget($this, self::CMD_EDIT_SETTINGS),
140 [self::CMD_EDIT_SETTINGS, self::CMD_VIEW]
141 );
142 }
143 if ($this->rbac_system->checkAccess('edit_permission', $this->object->getRefId())) {
144 $this->tabs_gui->addTarget(
145 "perm_settings",
146 $this->ctrl->getLinkTargetByClass('ilpermissiongui', "perm"),
147 [],
148 'ilpermissiongui'
149 );
150 }
151 }

References ILIAS\Repository\ctrl().

+ Here is the call graph for this function:

◆ saveSettings()

ilObjFileAccessSettingsGUI::saveSettings ( )
protected

Definition at line 176 of file class.ilObjFileAccessSettingsGUI.php.

176 : void
177 {
178 $form = $this->buildForm();
179 $form = $form->withRequest($this->http->request());
180
181 if ($form->getData() === null) {
182 $this->tpl->setContent($this->ui_renderer->render($form));
183 return;
184 }
185
186 $this->tpl->setOnScreenMessage(
187 'success',
188 $this->language->txt('settings_saved'),
189 true
190 );
191 $this->ctrl->redirect($this, self::CMD_EDIT_SETTINGS);
192 }
static http()
Fetches the global http state from ILIAS.

References buildForm(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $file_object_settings

ILIAS components File Settings Form ilObjFileAccessSettingsGUI::$file_object_settings
private

Definition at line 49 of file class.ilObjFileAccessSettingsGUI.php.

◆ $language

ilLanguage ilObjFileAccessSettingsGUI::$language
private

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

◆ $preview_settings

Form ilObjFileAccessSettingsGUI::$preview_settings
private

Definition at line 48 of file class.ilObjFileAccessSettingsGUI.php.

◆ $ui_factory

Factory ilObjFileAccessSettingsGUI::$ui_factory
protected

Definition at line 50 of file class.ilObjFileAccessSettingsGUI.php.

◆ $ui_renderer

Renderer ilObjFileAccessSettingsGUI::$ui_renderer
protected

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

◆ CMD_EDIT_SETTINGS

const ilObjFileAccessSettingsGUI::CMD_EDIT_SETTINGS = 'editSettings'

Definition at line 42 of file class.ilObjFileAccessSettingsGUI.php.

Referenced by executeCommand().

◆ CMD_SAVE_SETTINGS

const ilObjFileAccessSettingsGUI::CMD_SAVE_SETTINGS = 'saveSettings'

Definition at line 45 of file class.ilObjFileAccessSettingsGUI.php.

Referenced by executeCommand().

◆ CMD_SHOW_PREVIEW_RENDERERS

const ilObjFileAccessSettingsGUI::CMD_SHOW_PREVIEW_RENDERERS = 'showPreviewRenderers'

Definition at line 43 of file class.ilObjFileAccessSettingsGUI.php.

◆ CMD_VIEW

const ilObjFileAccessSettingsGUI::CMD_VIEW = 'view'

Definition at line 46 of file class.ilObjFileAccessSettingsGUI.php.

Referenced by executeCommand().

◆ SUBTAB_SUFFIX_SPECIFIC_ICONS

const ilObjFileAccessSettingsGUI::SUBTAB_SUFFIX_SPECIFIC_ICONS = 'suffix_specific_icons'

Definition at line 44 of file class.ilObjFileAccessSettingsGUI.php.


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