|
ILIAS
release_8 Revision v8.24
|
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... | |
| update () | |
| updates object entry in object_data More... | |
| edit () | |
| sendFile () | |
| versions () | |
| unzipCurrentRevision () | |
| infoScreen () | |
| this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed More... | |
| infoScreenForward () | |
| show information screen More... | |
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] don't belong to the current 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) | |
| cancelDelete () | |
| view () | |
| view object content (repository/workspace switch) More... | |
| getType () | |
| Functions that must be overwritten. More... | |
| create () | |
| CRUD. More... | |
| save () | |
| edit () | |
| update () | |
| cancel () | |
| importFile () | |
| putObjectInTree (ilObject $obj, int $parent_node_id=null) | |
| Add object to tree at given position. More... | |
Public Member Functions inherited from ilObjectGUI | |
| __construct ($data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true) | |
| getRefId () | |
| setAdminMode (string $mode) | |
| getAdminMode () | |
| getObject () | |
| executeCommand () | |
| withReferences () | |
| determines whether objects are referenced or not (got ref ids or not) More... | |
| setCreationMode (bool $mode=true) | |
| if true, a creation screen is displayed the current [ref_id] don't belong to the current class! The mode is determined in ilRepositoryGUI More... | |
| getCreationMode () | |
| prepareOutput (bool $show_sub_objects=true) | |
| getAdminTabs () | |
| administration tabs show only permissions and trash folder More... | |
| getHTML () | |
| confirmedDeleteObject () | |
| confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More... | |
| cancelDeleteObject () | |
| cancel deletion of object More... | |
| cancelObject () | |
| cancel action and go back to previous page More... | |
| createObject () | |
| create new object form More... | |
| cancelCreation () | |
| cancel create action and go back to repository parent More... | |
| saveObject () | |
| getDidacticTemplateVar (string $type) | |
| Get didactic template setting from creation screen. More... | |
| putObjectInTree (ilObject $obj, int $parent_node_id=null) | |
| Add object to tree at given position. More... | |
| editObject () | |
| addExternalEditFormCustom (ilPropertyFormGUI $form) | |
| updateObject () | |
| updates object entry in object_data More... | |
| getFormAction (string $cmd, string $default_form_action="") | |
| Get form action for command (command is method name without "Object", e.g. More... | |
| isVisible (int $ref_id, string $type) | |
| viewObject () | |
| viewObject container presentation for "administration -> repository, trash, permissions" More... | |
| deleteObject (bool $error=false) | |
| Display deletion confirmation screen. More... | |
| setColumnSettings (ilColumnGUI $column_gui) | |
| redirectAfterCreation () | |
| Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen. More... | |
| addToDeskObject () | |
| removeFromDeskObject () | |
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback | |
| callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb) | |
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 = 0 |
| const | PARAM_UPLOAD_ORIGIN = 'origin' |
| const | UPLOAD_ORIGIN_STANDARD = 'standard' |
| const | UPLOAD_ORIGIN_DROPZONE = 'dropzone' |
| const | CMD_EDIT = "edit" |
| const | CMD_VERSIONS = "versions" |
| const | CMD_UPLOAD_FILES = "uploadFiles" |
| 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 | ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION |
| const | ADMIN_MODE_NONE = "" |
| const | ADMIN_MODE_SETTINGS = "settings" |
| const | ADMIN_MODE_REPOSITORY = "repository" |
| const | UPLOAD_TYPE_LOCAL = 1 |
| const | UPLOAD_TYPE_UPLOAD_DIRECTORY = 2 |
| const | CFORM_NEW = 1 |
| const | CFORM_IMPORT = 2 |
| const | CFORM_CLONE = 3 |
Protected Member Functions | |
| render () | |
| This Method is needed if called from personal resources. More... | |
| addUIFormToAccordion (ilAccordionGUI $accordion, Standard $form, int $form_type) | |
| addLegacyFormToAccordion (ilAccordionGUI $accordion, ilPropertyFormGUI $form, int $form_type) | |
| getCreationFormsHTML (array $a_forms) | |
| Get HTML for creation forms (accordion) More... | |
| initCreationForms ($a_new_type) | |
| uploadFiles () | |
| MUST be protected, since this is Called from ilObject2GUI when used in Personal Workspace. More... | |
| initPropertiesForm () | |
| setTabs () | |
| create tabs (repository/workspace switch) More... | |
| addLocatorItems () | |
| Functions to be overwritten. More... | |
| initHeaderAction ($a_sub_type=null, $a_sub_id=null) | |
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... | |
| fillCloneTemplate (?string $tpl_varname, string $type) | |
| Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. 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... | |
| initCreationForms (string $new_type) | |
| Init creation forms. More... | |
| checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $node_id=null) | |
| initHeaderAction (?string $sub_type=null, ?int $sub_id=null) | |
| Add header action menu. More... | |
| redrawHeaderAction () | |
| Updating icons after ajax call. More... | |
| getPermanentLinkWidget (string $append=null, bool $center=false) | |
Protected Member Functions inherited from ilObjectGUI | |
| getObjectService () | |
| assignObject () | |
| setTitleAndDescription () | |
| initHeaderAction (?string $sub_type=null, ?int $sub_id=null) | |
| Add header action menu. More... | |
| insertHeaderAction (?ilObjectListGUI $list_gui=null) | |
| Insert header action into main template. More... | |
| addHeaderAction () | |
| Add header action menu. More... | |
| redrawHeaderActionObject () | |
| Ajax call: redraw action header only. More... | |
| setTabs () | |
| set admin tabs More... | |
| setAdminTabs () | |
| set admin tabs More... | |
| setLocator () | |
| addLocatorItems () | |
| should be overwritten to add object specific items (repository items are preloaded) More... | |
| omitLocator (bool $omit=true) | |
| addAdminLocatorItems (bool $do_not_add_object=false) | |
| should be overwritten to add object specific items (repository items are preloaded) More... | |
| initCreationForms (string $new_type) | |
| Init creation forms. More... | |
| getCreationFormsHTML (array $forms) | |
| Get HTML for creation forms (accordion) More... | |
| initCreateForm (string $new_type) | |
| initDidacticTemplate (ilPropertyFormGUI $form) | |
| addDidacticTemplateOptions (array &$a_options) | |
| Add custom templates. More... | |
| afterSave (ilObject $new_object) | |
| Post (successful) object creation hook. More... | |
| initEditForm () | |
| initEditCustomForm (ilPropertyFormGUI $a_form) | |
| Add custom fields to update form. More... | |
| getEditFormValues () | |
| getEditFormCustomValues (array &$a_values) | |
| Add values to custom edit fields. More... | |
| validateCustom (ilPropertyFormGUI $form) | |
| Validate custom values (if not possible with checkInput()) More... | |
| updateCustom (ilPropertyFormGUI $form) | |
| Insert custom update form values into object. More... | |
| afterUpdate () | |
| Post (successful) object update hook. More... | |
| initImportForm (string $new_type) | |
| importFileObject (int $parent_id=null) | |
| afterImport (ilObject $new_object) | |
| Post (successful) object import hook. More... | |
| setFormAction (string $cmd, string $form_action) | |
| getReturnLocation (string $cmd, string $default_location="") | |
| Get return location for command (command is method name without "Object", e.g. More... | |
| setReturnLocation (string $cmd, string $location) | |
| set specific return location for command More... | |
| getTargetFrame (string $cmd, string $default_target_frame="") | |
| get target frame for command (command is method name without "Object", e.g. More... | |
| setTargetFrame (string $cmd, string $target_frame) | |
| Set specific target frame for command. More... | |
| showPossibleSubObjects () | |
| show possible sub objects (pull down menu) More... | |
| getTabs () | |
| @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... | |
| fillCloneTemplate (?string $tpl_name, string $type) | |
| Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More... | |
| getCenterColumnHTML () | |
| Get center column. More... | |
| getRightColumnHTML () | |
| Display right column. More... | |
| checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null) | |
| checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null) | |
| enableDragDropFileUpload () | |
| Enables the file upload into this object by dropping files. More... | |
| showCustomIconsEditing ( $input_colspan=1, ilPropertyFormGUI $form=null, $as_section=true) | |
| show edit section of custom icons for container More... | |
GUI class for file objects.
Definition at line 36 of file class.ilObjFileGUI.php.
| 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 64 of file class.ilObjFileGUI.php.
References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilLoggerFactory\getLogger(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilObjFile\OBJECT_TYPE, ILIAS\Repository\refinery(), ILIAS\Repository\ui(), and ILIAS\Repository\user().
Here is the call graph for this function:
|
static |
Definition at line 800 of file class.ilObjFileGUI.php.
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:
|
protected |
Definition at line 255 of file class.ilObjFileGUI.php.
|
protected |
Functions to be overwritten.
Reimplemented from ilObject2GUI.
Definition at line 839 of file class.ilObjFileGUI.php.
References $DIC, and ILIAS\Repository\object().
Here is the call graph for this function:
|
protected |
Definition at line 237 of file class.ilObjFileGUI.php.
References ILIAS\UI\Implementation\Component\Input\$inputs, ilObject2GUI\$tpl, ilAccordionGUI\addItem(), ilGlobalTemplateInterface\get(), ILIAS\UI\Implementation\Component\Input\Container\Container\getInputs(), ILIAS\Repository\lng(), and ilGlobalTemplateInterface\setVariable().
Here is the call graph for this function:| ilObjFileGUI::edit | ( | ) |
Reimplemented from ilObject2GUI.
Definition at line 496 of file class.ilObjFileGUI.php.
References $DIC, $ilErr, ILIAS\Repository\lng(), and ilObjFile\OBJECT_TYPE.
Here is the call graph for this function:
|
protected |
Get HTML for creation forms (accordion)
| array<int,ilPropertyFormGUI> | $forms |
Reimplemented from ilObjectGUI.
Definition at line 278 of file class.ilObjFileGUI.php.
References $type, ilAccordionGUI\FIRST_OPEN, and ILIAS\Repository\ui().
Here is the call graph for this function:| ilObjFileGUI::getParentId | ( | ) |
Definition at line 88 of file class.ilObjFileGUI.php.
References ilObject2GUI\$parent_id.
| ilObjFileGUI::getType | ( | ) |
Functions that must be overwritten.
Reimplemented from ilObject2GUI.
Definition at line 83 of file class.ilObjFileGUI.php.
References ilObjFile\OBJECT_TYPE.
| ilObjFileGUI::infoScreen | ( | ) |
this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed
Definition at line 607 of file class.ilObjFileGUI.php.
References ILIAS\Repository\ctrl().
Referenced by render().
Here is the call graph for this function:
Here is the caller graph for this function:| ilObjFileGUI::infoScreenForward | ( | ) |
show information screen
Definition at line 617 of file class.ilObjFileGUI.php.
References $context, $GLOBALS, $preview, $tpl, $version, ilObjFileAccess\_getPermanentDownloadLink(), ilPreviewGUI\CONTEXT_REPOSITORY, ilPreviewGUI\CONTEXT_WORKSPACE, ILIAS\Repository\ctrl(), ilUtil\formatSize(), ilLinkButton\getInstance(), ilUserUtil\getNamePresentation(), ilPreview\hasPreview(), IL_CAL_DATETIME, ILIAS\Repository\lng(), ILIAS\Repository\object(), and ILIAS\Repository\toolbar().
Here is the call graph for this function:
|
protected |
Definition at line 315 of file class.ilObjFileGUI.php.
References ilObjFile\OBJECT_TYPE.
|
protected |
Definition at line 849 of file class.ilObjFileGUI.php.
References ILIAS\Repository\object().
Here is the call graph for this function:
|
protected |
Definition at line 521 of file class.ilObjFileGUI.php.
References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\object().
Here is the call graph for this function:| ilObjFileGUI::initUploadForm | ( | ) |
Definition at line 328 of file class.ilObjFileGUI.php.
References ILIAS\Repository\ctrl(), ilFileUtils\getUploadSizeLimitBytes(), ILIAS\Repository\lng(), ilObjFileProcessorInterface\OPTION_DESCRIPTION, ilObjFileProcessorInterface\OPTION_FILENAME, and ILIAS\Repository\ui().
Here is the call graph for this function:| ilObjFileGUI::putObjectInTree | ( | ilObject | $obj, |
| int | $parent_node_id = null |
||
| ) |
Add object to tree at given position.
Reimplemented from ilObject2GUI.
Definition at line 439 of file class.ilObjFileGUI.php.
|
protected |
This Method is needed if called from personal resources.
Definition at line 232 of file class.ilObjFileGUI.php.
References infoScreen().
Here is the call graph for this function:| ilObjFileGUI::sendFile | ( | ) |
Definition at line 558 of file class.ilObjFileGUI.php.
References Vendor\Package\$e, ilChangeEvent\_recordReadEvent(), ilLPStatusWrapper\_updateStatus(), ANONYMOUS_USER_ID, error(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().
Here is the call graph for this function:
|
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 731 of file class.ilObjFileGUI.php.
References $DIC, $lng, ilLearningProgressAccess\checkAccess(), ilFileVersionsGUI\CMD_DEFAULT, ILIAS\Repository\ctrl(), ILIAS\Repository\object(), and ilObjFile\OBJECT_TYPE.
Here is the call graph for this function:| ilObjFileGUI::unzipCurrentRevision | ( | ) |
Definition at line 597 of file class.ilObjFileGUI.php.
References ilFileVersionsGUI\CMD_UNZIP_CURRENT_REVISION, and ILIAS\Repository\ctrl().
Here is the call graph for this function:| ilObjFileGUI::update | ( | ) |
updates object entry in object_data
Reimplemented from ilObject2GUI.
Definition at line 450 of file class.ilObjFileGUI.php.
References $data, $DIC, $filename, $ilUser, ilChangeEvent\_catchupWriteEvents(), ilChangeEvent\_recordWriteEvent(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilUtil\redirect().
Here is the call graph for this function:
|
protected |
MUST be protected, since this is Called from ilObject2GUI when used in Personal Workspace.
Definition at line 358 of file class.ilObjFileGUI.php.
References $errors, ilLink\_getLink(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilObjFileProcessorInterface\OPTION_DESCRIPTION, ilObjFileProcessorInterface\OPTION_FILENAME, ILIAS\Repository\refinery(), and ILIAS\Repository\ui().
Here is the call graph for this function:| ilObjFileGUI::versions | ( | ) |
Definition at line 592 of file class.ilObjFileGUI.php.
References ILIAS\Repository\ctrl().
Here is the call graph for this function:
|
protected |
Definition at line 59 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 58 of file class.ilObjFileGUI.php.
| ilLanguage ilObjFileGUI::$lng |
Definition at line 50 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 55 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 56 of file class.ilObjFileGUI.php.
| ilObject ilObjFileGUI::$object = null |
Definition at line 49 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 57 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 53 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 54 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 51 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 52 of file class.ilObjFileGUI.php.
| const ilObjFileGUI::CMD_EDIT = "edit" |
Definition at line 45 of file class.ilObjFileGUI.php.
| const ilObjFileGUI::CMD_UPLOAD_FILES = "uploadFiles" |
Definition at line 47 of file class.ilObjFileGUI.php.
| const ilObjFileGUI::CMD_VERSIONS = "versions" |
Definition at line 46 of file class.ilObjFileGUI.php.
| const ilObjFileGUI::PARAM_FILES = 0 |
Definition at line 39 of file class.ilObjFileGUI.php.
| const ilObjFileGUI::PARAM_UPLOAD_ORIGIN = 'origin' |
Definition at line 41 of file class.ilObjFileGUI.php.
| const ilObjFileGUI::UPLOAD_MAX_FILES = 100 |
Definition at line 38 of file class.ilObjFileGUI.php.
| const ilObjFileGUI::UPLOAD_ORIGIN_DROPZONE = 'dropzone' |
Definition at line 43 of file class.ilObjFileGUI.php.
| const ilObjFileGUI::UPLOAD_ORIGIN_STANDARD = 'standard' |
Definition at line 42 of file class.ilObjFileGUI.php.