ILIAS  trunk Revision v12.0_alpha-377-g3641b37b9db
Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes | Private Attributes
ilObjFileGUI Class Reference

GUI class for file objects. More...

+ Inheritance diagram for ilObjFileGUI:
+ Collaboration diagram for ilObjFileGUI:

Public Member Functions

 __construct (int $a_id=0, int $a_id_type=self::REPOSITORY_NODE_ID, int $a_parent_node_id=0)
 Constructor. More...
 
 getType ()
 Functions that must be overwritten. More...
 
 getParentId ()
 
 initUploadForm ()
 
 putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
 Add object to tree at given position. More...
 
 edit ()
 
 sendFile ()
 
 showSummary ()
 
 showSummaryForced ()
 
 versions ()
 
 unzipCurrentRevision ()
 
 infoScreenForward ()
 show information screen More...
 
 buildInfoScreen (bool $kiosk_mode)
 
- 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)
 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)
 
 isVisible (int $ref_id, string $type)
 
 setColumnSettings (ilColumnGUI $column_gui)
 
 view ()
 view object content (repository/workspace switch) More...
 
 getType ()
 Functions that must be overwritten. More...
 
 create ()
 CRUD. More...
 
 save ()
 
 edit ()
 
 update ()
 
 cancel ()
 
 putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
 Add object to tree at given position. 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)
 

Static Public Member Functions

static _goto ($a_target, $a_additional=null)
 
- 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)
 

Data Fields

const UPLOAD_MAX_FILES = 100
 
const PARAM_FILES = 'files'
 
const PARAM_TITLE = 'title'
 
const PARAM_DESCRIPTION = 'description'
 
const PARAM_COPYRIGHT_ID = "copyright_id"
 
const PARAM_UPLOAD_ORIGIN = 'origin'
 
const UPLOAD_ORIGIN_STANDARD = 'standard'
 
const UPLOAD_ORIGIN_DROPZONE = 'dropzone'
 
const CMD_EDIT = Capabilities::EDIT_SETTINGS->value
 
const CMD_VERSIONS = Capabilities::MANAGE_VERSIONS->value
 
const CMD_UPLOAD_FILES = "uploadFiles"
 
const CMD_SEND_FILE = Capabilities::DOWNLOAD->value
 
ilObject $object = null
 
ilLanguage $lng
 
- 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 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

 updateLearningProgress ()
 
 addUIFormToAccordion (ilAccordionGUI $accordion, Standard $form, int $form_type)
 
 addLegacyFormToAccordion (ilAccordionGUI $accordion, ilPropertyFormGUI $form, int $form_type)
 
 initCreateForm (string $new_type)
 
 getCreationFormTitle ()
 
 uploadFiles ()
 MUST be protected, since this is Called from ilObject2GUI when used in Personal Workspace. More...
 
 initPropertiesForm ()
 
 editExternal ()
 
 viewExternal ()
 
 toggleLearningProgress ()
 
 setTabs ()
 create tabs (repository/workspace switch) More...
 
 initSettingsTab ()
 
 addLocatorItems ()
 Functions to be overwritten. More...
 
 initHeaderAction (?string $a_sub_type=null, ?int $a_sub_id=null)
 Add header action menu. More...
 
 getCtrl ()
 
 getFileObj ()
 
 getFileStakeholder ()
 
 getGeneralSettings ()
 
 getLanguage ()
 
 getNodeID ()
 
 getRefinery ()
 
 getUIFactory ()
 
 getUser ()
 
- 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="")
 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...
 
 getCenterColumnHTML ()
 Get center column. More...
 
 getRightColumnHTML ()
 Display right column. More...
 
 checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
 
 showPossibleSubObjects ()
 show possible sub objects (pull down menu) 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...
 
 addAdminLocatorItems (bool $do_not_add_object=false)
 should be overwritten to add object specific items (repository items are preloaded) More...
 
 setTabs ()
 create tabs (repository/workspace switch) More...
 
 getReturnLocation (string $cmd, string $location="")
 Deprecated functions. More...
 
 setReturnLocation (string $cmd, string $location)
 set specific return location for command More...
 
 showActions ()
 
 getTabs ()
 @abstract overwrite in derived GUI class of your object type More...
 
 addLocatorItems ()
 Functions to be overwritten. 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...
 
- 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

UIServices $ui
 
UploadHandler $upload_handler
 
ResourceStakeholder $stakeholder
 
Services $storage
 
ilLogger $log = null
 
ilObjectService $obj_service
 
ILIAS Refinery Factory $refinery
 
General $general_settings
 
ilFileServicesSettings $file_service_settings
 
IconDatabaseRepository $icon_repo
 
ILIAS UI Component Input Factory $inputs
 
Renderer $renderer
 
ServerRequestInterface $request
 
Factory $data_factory
 
LOMServices $lom_services
 
- Protected Attributes inherited from ilObject2GUI
ilObjectDefinition $obj_definition
 
ilGlobalTemplateInterface $tpl
 
ilCtrl $ctrl
 
ilLanguage $lng
 
ilTabsGUI $tabs_gui
 
ilFavouritesManager $favourites
 
ilErrorHandling $error
 
ilLocatorGUI $locator
 
ilObjUser $user
 
ilAccessHandler $access
 
ilToolbarGUI $toolbar
 
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 = []
 
 $access_handler
 
- 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 Attributes

CapabilityCollection $capabilities
 
ActionDBRepository $action_repo
 

Detailed Description

GUI class for file objects.

Author
Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e
Stefan Born stefa.nosp@m.n.bo.nosp@m.rn@ph.nosp@m.zh.c.nosp@m.h
Version
$Id$ @ilCtrl_Calls ilObjFileGUI: ilObjectMetaDataGUI, ilInfoScreenGUI, ilPermissionGUI, ilObjectCopyGUI @ilCtrl_Calls ilObjFileGUI: ilExportGUI, ilWorkspaceAccessGUI, ilPortfolioPageGUI, ilCommonActionDispatcherGUI @ilCtrl_Calls ilObjFileGUI: ilLearningProgressGUI, ilFileVersionsGUI, ilWOPIEmbeddedApplicationGUI @ilCtrl_Calls ilObjFileGUI: ilFileCommonSettingsGUI

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Reimplemented from ilObject2GUI.

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

