ILIAS  trunk Revision v11.0_alpha-1861-g09f3d197f78
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
ilObjTalkTemplateGUI Class Reference

Class ilObjTalkTemplateGUI. More...

+ Inheritance diagram for ilObjTalkTemplateGUI:
+ Collaboration diagram for ilObjTalkTemplateGUI:

Public Member Functions

 executeCommand ()
 
 viewObject ()
 
 addExternalEditFormCustom (ilPropertyFormGUI $form)
 
 infoScreenObject ()
 infoScreen redirect handling of ObjListGUI More...
 
 getAdminTabs ()
 
- Public Member Functions inherited from ilContainerGUI
 executeCommand ()
 
 forwardToPageObject ()
 
 addPageTabs ()
 
 getContainerPageHTML ()
 
 getContentGUI ()
 
 renderObject ()
 
 renderBlockAsynchObject ()
 render the object More...
 
 setContentSubTabs ()
 
 showAdministrationPanel ()
 
 showPermanentLink ()
 
 editPageFrameObject ()
 
 cancelPageContentObject ()
 
 showLinkListObject ()
 
 addHeaderRow (ilTemplate $a_tpl, string $a_type, bool $a_show_image=true)
 
 addMessageRow (ilTemplate $a_tpl, string $a_message, string $a_type)
 
 setPageEditorTabs ()
 
 addStandardContainerSubTabs (bool $a_include_view=true)
 Add standard container subtabs for view, manage, oderdering and text/media editor link. More...
 
 enableAdministrationPanelObject ()
 
 disableAdministrationPanelObject ()
 
 editOrderObject ()
 
 isActiveOrdering ()
 
 isActiveItemOrdering ()
 
 enableMultiDownloadObject ()
 
 isMultiDownloadEnabled ()
 
 cutObject ()
 cut object(s) out from a container and write the information to clipboard public More...
 
 copyObject ()
 Copy object(s) out from a container and write the information to clipboard It is not possible to copy multiple objects at once. More...
 
 downloadObject ()
 
 getBucketTitle ()
 
 linkObject ()
 create an new reference of an object in tree it's like a hard link of unix More...
 
 clearObject ()
 clear clipboard and go back to last object More...
 
 performPasteIntoMultipleObjectsObject ()
 
 initAndDisplayLinkIntoMultipleObjectsObject ()
 
 showPasteTreeObject ()
 
 cancelMoveLinkObject ()
 Cancel move|link empty clipboard and return to parent. More...
 
 keepObjectsInClipboardObject ()
 
 initAndDisplayCopyIntoMultipleObjectsObject ()
 
 initAndDisplayMoveIntoObjectObject ()
 
 pasteObject ()
 paste object from clipboard to current place Depending on the chosen command the object(s) are linked, copied or moved More...
 
 clipboardObject ()
 
 isActiveAdministrationPanel ()
 
 setColumnSettings (ilColumnGUI $column_gui)
 
 allowBlocksMoving ()
 Standard is to allow blocks moving. More...
 
 allowBlocksConfigure ()
 Standard is to allow blocks configuration. More...
 
 cloneAllObject ()
 Clone all object Overwritten method for copying container objects. More...
 
 saveSortingObject ()
 
 cloneNodes (int $srcRef, int $dstRef, array &$mapping, ?string $newName=null)
 Recursively clones all nodes of the RBAC tree. More...
 
 modifyItemGUI (ilObjectListGUI $a_item_list_gui, array $a_item_data)
 
 editStylePropertiesObject ()
 
 redrawListItemObject ()
 Redraw a list item (ajax) More...
 
 trashObject ()
 Show trash content of object. More...
 
 trashApplyFilterObject ()
 
 trashResetFilterObject ()
 
 removeFromSystemObject ()
 
 undeleteObject ()
 Get objects back from trash. More...
 
 confirmRemoveFromSystemObject ()
 
 setSideColumnReturn ()
 
 getAdminTabs ()
 
 competencesObject ()
 
- 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)
 
