ILIAS  trunk Revision v12.0_alpha-1221-g4e438232683
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

 recordReadEvent ()
 
 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 53 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 101 of file class.ilObjFileGUI.php.

102 {
103 global $DIC;
104 $this->refinery = $DIC->refinery();
105 $this->file_service_settings = $DIC->fileServiceSettings();
106 $this->user = $DIC->user();
107 $this->lng = $DIC->language();
108 $this->log = ilLoggerFactory::getLogger(ilObjFile::OBJECT_TYPE);
109 $this->ui = $DIC->ui();
110 $this->storage = $DIC->resourceStorage();
111 $this->upload_handler = new ilObjFileUploadHandlerGUI();
112 $this->stakeholder = new ilObjFileStakeholder();
113 $this->general_settings = new General();
114 parent::__construct($a_id, $a_id_type, $a_parent_node_id);
115 $this->obj_service = $DIC->object();
116 $this->lng->loadLanguageModule(ilObjFile::OBJECT_TYPE);
117 $this->icon_repo = new IconDatabaseRepository();
118 $this->inputs = $DIC->ui()->factory()->input();
119 $this->renderer = $DIC->ui()->renderer();
120 $this->request = $DIC->http()->request();
121 $this->data_factory = new Factory();
122 $this->action_repo = new ActionDBRepository($DIC->database());
123 $this->lom_services = $DIC->learningObjectMetadata();
124
125 $capability_builder = new CapabilityBuilder(
126 new ilObjFileInfoRepository(),
127 $this->access,
128 $this->ctrl,
129 $this->action_repo,
130 $DIC->http(),
131 $DIC['static_url.uri_builder']
132 );
133
134 $capability_context = new Context(
135 $this->object_id,
136 $this->ref_id,
137 ($a_id_type === self::WORKSPACE_NODE_ID) ? Context::CONTEXT_WORKSPACE : Context::CONTEXT_REPO
138 );
139
140 $this->capabilities = $capability_builder->get($capability_context);
141 }
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 1090 of file class.ilObjFileGUI.php.

1090 : void
1091 {
1092 global $DIC;
1093 $main_tpl = $DIC->ui()->mainTemplate();
1094 $ilErr = $DIC['ilErr'];
1095 $lng = $DIC['lng'];
1096 $ilAccess = $DIC['ilAccess'];
1097
1098 if ($a_additional && str_ends_with((string) $a_additional, "wsp")) {
1099 ilObjectGUI::_gotoSharedWorkspaceNode((int) $a_target);
1100 }
1101
1102 // added support for direct download goto links
1103 if ($a_additional && str_ends_with((string) $a_additional, "download")) {
1104 ilObjectGUI::_gotoRepositoryNode($a_target, "sendfile");
1105 }
1106
1107 // static method, no workspace support yet
1108
1109 if ($ilAccess->checkAccess("visible", "", $a_target)
1110 || $ilAccess->checkAccess("read", "", $a_target)) {
1111 ilObjectGUI::_gotoRepositoryNode($a_target, Capabilities::INFO_PAGE->value);
1112 } elseif ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
1113 $main_tpl->setOnScreenMessage(
1114 'failure',
1115 sprintf(
1116 $lng->txt("msg_no_perm_read_item"),
1117 ilObject::_lookupTitle(ilObject::_lookupObjId($a_target))
1118 ),
1119 true
1120 );
1121 ilObjectGUI::_gotoRepositoryRoot();
1122 }
1123
1124 $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
1125 }
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:2033
ilObjectGUI\_gotoRepositoryRoot
static _gotoRepositoryRoot(bool $raise_error=false)
Goto repository root.
Definition: class.ilObjectGUI.php:2005
ilObjectGUI\_gotoRepositoryNode
static _gotoRepositoryNode(int $ref_id, string $cmd="")
Definition: class.ilObjectGUI.php:2024
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 398 of file class.ilObjFileGUI.php.

402 : void {
403 // abort if form-type is unknown
404 if (!in_array($form_type, [self::CFORM_NEW, self::CFORM_CLONE, self::CFORM_IMPORT], true)) {
405 return;
406 }
407 $title = $form->getTitle();
408 $form->setTitle(''); // see https://mantis.ilias.de/view.php?id=37786
409
410 $tpl = new ilTemplate("tpl.creation_acc_head.html", true, true, "components/ILIAS/ILIASObject");
411 $tpl->setVariable("TITLE", $this->lng->txt("option") . " " . $form_type . ": " . $title);
412
413 $accordion->addItem($tpl->get(), $form->getHTML());
414 }
ilAccordionGUI\addItem
addItem(string $a_header, string $a_content, bool $a_force_open=false)
Definition: class.ilAccordionGUI.php:267
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 1130 of file class.ilObjFileGUI.php.