103 {
104 global $DIC;
105 $this->refinery = $DIC->refinery();
106 $this->file_service_settings = $DIC->fileServiceSettings();
107 $this->user = $DIC->user();
108 $this->lng = $DIC->language();
109 $this->log = ilLoggerFactory::getLogger(ilObjFile::OBJECT_TYPE);
110 $this->ui = $DIC->ui();
111 $this->storage = $DIC->resourceStorage();
112 $this->upload_handler = new ilObjFileUploadHandlerGUI();
113 $this->stakeholder = new ilObjFileStakeholder();
114 $this->general_settings = new General();
115 parent::__construct($a_id, $a_id_type, $a_parent_node_id);
116 $this->obj_service = $DIC->object();
117 $this->lng->loadLanguageModule(ilObjFile::OBJECT_TYPE);
118 $this->icon_repo = new IconDatabaseRepository();
119 $this->inputs = $DIC->ui()->factory()->input();
120 $this->renderer = $DIC->ui()->renderer();
121 $this->request = $DIC->http()->request();
122 $this->data_factory = new Factory();
123 $this->action_repo = new ActionDBRepository($DIC->database());
124 $this->lom_services = $DIC->learningObjectMetadata();
125
126 $capability_builder = new CapabilityBuilder(
127 new ilObjFileInfoRepository(),
128 $this->access,
129 $this->ctrl,
130 $this->action_repo,
131 $DIC->http(),
132 $DIC['static_url.uri_builder']
133 );
134
135 $capability_context = new Context(
136 $this->object_id,
137 $this->ref_id,
138 ($a_id_type === self::WORKSPACE_NODE_ID) ? Context::CONTEXT_WORKSPACE : Context::CONTEXT_REPO
139 );
140
141 $this->capabilities = $capability_builder->get($capability_context);
142 }
renderer
renderer()
Definition: UITestHelper.php:69
ILIAS\Data\Factory
Builds data types.
Definition: Factory.php:36
ilLoggerFactory\getLogger
static getLogger(string $a_component_id)
Get component logger.
Definition: class.ilLoggerFactory.php:89
ilObjFileStakeholder
Class ilObjFileStakeholder.
Definition: class.ilObjFileStakeholder.php:27
ilObjFile\OBJECT_TYPE
const OBJECT_TYPE
Definition: class.ilObjFile.php:44
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
Definition: PluginProviderHelper.php:38
$DIC
global $DIC
Definition: shib_login.php:26

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilLoggerFactory\getLogger(), ILIAS\Repository\lng(), ilObjFile\OBJECT_TYPE, ILIAS\Repository\refinery(), renderer(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

+ Here is the call graph for this function:

Member Function Documentation

◆ _goto()

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

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

1085 : void
1086 {
1087 global $DIC;
1088 $main_tpl = $DIC->ui()->mainTemplate();
1089 $ilErr = $DIC['ilErr'];
1090 $lng = $DIC['lng'];
1091 $ilAccess = $DIC['ilAccess'];
1092
1093 if ($a_additional && str_ends_with((string) $a_additional, "wsp")) {
1094 ilObjectGUI::_gotoSharedWorkspaceNode((int) $a_target);
1095 }
1096
1097 // added support for direct download goto links
1098 if ($a_additional && str_ends_with((string) $a_additional, "download")) {
1099 ilObjectGUI::_gotoRepositoryNode($a_target, "sendfile");
1100 }
1101
1102 // static method, no workspace support yet
1103
1104 if ($ilAccess->checkAccess("visible", "", $a_target)
1105 || $ilAccess->checkAccess("read", "", $a_target)) {
1106 ilObjectGUI::_gotoRepositoryNode($a_target, Capabilities::INFO_PAGE->value);
1107 } elseif ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
1108 $main_tpl->setOnScreenMessage(
1109 'failure',
1110 sprintf(
1111 $lng->txt("msg_no_perm_read_item"),
1112 ilObject::_lookupTitle(ilObject::_lookupObjId($a_target))
1113 ),
1114 true
1115 );
1116 ilObjectGUI::_gotoRepositoryRoot();
1117 }
1118
1119 $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
1120 }
ilLanguage\txt
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
Definition: class.ilLanguage.php:170
ilObjectGUI\_gotoSharedWorkspaceNode
static _gotoSharedWorkspaceNode(int $wsp_id)
Definition: class.ilObjectGUI.php:2020
ilObjectGUI\_gotoRepositoryRoot
static _gotoRepositoryRoot(bool $raise_error=false)
Goto repository root.
Definition: class.ilObjectGUI.php:1992
ilObjectGUI\_gotoRepositoryNode
static _gotoRepositoryNode(int $ref_id, string $cmd="")
Definition: class.ilObjectGUI.php:2011
ilObject\_lookupObjId
static _lookupObjId(int $ref_id)
Definition: class.ilObject.php:940
ilObject\_lookupTitle
static _lookupTitle(int $obj_id)
Definition: class.ilObject.php:847
ROOT_FOLDER_ID
const ROOT_FOLDER_ID
Definition: constants.php:32
$ilErr
$ilErr
Definition: raiseError.php:33

References $DIC, $ilErr, $lng, ilObjectGUI\_gotoRepositoryNode(), ilObjectGUI\_gotoRepositoryRoot(), ilObjectGUI\_gotoSharedWorkspaceNode(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), and ROOT_FOLDER_ID.

+ Here is the call graph for this function:

◆ addLegacyFormToAccordion()

ilObjFileGUI::addLegacyFormToAccordion ( ilAccordionGUI  $accordion,
ilPropertyFormGUI  $form,
int  $form_type 
)
protected

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

391 : void {
392 // abort if form-type is unknown
393 if (!in_array($form_type, [self::CFORM_NEW, self::CFORM_CLONE, self::CFORM_IMPORT], true)) {
394 return;
395 }
396 $title = $form->getTitle();
397 $form->setTitle(''); // see https://mantis.ilias.de/view.php?id=37786
398
399 $tpl = new ilTemplate("tpl.creation_acc_head.html", true, true, "components/ILIAS/ILIASObject");
400 $tpl->setVariable("TITLE", $this->lng->txt("option") . " " . $form_type . ": " . $title);
401
402 $accordion->addItem($tpl->get(), $form->getHTML());
403 }
ilAccordionGUI\addItem
addItem(string $a_header, string $a_content, bool $a_force_open=false)
Definition: class.ilAccordionGUI.php:272
ilObject2GUI\$tpl
ilGlobalTemplateInterface $tpl
Definition: class.ilObject2GUI.php:53
ilTemplate
special template class to simplify handling of ITX/PEAR
Definition: class.ilTemplate.php:31
ILIAS\UICore\GlobalTemplate\setVariable
setVariable(string $variable, $value='')
Sets the given variable to the given value.
ILIAS\UICore\GlobalTemplate\get
get(string $part=self::DEFAULT_BLOCK)
Renders the given block and returns the html string.

◆ addLocatorItems()

ilObjFileGUI::addLocatorItems ( )
protected