- Public Member Functions inherited from ilDesktopItemHandling
 addToDeskObject ()
 
 removeFromDeskObject ()
 

Protected Member Functions

 initEditForm ()
 
 initEditCustomForm (ilPropertyFormGUI $a_form)
 
 getEditFormCustomValues (array &$a_values)
 
 updateCustom (ilPropertyFormGUI $form)
 
 getTabs ()
 
 addAdminLocatorItems (bool $do_not_add_object=false)
 
- Protected Member Functions inherited from ilContainerGUI
 getModeManager ()
 
 getItemPresentation ( $include_empty_blocks=true, ?string $lang=null)
 
 getEditFormValues ()
 
 afterUpdate ()
 
 setTitleAndDescription ()
 
 showPossibleSubObjects ()
 
 supportsPageEditor ()
 
 gotItems ()
 
 getTabs ()
 
 showContainerPageTabs ()
 
 showPasswordInstructionObject (bool $a_init=true)
 
 initFormPasswordInstruction ()
 Init password form. More...
 
 savePasswordObject ()
 
 initEditForm ()
 
 initSortingForm (ilPropertyFormGUI $form, array $a_sorting_settings)
 Append sorting settings to property form. More...
 
 initListPresentationForm (ilPropertyFormGUI $form)
 Add list presentation settings to form. More...
 
 saveListPresentation (ilPropertyFormGUI $form)
 
 initSortingDirectionForm (ilContainerSortingSettings $sorting_settings, ilRadioOption $element, string $a_prefix)
 Add sorting direction. More...
 
 initManualSortingOptionForm (ilContainerSortingSettings $settings, ilRadioOption $element, string $a_prefix, array $a_sorting_settings)
 Add manual sorting options. More...
 
 saveSortingSettings (ilPropertyFormGUI $form)
 
 trashHandleFilter (bool $action_apply, bool $action_reset)
 
 restoreToNewLocationObject (?ilPropertyFormGUI $form=null)
 
 getTreeSelectorGUI (string $cmd)
 
 initFilter ()
 
 showContainerFilter ()
 
- 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 ()
 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

MetadataHandlerInterface $md_handler
 
- Protected Attributes inherited from ilContainerGUI
ILIAS Container InternalGUIService $gui
 
ILIAS Style Content GUIService $content_style_gui
 
ilRbacSystem $rbacsystem
 
ilRbacReview $rbacreview
 
ILIAS Container Content ItemPresentationManager $item_presentation = null
 
ILIAS Container InternalDomainService $domain
 
ilTabsGUI $tabs
 
ilErrorHandling $error
 
ilObjectDefinition $obj_definition
 
ilRbacAdmin $rbacadmin
 
ilPropertyFormGUI $form
 
ilLogger $log
 
ilObjectDataCache $obj_data_cache
 
Services $global_screen
 
ilAppEventHandler $app_event_handler
 
UIServices $ui
 
ilContainerFilterService $container_filter_service
 
ilContainerUserFilter $container_user_filter = null
 
Standard $ui_filter = null
 
bool $edit_order = false
 
bool $adminCommands = false
 
string $requested_redirectSource = ""
 
int $current_position = 0
 
ClipboardManager $clipboard
 
StandardGUIRequest $std_request
 
ModeManager $mode_manager = null
 
ilComponentFactory $component_factory
 
ILIAS Style Content DomainService $content_style_domain
 
- Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service $notes_service
 
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
 
ilObjectCustomIconFactory $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 = ""
 

Additional Inherited Members

- Static Public Member Functions inherited from ilContainerGUI
static _buildPath (int $a_ref_id, int $a_course_ref_id)
 build path 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 inherited from ilContainerGUI
int $bl_cnt = 1
 
bool $multi_download_enabled = false
 
- 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]
 

Detailed Description

Member Function Documentation

◆ addAdminLocatorItems()

ilObjTalkTemplateGUI::addAdminLocatorItems ( bool  $do_not_add_object = false)
protected

Definition at line 180 of file class.ilObjTalkTemplateGUI.php.

