ILIAS
trunk Revision v11.0_alpha-3011-gc6b235a2e85
|
GUI class for file objects. More...
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) | |
![]() | |
__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... | |
![]() | |
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 () | |
![]() | |
callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb) | |
Static Public Member Functions | |
static | _goto ($a_target, $a_additional=null) |
![]() | |
static | handleAfterSaveCallback (ilObject $obj, ?int $callback_ref_id) |
After creation callback. More... | |
![]() | |
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 |
![]() | |
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 |
![]() | |
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 () | |
![]() | |
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... | |
![]() | |
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) | |
Private Attributes | |
CapabilityCollection | $capabilities |
ActionDBRepository | $action_repo |
GUI class for file objects.
Definition at line 54 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 102 of file class.ilObjFileGUI.php.
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().
|
static |
Definition at line 1086 of file class.ilObjFileGUI.php.
References $DIC, $ilErr, $lng, ilObjectGUI\_gotoRepositoryNode(), ilObjectGUI\_gotoRepositoryRoot(), ilObjectGUI\_gotoSharedWorkspaceNode(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), and ROOT_FOLDER_ID.
|
protected |
Definition at line 387 of file class.ilObjFileGUI.php.
|
protected |
Functions to be overwritten.
Reimplemented from ilObject2GUI.
Definition at line 1126 of file class.ilObjFileGUI.php.
References $DIC, and ILIAS\Repository\object().
|
protected |
Definition at line 366 of file class.ilObjFileGUI.php.
ilObjFileGUI::buildInfoScreen | ( | bool | $kiosk_mode | ) |
Definition at line 866 of file class.ilObjFileGUI.php.
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().
ilObjFileGUI::edit | ( | ) |
Reimplemented from ilObject2GUI.
Definition at line 614 of file class.ilObjFileGUI.php.
References $DIC, $ilErr, ILIAS\Repository\lng(), and renderer().
|
protected |
Definition at line 787 of file class.ilObjFileGUI.php.
References ILIAS\Repository\ctrl().
|
protected |
Reimplemented from ilObjectGUI.
Definition at line 415 of file class.ilObjFileGUI.php.
References ILIAS\Repository\lng().
|
protected |
Definition at line 1152 of file class.ilObjFileGUI.php.
|
protected |
ilFileException |
Definition at line 1160 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 1169 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 1174 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 1179 of file class.ilObjFileGUI.php.
References $lng.
|
protected |
Definition at line 1184 of file class.ilObjFileGUI.php.
ilObjFileGUI::getParentId | ( | ) |
Definition at line 162 of file class.ilObjFileGUI.php.
References ilObject2GUI\$parent_id.
|
protected |
Definition at line 1189 of file class.ilObjFileGUI.php.
References ILIAS\UI\examples\Layout\Page\Standard\$refinery.
ilObjFileGUI::getType | ( | ) |
Functions that must be overwritten.
Reimplemented from ilObject2GUI.
Definition at line 157 of file class.ilObjFileGUI.php.
References ilObjFile\OBJECT_TYPE.
|
protected |
Definition at line 1194 of file class.ilObjFileGUI.php.
References ILIAS\Repository\ui().
|
protected |
Definition at line 1199 of file class.ilObjFileGUI.php.
ilObjFileGUI::infoScreenForward | ( | ) |
show information screen
Definition at line 803 of file class.ilObjFileGUI.php.
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().
|
protected |
Reimplemented from ilObjectGUI.
Definition at line 409 of file class.ilObjFileGUI.php.
|
protected |
Add header action menu.
Reimplemented from ilObject2GUI.
Definition at line 1137 of file class.ilObjFileGUI.php.
References ILIAS\Repository\object().
|
protected |
Definition at line 633 of file class.ilObjFileGUI.php.
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().
|
protected |
Definition at line 1066 of file class.ilObjFileGUI.php.
References ilAdvancedMDRecord\_getActivatedObjTypes(), ilFileCommonSettingsGUI\CMD_EDIT, and ILIAS\Repository\lng().
ilObjFileGUI::initUploadForm | ( | ) |
Definition at line 420 of file class.ilObjFileGUI.php.
References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Repository\ctrl(), getLanguage(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().
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.
ilObjFileGUI::sendFile | ( | ) |
Definition at line 726 of file class.ilObjFileGUI.php.
References Vendor\Package\$e, ilChangeEvent\_recordReadEvent(), ANONYMOUS_USER_ID, error(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().
|
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 992 of file class.ilObjFileGUI.php.
References $c, $DIC, ilLearningProgressAccess\checkAccess(), ilFileVersionsGUI\CMD_DEFAULT, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilObjFile\OBJECT_TYPE.
ilObjFileGUI::showSummary | ( | ) |
Definition at line 760 of file class.ilObjFileGUI.php.
References ILIAS\Repository\ctrl().
ilObjFileGUI::showSummaryForced | ( | ) |
Definition at line 766 of file class.ilObjFileGUI.php.
References ILIAS\Repository\ctrl().
|
protected |
Definition at line 847 of file class.ilObjFileGUI.php.
References ilLPStatus\_hasUserCompleted(), ilLearningProgress\_tracProgress(), ilLPStatusWrapper\_updateStatus(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ILIAS\Repository\user().
ilObjFileGUI::unzipCurrentRevision | ( | ) |
Definition at line 780 of file class.ilObjFileGUI.php.
References ILIAS\Repository\ctrl().
|
protected |
Definition at line 144 of file class.ilObjFileGUI.php.
References ilLPStatusWrapper\_updateStatus(), ilLPObjSettings\LP_MODE_CONTENT_VISITED, and ILIAS\Repository\object().
|
protected |
MUST be protected, since this is Called from ilObject2GUI when used in Personal Workspace.
Definition at line 466 of file class.ilObjFileGUI.php.
References $data, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().
ilObjFileGUI::versions | ( | ) |
Definition at line 773 of file class.ilObjFileGUI.php.
References ILIAS\Repository\ctrl().
|
protected |
Definition at line 793 of file class.ilObjFileGUI.php.
References ILIAS\Repository\ctrl().
|
private |
Definition at line 96 of file class.ilObjFileGUI.php.
|
private |
Definition at line 75 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 95 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 90 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 89 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 91 of file class.ilObjFileGUI.php.
Definition at line 92 of file class.ilObjFileGUI.php.
ilLanguage ilObjFileGUI::$lng |
Definition at line 81 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 86 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 97 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 87 of file class.ilObjFileGUI.php.
ilObjFile null ilObjFileGUI::$object = null |
Definition at line 80 of file class.ilObjFileGUI.php.
Definition at line 88 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 93 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 94 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 84 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 85 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 82 of file class.ilObjFileGUI.php.
|
protected |
Definition at line 83 of file class.ilObjFileGUI.php.
const ilObjFileGUI::CMD_EDIT = Capabilities::EDIT_SETTINGS->value |
Definition at line 70 of file class.ilObjFileGUI.php.
const ilObjFileGUI::CMD_SEND_FILE = Capabilities::DOWNLOAD->value |
Definition at line 74 of file class.ilObjFileGUI.php.
const ilObjFileGUI::CMD_UPLOAD_FILES = "uploadFiles" |
Definition at line 72 of file class.ilObjFileGUI.php.
const ilObjFileGUI::CMD_VERSIONS = Capabilities::MANAGE_VERSIONS->value |
Definition at line 71 of file class.ilObjFileGUI.php.
const ilObjFileGUI::PARAM_COPYRIGHT_ID = "copyright_id" |
Definition at line 64 of file class.ilObjFileGUI.php.
const ilObjFileGUI::PARAM_DESCRIPTION = 'description' |
Definition at line 63 of file class.ilObjFileGUI.php.
const ilObjFileGUI::PARAM_FILES = 'files' |
Definition at line 61 of file class.ilObjFileGUI.php.
const ilObjFileGUI::PARAM_TITLE = 'title' |
Definition at line 62 of file class.ilObjFileGUI.php.
const ilObjFileGUI::PARAM_UPLOAD_ORIGIN = 'origin' |
Definition at line 66 of file class.ilObjFileGUI.php.
const ilObjFileGUI::UPLOAD_MAX_FILES = 100 |
Definition at line 60 of file class.ilObjFileGUI.php.
const ilObjFileGUI::UPLOAD_ORIGIN_DROPZONE = 'dropzone' |
Definition at line 68 of file class.ilObjFileGUI.php.
const ilObjFileGUI::UPLOAD_ORIGIN_STANDARD = 'standard' |
Definition at line 67 of file class.ilObjFileGUI.php.