1130 : void
1131 {
1132 global $DIC;
1133 $ilLocator = $DIC['ilLocator'];
1134
1135 if (is_object($this->object)) {
1136 $ilLocator->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, ""), "", $this->node_id);
1137 }
1138 }

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 377 of file class.ilObjFileGUI.php.

381 : void {
382 // abort if form-type is unknown
383 if (!in_array($form_type, [self::CFORM_NEW, self::CFORM_CLONE, self::CFORM_IMPORT], true)) {
384 return;
385 }
386
387 $inputs = $form->getInputs();
388 // use label of first input as title, because UI Component forms don't support form-titles yet
389 $title = ($inputs === []) ?
390 '' : $inputs[array_key_first($inputs)]->getLabel();
391
392 $tpl = new ilTemplate("tpl.creation_acc_head.html", true, true, "components/ILIAS/ILIASObject");
393 $tpl->setVariable("TITLE", $this->lng->txt("option") . " " . $form_type . ": " . $title);
394
395 $accordion->addItem($tpl->get(), $this->ui->renderer()->render($form));
396 }
ilObjFileGUI\$inputs
ILIAS UI Component Input Factory $inputs
Definition: class.ilObjFileGUI.php:91
ILIAS\UI\Component\Input\Container\Container\getInputs
getInputs()
Get the inputs contained in the container.

◆ buildInfoScreen()

ilObjFileGUI::buildInfoScreen ( bool  $kiosk_mode)

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

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

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 624 of file class.ilObjFileGUI.php.

624 : void
625 {
626 global $DIC;
627 $ilErr = $DIC['ilErr'];
628
629 if (!$this->capabilities->get(Capabilities::EDIT_SETTINGS)->isUnlocked()) {
630 $ilErr->raiseError($this->lng->txt("msg_no_perm_write"));
631 }
632
633 $this->initSettingsTab();
634
635 $form = $this->initPropertiesForm();
636
637 // $ecs = new ilECSFileSettings($this->object);
638 // $ecs->addSettingsToForm($form, ilObjFile::OBJECT_TYPE); TODO: reintroduce usage of ECS file settings once they have been made compatible with the new ui components
639
640 $this->tpl->setContent($this->renderer->render($form));
641 }

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

+ Here is the call graph for this function:

◆ editExternal()

ilObjFileGUI::editExternal ( )
protected

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

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

References ILIAS\Repository\ctrl().

+ Here is the call graph for this function:

◆ getCreationFormTitle()

ilObjFileGUI::getCreationFormTitle ( )
protected

Reimplemented from ilObjectGUI.

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

426 : string
427 {
428 return $this->lng->txt('upload_files');
429 }

References ILIAS\Repository\lng().

+ Here is the call graph for this function:

◆ getCtrl()

ilObjFileGUI::getCtrl ( )
protected

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

1156 : \ilCtrl
1157 {
1158 return $this->ctrl;
1159 }
ilCtrl
Class ilCtrl provides processing control methods.
Definition: class.ilCtrl.php:36

◆ getFileObj()

ilObjFileGUI::getFileObj ( )
protected
Exceptions
ilFileException

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

1164 : ilObjFile
1165 {
1166 if (!$this->object instanceof ilObjFile) {
1167 throw new ilFileException("Error: object is not of type ilObjFile or doesn't exist");
1168 }
1169
1170 return $this->object;
1171 }
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 1173 of file class.ilObjFileGUI.php.

1173 : ilObjFileStakeholder
1174 {
1175 return $this->stakeholder;
1176 }
ilObjFileGUI\$stakeholder
ResourceStakeholder $stakeholder
Definition: class.ilObjFileGUI.php:83

◆ getGeneralSettings()

ilObjFileGUI::getGeneralSettings ( )
protected

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

1178 : General
1179 {
1180 return $this->general_settings;
1181 }
ilObjFileGUI\$general_settings
General $general_settings
Definition: class.ilObjFileGUI.php:88

◆ getLanguage()

ilObjFileGUI::getLanguage ( )
protected

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

1183 : \ilLanguage
1184 {
1185 return $this->lng;
1186 }
ilLanguage
language handling
Definition: class.ilLanguage.php:43

References $lng.

◆ getNodeID()

ilObjFileGUI::getNodeID ( )
protected

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

1188 : int
1189 {
1190 return $this->node_id;
1191 }

◆ getParentId()