References $container, $GLOBALS, $refId, ilObject\_exists(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), ilObjTalkTemplateAdministration\getRootRefId(), ILIAS\Repository\lng(), ILIAS\Repository\locator(), and ILIAS\Repository\object().

180  : void
181  {
182  parent::addAdminLocatorItems(true);
183 
184  $this->ctrl->setParameterByClass(
185  strtolower(ilObjTalkTemplateAdministrationGUI::class),
186  'ref_id',
188  );
189  $this->locator->addItem(
190  $this->lng->txt('obj_tala'),
191  $this->ctrl->getLinkTargetByClass(
192  ilObjTalkTemplateAdministrationGUI::class,
193  ControlFlowCommand::INDEX
194  )
195  );
196  $this->ctrl->clearParameterByClass(
197  strtolower(ilObjTalkTemplateAdministrationGUI::class),
198  'ref_id'
199  );
200 
201  $this->locator->addItem(
203  ilObject::_lookupObjId($this->object->getRefId())
204  ),
205  $this->ctrl->getLinkTargetByClass([
206  strtolower(ilAdministrationGUI::class),
207  strtolower(ilObjTalkTemplateAdministrationGUI::class),
208  strtolower(self::class),
209  ], ControlFlowCommand::INDEX)
210  );
211  }
static _lookupObjId(int $ref_id)
static _lookupTitle(int $obj_id)
+ Here is the call graph for this function:

◆ addExternalEditFormCustom()

ilObjTalkTemplateGUI::addExternalEditFormCustom ( ilPropertyFormGUI  $form)

Definition at line 122 of file class.ilObjTalkTemplateGUI.php.

References ilContainerGUI\$form, ILIAS\Repository\object(), and ilObjEmployeeTalk\TYPE.

122  : void
123  {
124  $header = new ilFormSectionHeaderGUI();
125  $header->setParentForm($form);
126  $header->setTitle("Metadata");
127 
128  $this->md_handler->attachSelectionToForm(
129  $this->object->getType(),
130  $this->object->getId(),
132  0,
133  $form
134  );
135 
136  parent::addExternalEditFormCustom($form);
137  }
ilPropertyFormGUI $form
+ Here is the call graph for this function:

◆ executeCommand()

ilObjTalkTemplateGUI::executeCommand ( )

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

References ILIAS\Repository\ctrl(), and ilObjectGUI\setCreationMode().

64  : void
65  {
66  $cmd = $this->ctrl->getCmd();
67  $next_class = $this->ctrl->getNextClass($this);
68 
69  if (!$next_class && ($cmd === 'create' || $cmd === 'save')) {
70  $this->setCreationMode();
71  }
72 
73  switch ($next_class) {
74  case 'ilinfoscreengui':
75  parent::prepareOutput();
76  $this->tabs_gui->activateTab('info_short');
77  $ilInfoScreenGUI = new ilInfoScreenGUI($this);
78  $this->ctrl->forwardCommand($ilInfoScreenGUI);
79  break;
80  default:
81  parent::executeCommand();
82  }
83  }
setCreationMode(bool $mode=true)
If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode...
+ Here is the call graph for this function:

◆ getAdminTabs()

ilObjTalkTemplateGUI::getAdminTabs ( )

Definition at line 175 of file class.ilObjTalkTemplateGUI.php.

References getTabs().

175  : void
176  {
177  $this->getTabs();
178  }
+ Here is the call graph for this function:

◆ getEditFormCustomValues()

ilObjTalkTemplateGUI::getEditFormCustomValues ( array &  $a_values)
protected

Definition at line 115 of file class.ilObjTalkTemplateGUI.php.

115  : void
116  {
117  $a_values['activation_online'] = !$this->object->getOfflineStatus();
118 
119  parent::getEditFormCustomValues($a_values);
120  }

◆ getTabs()

ilObjTalkTemplateGUI::getTabs ( )
protected

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

References ilObjectGUI\$type, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by getAdminTabs().