Functions to be overwritten.

Reimplemented from ilObject2GUI.

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

1125 : void
1126 {
1127 global $DIC;
1128 $ilLocator = $DIC['ilLocator'];
1129
1130 if (is_object($this->object)) {
1131 $ilLocator->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, ""), "", $this->node_id);
1132 }
1133 }

References $DIC, and ILIAS\Repository\object().

+ Here is the call graph for this function:

◆ addUIFormToAccordion()

ilObjFileGUI::addUIFormToAccordion ( ilAccordionGUI  $accordion,
Standard  $form,
int  $form_type 
)
protected

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

370 : void {
371 // abort if form-type is unknown
372 if (!in_array($form_type, [self::CFORM_NEW, self::CFORM_CLONE, self::CFORM_IMPORT], true)) {
373 return;
374 }
375
376 $inputs = $form->getInputs();
377 // use label of first input as title, because UI Component forms don't support form-titles yet
378 $title = ($inputs === []) ?
379 '' : $inputs[array_key_first($inputs)]->getLabel();
380
381 $tpl = new ilTemplate("tpl.creation_acc_head.html", true, true, "components/ILIAS/ILIASObject");
382 $tpl->setVariable("TITLE", $this->lng->txt("option") . " " . $form_type . ": " . $title);
383
384 $accordion->addItem($tpl->get(), $this->ui->renderer()->render($form));
385 }
ilObjFileGUI\$inputs
ILIAS UI Component Input Factory $inputs
Definition: class.ilObjFileGUI.php:92
ILIAS\UI\Component\Input\Container\Container\getInputs
getInputs()
Get the inputs contained in the container.

◆ buildInfoScreen()

ilObjFileGUI::buildInfoScreen ( bool  $kiosk_mode)

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

865 : ilInfoScreenGUI
866 {
867 $info = new ilInfoScreenGUI($this);
868
869 if (!$kiosk_mode) { // in kiosk mode we don't want to show the following sections
870 $info->enablePrivateNotes();
871
872 if ($this->capabilities->get(Capabilities::DOWNLOAD)->isUnlocked()) {
873 $info->enableNews();
874 }
875
876 // no news editing for files, just notifications
877 $info->enableNewsEditing(false);
878 if ($this->capabilities->get(Capabilities::MANAGE_VERSIONS)->isUnlocked()) {
879 $news_set = new ilSetting("news");
880 $enable_internal_rss = $news_set->get("enable_rss_for_internal");
881
882 if ($enable_internal_rss) {
883 $info->setBlockProperty("news", "settings", true);
884 $info->setBlockProperty("news", "public_notifications_option", true);
885 }
886 }
887
888 $obj_id = $this->object->getId();
889 $record_gui = new ilAdvancedMDRecordGUI(
890 ilAdvancedMDRecordGUI::MODE_INFO,
891 'file',
892 $obj_id,
893 '',
894 0,
895 $this->call_by_reference
896 );
897 $record_gui->setInfoObject($info);
898 $record_gui->parse();
899 }
900 // show rating is not possible in kiosk mode
901
902 // Important Information
903 $important_info = $this->object->getImportantInfo();
904 if (!empty($important_info)) {
905 $group = new Group(new Factory(), $this->lng);
906 $markdown_to_html = $group->markdown()->toHTML();
907
908 $info->addSection($this->lng->txt("important_info"));
909 $info->addProperty("", $markdown_to_html->transform($important_info));
910 }
911
912 // Download Launcher
913 if ($this->capabilities->get(Capabilities::DOWNLOAD)->isUnlocked()) {
914 // get permanent download link for repository
915 if ($this->id_type === self::REPOSITORY_NODE_ID) {
916 $download_target = ilObjFileAccess::_getPermanentDownloadLink($this->node_id);
917 } else {
918 $download_target = rtrim(ILIAS_HTTP_PATH, '/') . '/' . $this->ctrl->getLinkTarget(
919 $this,
920 self::CMD_SEND_FILE
921 );
922 }
923 $url = $this->data_factory->uri($download_target);
924 $link = $this->data_factory->link($this->lng->txt('file_download'), $url);
925 $download_launcher = $this->ui->factory()->launcher()->inline($link);
926 // create own section for download launcher if there is no important info section
927 if (empty($important_info)) {
928 $info->addSection("");
929 }
930 // add download launcher
931 $info->addProperty("", $this->renderer->render($download_launcher));
932 }
933
934 // standard meta data
935 $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());
936
937 // in kiosk mode we don't want to show the following sections
938 // links to resource
939 if (!$kiosk_mode && ($this->access->checkAccess("write", "", $this->ref_id) ||
940 $this->access->checkAccess("edit_permissions", "", $this->ref_id))) {
941 $rs = ilObject::_getAllReferences($this->obj_id);
942 $refs = [];
943 foreach ($rs as $r) {
944 if ($this->tree->isInTree($r)) {
945 $refs[] = $r;
946 }
947 }
948 if (count($refs) > 1) {
949 $links = $sep = "";
950 foreach ($refs as $r) {
951 $cont_loc = new ilLocatorGUI();
952 $cont_loc->addContextItems($r, true);
953 $links .= $sep . $cont_loc->getHTML();
954 $sep = "<br />";
955 }
956
957 $info->addProperty(
958 $this->lng->txt("res_links"),
959 '<div class="small">' . $links . '</div>'
960 );
961 }
962 }
963
964 // File Info
965 $info->addSection($this->lng->txt("file_info"));
966 if ($kiosk_mode) {
967 $file_info_for_users = $this->getFileInfoForUsers();
968 foreach ($file_info_for_users as $file_info_entry_key => $file_info_entry_value) {
969 if ($file_info_entry_value !== null) {
970 $info->addProperty($file_info_entry_key, $file_info_entry_value);
971 }
972 }
973 } else {
974 $file_info = $this->getAllFileInfoForCurrentUser();
975 foreach ($file_info as $file_info_block) {
976 foreach ($file_info_block as $file_info_entry_key => $file_info_entry_value) {
977 if ($file_info_entry_value !== null) {
978 $info->addProperty($file_info_entry_key, $file_info_entry_value);
979 }
980 }
981 }
982 }
983
984 $info->hideFurtherSections(false);
985
986 return $info;
987 }
ilInfoScreenGUI
Class ilInfoScreenGUI.
Definition: class.ilInfoScreenGUI.php:35
ilLocatorGUI
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: class.ilLocatorGUI.php:28
ilObjFileAccess\_getPermanentDownloadLink
static _getPermanentDownloadLink(int $ref_id)
Gets the permanent download link for the file.
Definition: class.ilObjFileAccess.php:352
ilObject\_getAllReferences
static _getAllReferences(int $id)
get all reference ids for object ID
Definition: class.ilObject.php:826
ilSetting
ILIAS Setting Class.
Definition: class.ilSetting.php:27
$info
$info
Definition: entry_point.php:21
$url
$url
Definition: shib_logout.php:68