ilObjFileGUI::getParentId ( )

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

173 : int
174 {
175 return $this->parent_id;
176 }

References ilObject2GUI\$parent_id.

◆ getRefinery()

ilObjFileGUI::getRefinery ( )
protected

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

1193 : \ILIAS\Refinery\Factory
1194 {
1195 return $this->refinery;
1196 }
ilObjFileGUI\$refinery
ILIAS Refinery Factory $refinery
Definition: class.ilObjFileGUI.php:87

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

◆ getType()

ilObjFileGUI::getType ( )

Functions that must be overwritten.

Reimplemented from ilObject2GUI.

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

168 : string
169 {
170 return ilObjFile::OBJECT_TYPE;
171 }

References ilObjFile\OBJECT_TYPE.

◆ getUIFactory()

ilObjFileGUI::getUIFactory ( )
protected

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

1198 : ILIAS\UI\Factory
1199 {
1200 return $this->ui->factory();
1201 }
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 1203 of file class.ilObjFileGUI.php.

1203 : ilObjUser
1204 {
1205 return $this->user;
1206 }
ilObjUser
User class.
Definition: class.ilObjUser.php:48

◆ infoScreenForward()

ilObjFileGUI::infoScreenForward ( )

show information screen

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

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

420 : Standard
421 {
422 return $this->initUploadForm();
423 }
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 1141 of file class.ilObjFileGUI.php.

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

References ILIAS\Repository\object().

+ Here is the call graph for this function:

◆ initPropertiesForm()

ilObjFileGUI::initPropertiesForm ( )
protected

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

643 : Standard
644 {
645 $title_and_description = $this->object->getObjectProperties()->getPropertyTitleAndDescription()->toForm(
646 $this->lng,
647 $this->ui->factory()->input()->field(),
648 $this->refinery
649 );
650
651 $important_info = $this->inputs->field()->markdown(
652 new ilUIMarkdownPreviewGUI(),
653 $this->lng->txt('important_info'),
654 $this->lng->txt('important_info_byline')
655 )->withValue(
656 $this->object->getImportantInfo() ?? ""
657 );
658
659 $on_click_action = $this->inputs->field()->radio(
660 $this->lng->txt('on_click_action')
661 )->withOption(
662 (string) ilObjFile::CLICK_MODE_DOWNLOAD,
663 $this->lng->txt('file_action_download'),
664 $this->lng->txt('file_action_download_info'),
665 )->withOption(
666 (string) ilObjFile::CLICK_MODE_INFOPAGE,
667 $this->lng->txt('file_action_show'),
668 $this->lng->txt('file_action_show_info'),
669 )->withValue(
670 (string) $this->object->getOnClickMode()
671 );
672
673 $input_groups = array_filter([
674 "title_and_description" => $title_and_description,
675 "important_info" => $important_info,
676 "on_click_action" => $on_click_action
677 ], static fn(FormInput $input): bool => null !== $input);
678
679 $file_info_section = $this->inputs->field()->section(
680 $input_groups,
681 $this->lng->txt('file_info')
682 );
683
684 $online_status = $this->object->getObjectProperties()->getPropertyIsOnline()->toForm(
685 $this->lng,
686 $this->ui->factory()->input()->field(),
687 $this->refinery
688 );
689 $availability_section = $this->inputs->field()->section(
690 ["online_status" => $online_status],
691 $this->lng->txt('rep_activation_availability')
692 );
693
694 $presentation_section = null;
695 if ($this->id_type === self::REPOSITORY_NODE_ID) {
696 $tile_image = $this->object->getObjectProperties()->getPropertyTileImage()->toForm(
697 $this->lng,
698 $this->ui->factory()->input()->field(),
699 $this->refinery
700 );
701 $presentation_section = $this->inputs->field()->section(
702 ["tile_image" => $tile_image],
703 $this->lng->txt('settings_presentation_header')
704 );
705 }
706
707 $additional_features_section = null;
708 if ($this->id_type === self::REPOSITORY_NODE_ID) {
709 $this->lng->loadLanguageModule('rating');
710
711 $enable_rating = $this->inputs->field()->checkbox(
712 $this->lng->txt('rating_activate_rating'),
713 $this->lng->txt('rating_activate_rating_info')
714 )->withValue(
715 $this->object->hasRating()
716 );
717 $additional_features_section = $this->inputs->field()->section(
718 ["rating" => $enable_rating],
719 $this->lng->txt('obj_features')
720 );
721 }
722
723 $inputs = array_filter([
724 "file_info" => $file_info_section,
725 "availability" => $availability_section,
726 "presentation" => $presentation_section,
727 "obj_features" => $additional_features_section
728 ], static fn(?Section $input): bool => null !== $input);
729
730 return $this->inputs->container()->form()->standard(
731 $this->ctrl->getLinkTargetByClass(self::class, 'update'),
732 $inputs
733 );
734 }
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 1070 of file class.ilObjFileGUI.php.