162  : void
163  {
164  $read_access_ref_id = $this->rbacsystem->checkAccess('visible,read', $this->object->getRefId());
165  if ($read_access_ref_id) {
166  $this->tabs_gui->addTab('view_content', $this->lng->txt("content"), $this->ctrl->getLinkTarget($this, "view"));
167  $this->tabs_gui->addTab("info_short", "Info", $this->ctrl->getLinkTargetByClass(strtolower(ilInfoScreenGUI::class), "showSummary"));
168  }
169 
170  if ($this->rbacsystem->checkAccess('write', $this->object->getRefId(), $this->type)) {
171  $this->tabs_gui->addTab('settings', $this->lng->txt("settings"), $this->ctrl->getLinkTarget($this, "edit"));
172  }
173  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ infoScreenObject()

ilObjTalkTemplateGUI::infoScreenObject ( )

infoScreen redirect handling of ObjListGUI

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

References ILIAS\Repository\ctrl().

157  : void
158  {
159  $this->ctrl->redirectByClass(strtolower(ilInfoScreenGUI::class), "showSummary");
160  }
+ Here is the call graph for this function:

◆ initEditCustomForm()

ilObjTalkTemplateGUI::initEditCustomForm ( ilPropertyFormGUI  $a_form)
protected

Definition at line 106 of file class.ilObjTalkTemplateGUI.php.

References ilPropertyFormGUI\addItem(), and ILIAS\Repository\lng().

106  : void
107  {
108  $online = new ilCheckboxInputGUI($this->lng->txt('rep_activation_online'), 'activation_online');
109  $online->setInfo($this->lng->txt('talt_activation_online_info'));
110  $a_form->addItem($online);
111 
112  parent::initEditCustomForm($a_form);
113  }
+ Here is the call graph for this function:

◆ initEditForm()

ilObjTalkTemplateGUI::initEditForm ( )
protected

Definition at line 99 of file class.ilObjTalkTemplateGUI.php.

References ilContainerGUI\$form, ilPropertyFormGUI\addCommandButton(), and ILIAS\Repository\lng().

100  {
101  $form = parent::initEditForm();
102  $form->addCommandButton("view", $this->lng->txt("cancel"));
103  return $form;
104  }
addCommandButton(string $a_cmd, string $a_text, string $a_id="")
ilPropertyFormGUI $form
+ Here is the call graph for this function:

◆ updateCustom()

ilObjTalkTemplateGUI::updateCustom ( ilPropertyFormGUI  $form)
protected

Definition at line 139 of file class.ilObjTalkTemplateGUI.php.

References ilContainerGUI\$form, ilPropertyFormGUI\getInput(), ILIAS\Repository\object(), and ilObjEmployeeTalk\TYPE.

139  : void
140  {
141  $this->object->setOfflineStatus(!$form->getInput('activation_online'));
142 
143  $this->md_handler->saveSelectionFromForm(
144  $this->object->getType(),
145  $this->object->getId(),
147  0,
148  $form
149  );
150 
151  parent::updateCustom($form);
152  }
getInput(string $a_post_var, bool $ensureValidation=true)
Returns the input of an item, if item provides getInput method and as fallback the value of the HTTP-...
ilPropertyFormGUI $form
+ Here is the call graph for this function:

◆ viewObject()

ilObjTalkTemplateGUI::viewObject ( )

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

References ilContainerGUI\$form, ILIAS\Repository\object(), and ilObjEmployeeTalk\TYPE.

85  : void
86  {
87  $this->tabs_gui->activateTab('view_content');
88 
89  $form = $this->md_handler->getDisabledEditForm(
90  $this->object->getType(),
91  $this->object->getId(),
93  0
94  );
95 
96  $this->tpl->setContent($form->render());
97  }
ilPropertyFormGUI $form
+ Here is the call graph for this function:

Field Documentation

◆ $md_handler

MetadataHandlerInterface ilObjTalkTemplateGUI::$md_handler
protected

Definition at line 38 of file class.ilObjTalkTemplateGUI.php.


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