References $info, $url, ilObject\_getAllReferences(), ilObjFileAccess\_getPermanentDownloadLink(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\ILIASObject\Creation\Group, ILIAS\Repository\lng(), ilAdvancedMDRecordGUI\MODE_INFO, ILIAS\Repository\object(), renderer(), and ILIAS\Repository\ui().

+ Here is the call graph for this function:

◆ edit()

ilObjFileGUI::edit ( )

Reimplemented from ilObject2GUI.

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

613 : void
614 {
615 global $DIC;
616 $ilErr = $DIC['ilErr'];
617
618 if (!$this->capabilities->get(Capabilities::EDIT_SETTINGS)->isUnlocked()) {
619 $ilErr->raiseError($this->lng->txt("msg_no_perm_write"));
620 }
621
622 $this->initSettingsTab();
623
624 $form = $this->initPropertiesForm();
625
626 // $ecs = new ilECSFileSettings($this->object);
627 // $ecs->addSettingsToForm($form, ilObjFile::OBJECT_TYPE); TODO: reintroduce usage of ECS file settings once they have been made compatible with the new ui components
628
629 $this->tpl->setContent($this->renderer->render($form));
630 }

References $DIC, $ilErr, ILIAS\Repository\lng(), and renderer().

+ Here is the call graph for this function:

◆ editExternal()

ilObjFileGUI::editExternal ( )
protected

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

786 : void
787 {
788 $this->ctrl->redirectToURL(
789 (string) $this->capabilities->get(Capabilities::EDIT_EXTERNAL)->getUri()
790 );
791 }

References ILIAS\Repository\ctrl().

+ Here is the call graph for this function:

◆ getCreationFormTitle()

ilObjFileGUI::getCreationFormTitle ( )
protected

Reimplemented from ilObjectGUI.

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

415 : string
416 {
417 return $this->lng->txt('upload_files');
418 }

References ILIAS\Repository\lng().

+ Here is the call graph for this function:

◆ getCtrl()

ilObjFileGUI::getCtrl ( )
protected

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

1151 : \ilCtrl
1152 {
1153 return $this->ctrl;
1154 }
ilCtrl
Class ilCtrl provides processing control methods.
Definition: class.ilCtrl.php:36

◆ getFileObj()

ilObjFileGUI::getFileObj ( )
protected
Exceptions
ilFileException

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

1159 : ilObjFile
1160 {
1161 if (!$this->object instanceof ilObjFile) {
1162 throw new ilFileException("Error: object is not of type ilObjFile or doesn't exist");
1163 }
1164
1165 return $this->object;
1166 }
ilFileException
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: class.ilFileException.php:20
ilObjFile
Class ilObjFile.
Definition: class.ilObjFile.php:36

◆ getFileStakeholder()

ilObjFileGUI::getFileStakeholder ( )
protected

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

1168 : ilObjFileStakeholder
1169 {
1170 return $this->stakeholder;
1171 }
ilObjFileGUI\$stakeholder
ResourceStakeholder $stakeholder
Definition: class.ilObjFileGUI.php:84

◆ getGeneralSettings()

ilObjFileGUI::getGeneralSettings ( )
protected

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

1173 : General
1174 {
1175 return $this->general_settings;
1176 }
ilObjFileGUI\$general_settings
General $general_settings
Definition: class.ilObjFileGUI.php:89

◆ getLanguage()

ilObjFileGUI::getLanguage ( )
protected

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

1178 : \ilLanguage
1179 {
1180 return $this->lng;
1181 }
ilLanguage
language handling
Definition: class.ilLanguage.php:43

References $lng.

◆ getNodeID()

ilObjFileGUI::getNodeID ( )
protected

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

1183 : int
1184 {
1185 return $this->node_id;
1186 }

◆ getParentId()

ilObjFileGUI::getParentId ( )

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

162 : int
163 {
164 return $this->parent_id;
165 }

References ilObject2GUI\$parent_id.

◆ getRefinery()

ilObjFileGUI::getRefinery ( )
protected

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

1188 : \ILIAS\Refinery\Factory
1189 {
1190 return $this->refinery;
1191 }
ilObjFileGUI\$refinery
ILIAS Refinery Factory $refinery
Definition: class.ilObjFileGUI.php:88

References ILIAS\UI\examples\Layout\Page\Mail\$refinery.

◆ getType()

ilObjFileGUI::getType ( )

Functions that must be overwritten.

Reimplemented from ilObject2GUI.

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

157 : string
158 {
159 return ilObjFile::OBJECT_TYPE;
160 }

References ilObjFile\OBJECT_TYPE.

◆ getUIFactory()

ilObjFileGUI::getUIFactory ( )
protected

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

1193 : ILIAS\UI\Factory
1194 {
1195 return $this->ui->factory();
1196 }
ILIAS\Data\Color\Factory
Builds a Color from either hex- or rgb values.
Definition: Factory.php:31

References ILIAS\Repository\ui().

+ Here is the call graph for this function:

◆ getUser()

ilObjFileGUI::getUser ( )
protected

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

1198 : ilObjUser
1199 {
1200 return $this->user;
1201 }
ilObjUser
User class.
Definition: class.ilObjUser.php:48

◆ infoScreenForward()

ilObjFileGUI::infoScreenForward ( )

show information screen

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

802 : void
803 {
804 $this->tabs_gui->activateTab("id_info");
805
806 if (!$this->capabilities->get(Capabilities::INFO_PAGE)->isUnlocked()) {
807 $GLOBALS['DIC']['ilErr']->raiseError(
808 $this->lng->txt("msg_no_perm_read"),
809 2
810 ); // TODO remove magic number and old ilErr call
811 }
812
813 // add set completed button, if LP mode is active
814 if ($this->object->getLPMode() === ilLPObjSettings::LP_MODE_MANUAL) {
815 if (ilLPStatus::_hasUserCompleted($this->object->getId(), $this->user->getId())) {
816 $label = $this->lng->txt('file_btn_lp_toggle_state_completed');
817 } else {
818 $label = $this->lng->txt('file_btn_lp_toggle_state_not_completed');
819 }
820 $this->toolbar->addComponent(
821 $this->ui->factory()->button()->standard(
822 $label,
823 $this->ctrl->getLinkTarget($this, 'toggleLearningProgress')
824 )
825 );
826 }
827
828 // Add WOPI editor Button
829 if ($this->capabilities->get(Capabilities::EDIT_EXTERNAL)->isUnlocked()) {
830 $external_editor = $this->ui->factory()
831 ->button()
832 ->standard(
833 $this->lng->txt('open_external_editor'),
834 $this->ctrl->getLinkTargetByClass(
835 \ilWOPIEmbeddedApplicationGUI::class,
836 \ilWOPIEmbeddedApplicationGUI::CMD_EDIT
837 )
838 );
839 $this->toolbar->addComponent($external_editor);
840 }
841
842 $info = $this->buildInfoScreen(false);
843 $this->ctrl->forwardCommand($info);
844 }
ilLPStatus\_hasUserCompleted
static _hasUserCompleted(int $a_obj_id, int $a_user_id)
Lookup user object completion.
Definition: class.ilLPStatus.php:728
ilObjFileGUI\buildInfoScreen
buildInfoScreen(bool $kiosk_mode)
Definition: class.ilObjFileGUI.php:865
$GLOBALS
$GLOBALS["DIC"]
Definition: wac.php:54

References $GLOBALS, $info, ilLPStatus\_hasUserCompleted(), ilWOPIEmbeddedApplicationGUI\CMD_EDIT, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilLPObjSettings\LP_MODE_MANUAL, ILIAS\Repository\object(), ILIAS\Repository\toolbar(), and ILIAS\Repository\ui().

+ Here is the call graph for this function:

◆ initCreateForm()

ilObjFileGUI::initCreateForm ( string  $new_type)
protected
Returns
array

Reimplemented from ilObjectGUI.

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

409 : Standard
410 {
411 return $this->initUploadForm();
412 }
ILIAS\UI\Component\Input\Container\Form\Standard
This describes a standard form.
Definition: Standard.php:30

◆ initHeaderAction()

ilObjFileGUI::initHeaderAction ( ?string  $sub_type = null,
?int  $sub_id = null 
)
protected

Add header action menu.

Reimplemented from ilObject2GUI.

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

1136 : ?\ilObjectListGUI
1137 {
1138 $lg = parent::initHeaderAction($a_sub_type, $a_sub_id);
1139 if ($lg instanceof ilObjectListGUI && $this->object->hasRating()) {
1140 $lg->enableRating(
1141 true,
1142 null,
1143 false,
1144 [ilCommonActionDispatcherGUI::class, ilRatingGUI::class]
1145 );
1146 }
1147
1148 return $lg;
1149 }

References ILIAS\Repository\object().

+ Here is the call graph for this function:

◆ initPropertiesForm()

ilObjFileGUI::initPropertiesForm ( )
protected

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

632 : Standard
633 {
634 $title_and_description = $this->object->getObjectProperties()->getPropertyTitleAndDescription()->toForm(
635 $this->lng,
636 $this->ui->factory()->input()->field(),
637 $this->refinery
638 );
639
640 $important_info = $this->inputs->field()->markdown(
641 new ilUIMarkdownPreviewGUI(),
642 $this->lng->txt('important_info'),
643 $this->lng->txt('important_info_byline')
644 )->withValue(
645 $this->object->getImportantInfo() ?? ""
646 );
647
648 $on_click_action = $this->inputs->field()->radio(
649 $this->lng->txt('on_click_action')
650 )->withOption(
651 (string) ilObjFile::CLICK_MODE_DOWNLOAD,
652 $this->lng->txt('file_action_download'),
653 $this->lng->txt('file_action_download_info'),
654 )->withOption(
655 (string) ilObjFile::CLICK_MODE_INFOPAGE,
656 $this->lng->txt('file_action_show'),
657 $this->lng->txt('file_action_show_info'),
658 )->withValue(
659 (string) $this->object->getOnClickMode()
660 );
661
662 $input_groups = array_filter([
663 "title_and_description" => $title_and_description,
664 "important_info" => $important_info,
665 "on_click_action" => $on_click_action
666 ], static fn(FormInput $input): bool => null !== $input);
667
668 $file_info_section = $this->inputs->field()->section(
669 $input_groups,
670 $this->lng->txt('file_info')
671 );
672
673 $online_status = $this->object->getObjectProperties()->getPropertyIsOnline()->toForm(
674 $this->lng,
675 $this->ui->factory()->input()->field(),
676 $this->refinery
677 );
678 $availability_section = $this->inputs->field()->section(
679 ["online_status" => $online_status],
680 $this->lng->txt('rep_activation_availability')
681 );
682
683 $presentation_section = null;
684 if ($this->id_type === self::REPOSITORY_NODE_ID) {
685 $tile_image = $this->object->getObjectProperties()->getPropertyTileImage()->toForm(
686 $this->lng,
687 $this->ui->factory()->input()->field(),
688 $this->refinery
689 );
690 $presentation_section = $this->inputs->field()->section(
691 ["tile_image" => $tile_image],
692 $this->lng->txt('settings_presentation_header')
693 );
694 }
695
696 $additional_features_section = null;
697 if ($this->id_type === self::REPOSITORY_NODE_ID) {
698 $this->lng->loadLanguageModule('rating');
699
700 $enable_rating = $this->inputs->field()->checkbox(
701 $this->lng->txt('rating_activate_rating'),
702 $this->lng->txt('rating_activate_rating_info')
703 )->withValue(
704 $this->object->hasRating()
705 );
706 $additional_features_section = $this->inputs->field()->section(
707 ["rating" => $enable_rating],
708 $this->lng->txt('obj_features')
709 );
710 }
711
712 $inputs = array_filter([
713 "file_info" => $file_info_section,
714 "availability" => $availability_section,
715 "presentation" => $presentation_section,
716 "obj_features" => $additional_features_section
717 ], static fn(?Section $input): bool => null !== $input);
718
719 return $this->inputs->container()->form()->standard(
720 $this->ctrl->getLinkTargetByClass(self::class, 'update'),
721 $inputs
722 );
723 }
ilObjFile\CLICK_MODE_DOWNLOAD
const CLICK_MODE_DOWNLOAD
Definition: class.ilObjFile.php:45
ilObjFile\CLICK_MODE_INFOPAGE
const CLICK_MODE_INFOPAGE
Definition: class.ilObjFile.php:46
ILIAS\UI\Component\Input\Container\Form\FormInput
This describes inputs that can be used in forms.
Definition: FormInput.php:33
ILIAS\UI\Component\Input\Field\Section
This describes section inputs.
Definition: Section.php:29

References ILIAS\UI\Implementation\Component\Input\$inputs, ilObjFile\CLICK_MODE_DOWNLOAD, ilObjFile\CLICK_MODE_INFOPAGE, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ILIAS\Repository\ui().

+ Here is the call graph for this function:

◆ initSettingsTab()

ilObjFileGUI::initSettingsTab ( )
protected

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

1065 : void
1066 {
1067 $this->tabs_gui->activateTab("settings");
1068 // add subtab for common settings
1069 $this->tabs_gui->addSubTab(
1070 'file_settings',
1071 $this->lng->txt('settings'),
1072 $this->ctrl->getLinkTargetByClass(self::class, self::CMD_EDIT)
1073 );
1074 if (in_array('file', ilAdvancedMDRecord::_getActivatedObjTypes(), true)) {
1075 $this->tabs_gui->addSubTab(
1076 'service_settings',
1077 $this->lng->txt('service_settings'),
1078 $this->ctrl->getLinkTargetByClass(ilFileCommonSettingsGUI::class, ilFileCommonSettingsGUI::CMD_EDIT)
1079 );
1080 }
1081
1082 $this->tabs_gui->activateSubTab("file_settings");
1083 }
ilAdvancedMDRecord\_getActivatedObjTypes
static _getActivatedObjTypes()
get activated obj types
Definition: class.ilAdvancedMDRecord.php:184

References ilAdvancedMDRecord\_getActivatedObjTypes(), ilFileCommonSettingsGUI\CMD_EDIT, and ILIAS\Repository\lng().

+ Here is the call graph for this function:

◆ initUploadForm()

ilObjFileGUI::initUploadForm ( )

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

420 : Standard
421 {
422 $this->getLanguage()->loadLanguageModule('file');
423 $inputs = [];
424
425 $this->ctrl->setParameterByClass(self::class, 'new_type', $this->getType());
426 $this->ctrl->setParameterByClass(
427 self::class,
428 self::PARAM_UPLOAD_ORIGIN,
429 self::UPLOAD_ORIGIN_STANDARD
430 );
431
432
433 $inputs[self::PARAM_FILES] = $this->ui->factory()->input()->field()->file(
434 $this->upload_handler,
435 $this->lng->txt('upload_files'),
436 null,
437 $this->ui->factory()->input()->field()->group([
438 self::PARAM_TITLE => $this->ui->factory()->input()->field()->text(
439 $this->lng->txt('title')
440 )->withAdditionalTransformation(
441 $this->getEmptyStringToNullTransformation()
442 ),
443 self::PARAM_DESCRIPTION => $this->ui->factory()->input()->field()->textarea(
444 $this->lng->txt('description')
445 )->withAdditionalTransformation(
446 $this->getEmptyStringToNullTransformation()
447 ),
448 ])
449 )->withMaxFiles(
450 self::UPLOAD_MAX_FILES
451 )->withRequired(true);
452
453 if ($this->lom_services->copyrightHelper()->isCopyrightSelectionActive()) {
454 $inputs[self::PARAM_COPYRIGHT_ID] = $this->getCopyrightSelectionInput('set_license_for_all_files');
455 }
456
457 return $this->ui->factory()->input()->container()->form()->standard(
458 $this->ctrl->getFormActionByClass(self::class, self::CMD_UPLOAD_FILES),
459 $inputs
460 )->withSubmitLabel($this->lng->txt('upload_files'));
461 }
ilObjFileGUI\getType
getType()
Functions that must be overwritten.
Definition: class.ilObjFileGUI.php:157

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Repository\ctrl(), getLanguage(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

+ Here is the call graph for this function:

◆ putObjectInTree()

ilObjFileGUI::putObjectInTree ( ilObject  $obj,
?int  $parent_node_id = null 
)

Add object to tree at given position.

Reimplemented from ilObject2GUI.

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

545 : void
546 {
547 // this is needed to support multi fileuploads in personal and shared resources
548 $backup_node_id = $this->node_id;
549 parent::putObjectInTree($obj, $parent_node_id);
550 $this->node_id = $backup_node_id;
551 }

◆ sendFile()

ilObjFileGUI::sendFile ( )

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

725 : bool
726 {
727 $hist_entry_id = $this->request_wrapper->has('hist_id')
728 ? $this->request_wrapper->retrieve('hist_id', $this->refinery->kindlyTo()->int())
729 : null;
730 try {
731 if (ANONYMOUS_USER_ID === $this->user->getId() && $this->request_wrapper->has('transaction')) {
732 $this->object->sendFile($hist_entry_id);
733 }
734
735 if ($this->capabilities->get(Capabilities::DOWNLOAD)->isUnlocked()) {
736 // Record read event and catchup with write events
737 ilChangeEvent::_recordReadEvent(
738 $this->object->getType(),
739 $this->object->getRefId(),
740 $this->object->getId(),
741 $this->user->getId()
742 );
743 $this->updateLearningProgress();
744
745 $this->object->sendFile($hist_entry_id);
746 } else {
747 $this->error->raiseError($this->lng->txt("permission_denied"), $this->error->MESSAGE);
748 }
749 } catch (FileNotFoundException $e) {
750 $this->error->raiseError($e->getMessage(), $this->error->MESSAGE);
751 }
752
753 return true;
754 }
ILIAS\Filesystem\Exception\FileNotFoundException
Indicates that a file is missing or not found.
Definition: FileNotFoundException.php:28
error
error(string $a_errmsg)
Definition: class.ilIniFile.php:309
ilChangeEvent\_recordReadEvent
static _recordReadEvent(string $a_type, int $a_ref_id, int $obj_id, int $usr_id, $a_ext_rc=null, $a_ext_time=null)
Definition: class.ilChangeEvent.php:118
ANONYMOUS_USER_ID
const ANONYMOUS_USER_ID
Definition: constants.php:27

References Vendor\Package\$e, ilChangeEvent\_recordReadEvent(), ANONYMOUS_USER_ID, error(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

+ Here is the call graph for this function:

◆ setTabs()

ilObjFileGUI::setTabs ( )
protected

create tabs (repository/workspace switch)

this had to be moved here because of the context-specific permission tab

Reimplemented from ilObject2GUI.

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

991 : void
992 {
993 global $DIC;
994 $ilHelp = $DIC['ilHelp'];
995 $ilHelp->setScreenIdComponent(ilObjFile::OBJECT_TYPE);
996
997 $this->ctrl->setParameter($this, "ref_id", $this->node_id);
998
999 if (($c = $this->capabilities->get(Capabilities::VIEW_EXTERNAL)) && $c->isUnlocked()) {
1000 $this->tabs_gui->addTab(
1001 "content",
1002 $this->lng->txt("content"),
1003 $c->getURI()
1004 );
1005 }
1006
1007 if (($c = $this->capabilities->get(Capabilities::MANAGE_VERSIONS)) && $c->isUnlocked()) {
1008 $this->tabs_gui->addTab(
1009 "id_versions",
1010 $this->lng->txt(self::CMD_VERSIONS),
1011 $this->ctrl->getLinkTargetByClass(ilFileVersionsGUI::class, ilFileVersionsGUI::CMD_DEFAULT)
1012 );
1013 }
1014
1015 if (($c = $this->capabilities->get(Capabilities::INFO_PAGE)) && $c->isUnlocked()) {
1016 $this->tabs_gui->addTab(
1017 "id_info",
1018 $this->lng->txt("info_short"),
1019 $this->ctrl->getLinkTargetByClass(["ilobjfilegui", "ilinfoscreengui"], "showSummary")
1020 );
1021 }
1022
1023 if (($c = $this->capabilities->get(Capabilities::EDIT_SETTINGS)) && $c->isUnlocked()) {
1024 $this->tabs_gui->addTab(
1025 "settings",
1026 $this->lng->txt("settings"),
1027 $this->ctrl->getLinkTarget($this, self::CMD_EDIT)
1028 );
1029 }
1030
1031 if (ilLearningProgressAccess::checkAccess($this->object->getRefId())) {
1032 $this->tabs_gui->addTab(
1033 'learning_progress',
1034 $this->lng->txt('learning_progress'),
1035 $this->ctrl->getLinkTargetByClass([self::class, 'illearningprogressgui'], '')
1036 );
1037 }
1038
1039 // meta data
1040 if (($c = $this->capabilities->get(Capabilities::EDIT_SETTINGS)) && $c->isUnlocked()) {
1041 $mdgui = new ilObjectMetaDataGUI($this->object, null, null, $this->call_by_reference);
1042 $mdtab = $mdgui->getTab();
1043 if ($mdtab) {
1044 $this->tabs_gui->addTab(
1045 "id_meta",
1046 $this->lng->txt("meta_data"),
1047 $mdtab
1048 );
1049 }
1050 }
1051
1052 // export
1053 if (($c = $this->capabilities->get(Capabilities::EDIT_SETTINGS)) && $c->isUnlocked()) {
1054 $this->tabs_gui->addTab(
1055 "export",
1056 $this->lng->txt("export"),
1057 $this->ctrl->getLinkTargetByClass("ilexportgui", "")
1058 );
1059 }
1060
1061 // will add permission tab if needed
1062 parent::setTabs();
1063 }
ilLearningProgressAccess\checkAccess
static checkAccess(int $a_ref_id, bool $a_allow_only_read=true)
check access to learning progress
Definition: class.ilLearningProgressAccess.php:60
ilObjectMetaDataGUI
Class ilObjectMetaDataGUI.
Definition: class.ilObjectMetaDataGUI.php:30
$c
$c
Definition: deliver.php:25

References $c, $DIC, ilLearningProgressAccess\checkAccess(), ilFileVersionsGUI\CMD_DEFAULT, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilObjFile\OBJECT_TYPE.

+ Here is the call graph for this function:

◆ showSummary()

ilObjFileGUI::showSummary ( )
Deprecated:
PROXY COMMAND

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

759 : void
760 {
761 $this->ctrl->redirectToURL(
762 (string) $this->capabilities->get(Capabilities::INFO_PAGE)->getUri()
763 );
764 }

References ILIAS\Repository\ctrl().

+ Here is the call graph for this function:

◆ showSummaryForced()

ilObjFileGUI::showSummaryForced ( )

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

765 : void
766 {
767 $this->ctrl->redirectToURL(
768 (string) $this->capabilities->get(Capabilities::FORCED_INFO_PAGE)->getUri()
769 );
770 }

References ILIAS\Repository\ctrl().

+ Here is the call graph for this function:

◆ toggleLearningProgress()

ilObjFileGUI::toggleLearningProgress ( )
protected

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

846 : void
847 {
848 ilLearningProgress::_tracProgress(
849 $this->user->getId(),
850 $this->obj_id,
851 $this->ref_id,
852 'file'
853 );
854
855 $lp_marks = new ilLPMarks($this->obj_id, $this->user->getId());
856 $lp_marks->setCompleted(!ilLPStatus::_hasUserCompleted($this->object->getId(), $this->user->getId()));
857 $lp_marks->update();
858
859 ilLPStatusWrapper::_updateStatus($this->obj_id, $this->user->getId());
860
861 $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
862 $this->ctrl->redirect($this, Capabilities::INFO_PAGE->value);
863 }
ilLPStatusWrapper\_updateStatus
static _updateStatus(int $a_obj_id, int $a_usr_id, ?object $a_obj=null, bool $a_percentage=false, bool $a_force_raise=false)
Definition: class.ilLPStatusWrapper.php:296
ilLearningProgress\_tracProgress
static _tracProgress(int $a_user_id, int $a_obj_id, int $a_ref_id, string $a_obj_type='')
Definition: class.ilLearningProgress.php:27

References ilLPStatus\_hasUserCompleted(), ilLearningProgress\_tracProgress(), ilLPStatusWrapper\_updateStatus(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ILIAS\Repository\user().

+ Here is the call graph for this function:

◆ unzipCurrentRevision()

ilObjFileGUI::unzipCurrentRevision ( )

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

779 : void
780 {
781 $this->ctrl->redirectToURL(
782 (string) $this->capabilities->get(Capabilities::UNZIP)->getUri()
783 );
784 }

References ILIAS\Repository\ctrl().

+ Here is the call graph for this function:

◆ updateLearningProgress()

ilObjFileGUI::updateLearningProgress ( )
protected

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

144 : void
145 {
146 if ($this->object->getLPMode() === ilLPObjSettings::LP_MODE_CONTENT_VISITED) {
147 ilLPStatusWrapper::_updateStatus(
148 $this->object->getId(),
149 $this->user->getId(),
150 null,
151 false,
152 true
153 );
154 }
155 }

References ilLPStatusWrapper\_updateStatus(), ilLPObjSettings\LP_MODE_CONTENT_VISITED, and ILIAS\Repository\object().

+ Here is the call graph for this function:

◆ uploadFiles()

ilObjFileGUI::uploadFiles ( )
protected

MUST be protected, since this is Called from ilObject2GUI when used in Personal Workspace.

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

466 : void
467 {
468 $origin = ($this->request_wrapper->has(self::PARAM_UPLOAD_ORIGIN)) ?
469 $this->request_wrapper->retrieve(
470 self::PARAM_UPLOAD_ORIGIN,
471 $this->refinery->kindlyTo()->string()
472 ) : self::UPLOAD_ORIGIN_STANDARD;
473
474 if (self::UPLOAD_ORIGIN_DROPZONE === $origin) {
475 $dropzone = new ilObjFileUploadDropzone($this->parent_id);
476 $dropzone = $dropzone->getDropzone()->withRequest($this->request);
477 $data = $dropzone->getData();
478 } else {
479 $form = $this->initUploadForm()->withRequest($this->request);
480 $data = $form->getData();
481 }
482 $files = $data[self::PARAM_FILES] ?? $data[0] ?? null;
483
484 if (empty($files)) {
485 $form = $this->initUploadForm()->withRequest($this->request);
486 $this->tpl->setContent($this->getCreationFormsHTML($form));
487 return;
488 }
489
490 $processor = new ilObjFileProcessor(
491 $this->stakeholder,
492 $this,
493 $this->storage,
494 $this->file_service_settings
495 );
496
497 $errors = false;
498 foreach ($files as $file_data) {
499 $rid = $this->storage->manage()->find($file_data[0]);
500 if (null !== $rid) {
501 try {
502 $processor->process(
503 $rid,
504 $file_data[1][self::PARAM_TITLE] ?? null,
505 $file_data[1][self::PARAM_DESCRIPTION] ?? null,
506 $data[self::PARAM_COPYRIGHT_ID] ?? null
507 );
508 } catch (Throwable $t) {
509 $errors = true;
510 if (null !== $this->log) {
511 $this->log->error($t->getMessage() . ": " . $t->getTraceAsString());
512 }
513 }
514 }
515 }
516
517 if ($errors) {
518 $this->ui->mainTemplate()->setOnScreenMessage(
519 'failure',
520 $this->lng->txt('could_not_create_file_objs'),
521 true
522 );
523 }
524
525 if ($processor->getInvalidFileNames() !== []) {
526 $this->ui->mainTemplate()->setOnScreenMessage(
527 'info',
528 sprintf(
529 $this->lng->txt('file_upload_info_file_with_critical_extension'),
530 implode(', ', $processor->getInvalidFileNames())
531 ),
532 true
533 );
534 }
535
536 $link = match ($this->id_type) {
537 self::WORKSPACE_NODE_ID => $this->ctrl->getLinkTargetByClass(ilObjWorkspaceRootFolderGUI::class),
538 default => ilLink::_getLink($this->requested_ref_id),
539 };
540
541 $this->ctrl->redirectToURL($link);
542 }
ilObjFileProcessor
Class ilObjFileProcessorInterface.
Definition: class.ilObjFileProcessor.php:27
ilObjectGUI\getCreationFormsHTML
getCreationFormsHTML(StandardForm|ilPropertyFormGUI|array $form)
Definition: class.ilObjectGUI.php:704

References $data, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

+ Here is the call graph for this function:

◆ versions()

ilObjFileGUI::versions ( )

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

772 : void
773 {
774 $this->ctrl->redirectToURL(
775 (string) $this->capabilities->get(Capabilities::MANAGE_VERSIONS)->getUri()
776 );
777 }

References ILIAS\Repository\ctrl().

+ Here is the call graph for this function:

◆ viewExternal()

ilObjFileGUI::viewExternal ( )
protected

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

792 : void
793 {
794 $this->ctrl->redirectToURL(
795 (string) $this->capabilities->get(Capabilities::VIEW_EXTERNAL)->getUri()
796 );
797 }

References ILIAS\Repository\ctrl().

+ Here is the call graph for this function:

Field Documentation

◆ $action_repo

ActionDBRepository ilObjFileGUI::$action_repo
private

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

◆ $capabilities

CapabilityCollection ilObjFileGUI::$capabilities
private

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

◆ $data_factory

Factory ilObjFileGUI::$data_factory
protected

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

◆ $file_service_settings

ilFileServicesSettings ilObjFileGUI::$file_service_settings
protected

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

◆ $general_settings

General ilObjFileGUI::$general_settings
protected

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

◆ $icon_repo

IconDatabaseRepository ilObjFileGUI::$icon_repo
protected

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

◆ $inputs

ILIAS UI Component Input Factory ilObjFileGUI::$inputs
protected

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

◆ $lng

ilLanguage ilObjFileGUI::$lng

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

◆ $log

ilLogger ilObjFileGUI::$log = null
protected

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

◆ $lom_services

LOMServices ilObjFileGUI::$lom_services
protected

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

◆ $obj_service

ilObjectService ilObjFileGUI::$obj_service
protected

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

◆ $object

ilObjFile null ilObjFileGUI::$object = null

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

◆ $refinery

ILIAS Refinery Factory ilObjFileGUI::$refinery
protected

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

◆ $renderer

Renderer ilObjFileGUI::$renderer
protected

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

◆ $request

ServerRequestInterface ilObjFileGUI::$request
protected

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

◆ $stakeholder

ResourceStakeholder ilObjFileGUI::$stakeholder
protected

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

◆ $storage

Services ilObjFileGUI::$storage
protected

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

◆ $ui

UIServices ilObjFileGUI::$ui
protected

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

◆ $upload_handler

UploadHandler ilObjFileGUI::$upload_handler
protected

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

◆ CMD_EDIT

const ilObjFileGUI::CMD_EDIT = Capabilities::EDIT_SETTINGS->value

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

◆ CMD_SEND_FILE

const ilObjFileGUI::CMD_SEND_FILE = Capabilities::DOWNLOAD->value

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

◆ CMD_UPLOAD_FILES

const ilObjFileGUI::CMD_UPLOAD_FILES = "uploadFiles"

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

◆ CMD_VERSIONS

const ilObjFileGUI::CMD_VERSIONS = Capabilities::MANAGE_VERSIONS->value

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

◆ PARAM_COPYRIGHT_ID

const ilObjFileGUI::PARAM_COPYRIGHT_ID = "copyright_id"

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

◆ PARAM_DESCRIPTION

const ilObjFileGUI::PARAM_DESCRIPTION = 'description'

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

◆ PARAM_FILES

const ilObjFileGUI::PARAM_FILES = 'files'

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

◆ PARAM_TITLE

const ilObjFileGUI::PARAM_TITLE = 'title'

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

◆ PARAM_UPLOAD_ORIGIN

const ilObjFileGUI::PARAM_UPLOAD_ORIGIN = 'origin'

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

◆ UPLOAD_MAX_FILES

const ilObjFileGUI::UPLOAD_MAX_FILES = 100

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

◆ UPLOAD_ORIGIN_DROPZONE

const ilObjFileGUI::UPLOAD_ORIGIN_DROPZONE = 'dropzone'

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

◆ UPLOAD_ORIGIN_STANDARD

const ilObjFileGUI::UPLOAD_ORIGIN_STANDARD = 'standard'

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

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