1070 : void
1071 {
1072 $this->tabs_gui->activateTab("settings");
1073 // add subtab for common settings
1074 $this->tabs_gui->addSubTab(
1075 'file_settings',
1076 $this->lng->txt('settings'),
1077 $this->ctrl->getLinkTargetByClass(self::class, self::CMD_EDIT)
1078 );
1079 if (in_array('file', ilAdvancedMDRecord::_getActivatedObjTypes(), true)) {
1080 $this->tabs_gui->addSubTab(
1081 'service_settings',
1082 $this->lng->txt('service_settings'),
1083 $this->ctrl->getLinkTargetByClass(ilFileCommonSettingsGUI::class, ilFileCommonSettingsGUI::CMD_EDIT)
1084 );
1085 }
1086
1087 $this->tabs_gui->activateSubTab("file_settings");
1088 }
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 431 of file class.ilObjFileGUI.php.

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

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 556 of file class.ilObjFileGUI.php.

556 : void
557 {
558 // this is needed to support multi fileuploads in personal and shared resources
559 $backup_node_id = $this->node_id;
560 parent::putObjectInTree($obj, $parent_node_id);
561 $this->node_id = $backup_node_id;
562 }

◆ recordReadEvent()

ilObjFileGUI::recordReadEvent ( )
protected

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

143 : void
144 {
145 // Record read event and catchup with write events
146 ilChangeEvent::_recordReadEvent(
147 $this->object->getType(),
148 $this->object->getRefId(),
149 $this->object->getId(),
150 $this->user->getId()
151 );
152 $this->updateLearningProgress();
153 }
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

References ilChangeEvent\_recordReadEvent(), ILIAS\Repository\object(), and updateLearningProgress().

+ Here is the call graph for this function:

◆ sendFile()

ilObjFileGUI::sendFile ( )

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

736 : bool
737 {
738 $hist_entry_id = $this->request_wrapper->has('hist_id')
739 ? $this->request_wrapper->retrieve('hist_id', $this->refinery->kindlyTo()->int())
740 : null;
741 try {
742 if (ANONYMOUS_USER_ID === $this->user->getId() && $this->request_wrapper->has('transaction')) {
743 $this->object->sendFile($hist_entry_id);
744 }
745
746 if ($this->capabilities->get(Capabilities::DOWNLOAD)->isUnlocked()) {
747 // Record read event and catchup with write events
748 $this->recordReadEvent();
749
750 $this->object->sendFile($hist_entry_id);
751 } else {
752 $this->error->raiseError($this->lng->txt("permission_denied"), $this->error->MESSAGE);
753 }
754 } catch (FileNotFoundException $e) {
755 $this->error->raiseError($e->getMessage(), $this->error->MESSAGE);
756 }
757
758 return true;
759 }
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
ANONYMOUS_USER_ID
const ANONYMOUS_USER_ID
Definition: constants.php:27

References Vendor\Package\$e, ANONYMOUS_USER_ID, error(), ILIAS\Repository\lng(), 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 996 of file class.ilObjFileGUI.php.

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

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

References ILIAS\Repository\ctrl().

+ Here is the call graph for this function:

◆ showSummaryForced()

ilObjFileGUI::showSummaryForced ( )

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

770 : void
771 {
772 $this->ctrl->redirectToURL(
773 (string) $this->capabilities->get(Capabilities::FORCED_INFO_PAGE)->getUri()
774 );
775 }

References ILIAS\Repository\ctrl().

+ Here is the call graph for this function:

◆ toggleLearningProgress()

ilObjFileGUI::toggleLearningProgress ( )
protected

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

851 : void
852 {
853 ilLearningProgress::_tracProgress(
854 $this->user->getId(),
855 $this->obj_id,
856 $this->ref_id,
857 'file'
858 );
859
860 $lp_marks = new ilLPMarks($this->obj_id, $this->user->getId());
861 $lp_marks->setCompleted(!ilLPStatus::_hasUserCompleted($this->object->getId(), $this->user->getId()));
862 $lp_marks->update();
863
864 ilLPStatusWrapper::_updateStatus($this->obj_id, $this->user->getId());
865
866 $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
867 $this->ctrl->redirect($this, Capabilities::INFO_PAGE->value);
868 }
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 784 of file class.ilObjFileGUI.php.

784 : void
785 {
786 $this->ctrl->redirectToURL(
787 (string) $this->capabilities->get(Capabilities::UNZIP)->getUri()
788 );
789 }

References ILIAS\Repository\ctrl().

+ Here is the call graph for this function:

◆ updateLearningProgress()

ilObjFileGUI::updateLearningProgress ( )
protected

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

155 : void
156 {
157 if ($this->object->getLPMode() === ilLPObjSettings::LP_MODE_CONTENT_VISITED) {
158 ilLPStatusWrapper::_updateStatus(
159 $this->object->getId(),
160 $this->user->getId(),
161 null,
162 false,
163 true
164 );
165 }
166 }

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

Referenced by recordReadEvent().

+ Here is the call graph for this function:
+ Here is the caller 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 477 of file class.ilObjFileGUI.php.

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

777 : void
778 {
779 $this->ctrl->redirectToURL(
780 (string) $this->capabilities->get(Capabilities::MANAGE_VERSIONS)->getUri()
781 );
782 }

References ILIAS\Repository\ctrl().

+ Here is the call graph for this function:

◆ viewExternal()

ilObjFileGUI::viewExternal ( )
protected

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

797 : void
798 {
799 $this->ctrl->redirectToURL(
800 (string) $this->capabilities->get(Capabilities::VIEW_EXTERNAL)->getUri()
801 );
802 }

References ILIAS\Repository\ctrl().

+ Here is the call graph for this function:

Field Documentation

◆ $action_repo

ActionDBRepository ilObjFileGUI::$action_repo
private

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

◆ $capabilities

CapabilityCollection ilObjFileGUI::$capabilities
private

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

◆ $data_factory

Factory ilObjFileGUI::$data_factory
protected

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

◆ $file_service_settings

ilFileServicesSettings ilObjFileGUI::$file_service_settings
protected

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

◆ $general_settings

General ilObjFileGUI::$general_settings
protected

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

◆ $icon_repo

IconDatabaseRepository ilObjFileGUI::$icon_repo
protected

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

◆ $inputs

ILIAS UI Component Input Factory ilObjFileGUI::$inputs
protected

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

◆ $lng

ilLanguage ilObjFileGUI::$lng

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

◆ $log

ilLogger ilObjFileGUI::$log = null
protected

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

◆ $lom_services

LOMServices ilObjFileGUI::$lom_services
protected

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

◆ $obj_service

ilObjectService ilObjFileGUI::$obj_service
protected

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

◆ $object

ilObjFile null ilObjFileGUI::$object = null

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

◆ $refinery

ILIAS Refinery Factory ilObjFileGUI::$refinery
protected

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

◆ $renderer

Renderer ilObjFileGUI::$renderer
protected

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

◆ $request

ServerRequestInterface ilObjFileGUI::$request
protected

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

◆ $stakeholder

ResourceStakeholder ilObjFileGUI::$stakeholder
protected

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

◆ $storage

Services ilObjFileGUI::$storage
protected

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

◆ $ui

UIServices ilObjFileGUI::$ui
protected

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

◆ $upload_handler

UploadHandler ilObjFileGUI::$upload_handler
protected

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

◆ CMD_EDIT

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

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

◆ CMD_SEND_FILE

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

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

◆ CMD_UPLOAD_FILES

const ilObjFileGUI::CMD_UPLOAD_FILES = "uploadFiles"

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

◆ CMD_VERSIONS

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

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

◆ PARAM_COPYRIGHT_ID

const ilObjFileGUI::PARAM_COPYRIGHT_ID = "copyright_id"

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

◆ PARAM_DESCRIPTION

const ilObjFileGUI::PARAM_DESCRIPTION = 'description'

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

◆ PARAM_FILES

const ilObjFileGUI::PARAM_FILES = 'files'

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

◆ PARAM_TITLE

const ilObjFileGUI::PARAM_TITLE = 'title'

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

◆ PARAM_UPLOAD_ORIGIN

const ilObjFileGUI::PARAM_UPLOAD_ORIGIN = 'origin'

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

◆ UPLOAD_MAX_FILES

const ilObjFileGUI::UPLOAD_MAX_FILES = 100

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

◆ UPLOAD_ORIGIN_DROPZONE

const ilObjFileGUI::UPLOAD_ORIGIN_DROPZONE = 'dropzone'

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

◆ UPLOAD_ORIGIN_STANDARD

const ilObjFileGUI::UPLOAD_ORIGIN_STANDARD = 'standard'

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

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