ilObjTalkTemplateAdministrationGUI Class Reference

Class ilObjTalkTemplateAdministrationGUI GUI class. More...

Inheritance diagram for ilObjTalkTemplateAdministrationGUI:

Collaboration diagram for ilObjTalkTemplateAdministrationGUI:

Public Member Functions
	isActiveAdministrationPanel ()
	setContentSubTabs ()
	executeCommand ()
	viewObject ()
	getContentGUI ()
	Filter the view by talk templates because the talk series objects are also children of the talk template administration. More...
	returnObject ()
	Not completely sure why this is necessary, after creation of talk templates the redirect leads here. 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
	supportsPageEditor ()
	setTitleAndDescription ()
	called by prepare output More...
	showPossibleSubObjects ()
	getCreatableObjectTypes ()
	getTabs ()
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)

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]
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 = ""

Detailed Description

Class ilObjTalkTemplateAdministrationGUI GUI class.

Author

: Nicolas Schaefli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch ilObjTalkTemplateAdministrationGUI: ilAdministrationGUI ilObjTalkTemplateAdministrationGUI: ilCommonActionDispatcherGUI ilObjTalkTemplateAdministrationGUI: ilColumnGUI, ilObjectCopyGUI, ilUserTableGUI ilObjTalkTemplateAdministrationGUI: ilPermissionGUI ilObjTalkTemplateAdministrationGUI: ilInfoScreenGUI ilObjTalkTemplateAdministrationGUI: ilObjTalkTemplateGUI ilObjTalkTemplateAdministrationGUI: ilObjEmployeeTalkSeriesGUI

Definition at line 32 of file class.ilObjTalkTemplateAdministrationGUI.php.

Member Function Documentation

executeCommand()

ilObjTalkTemplateAdministrationGUI::executeCommand

(

)

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

References ILIAS\Repository\ctrl(), ilObjTalkTemplateAdministration\getRootRefId(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

                                    : void
    {
        $cmd = $this->ctrl->getCmd();
        $next_class = $this->ctrl->getNextClass($this);


        switch ($next_class) {
            case 'ilpermissiongui':
                parent::prepareOutput();
                $this->tabs_gui->activateTab('perm_settings');
                $ilPermissionGUI = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($ilPermissionGUI);
                break;
            case 'ilinfoscreengui':
                parent::prepareOutput();
                $this->tabs_gui->activateTab('info_short');
                $ilInfoScreenGUI = new ilInfoScreenGUI($this);
                $this->ctrl->forwardCommand($ilInfoScreenGUI);
                break;
            case strtolower(ilObjTalkTemplateGUI::class):
                $ilTalkTemplateGUI = new ilObjTalkTemplateGUI();
                $ilTalkTemplateGUI->setAdminMode($this->admin_mode);
                $this->ctrl->setParameter(
                    $this,
                    'ref_id',
                    ilObjTalkTemplateAdministration::getRootRefId()
                );
                $this->tabs->setBackTarget(
                    $this->lng->txt('obj_tala'),
                    $this->ctrl->getLinkTarget($this, 'view')
                );
                $this->ctrl->clearParameters($this);
                $this->ctrl->forwardCommand($ilTalkTemplateGUI);
                break;
            default:
                parent::executeCommand();
        }
    }

Here is the call graph for this function:

getAdminTabs()

ilObjTalkTemplateAdministrationGUI::getAdminTabs

(

)

Parameters

ilTabsGUI

$tabs_gui

Definition at line 215 of file class.ilObjTalkTemplateAdministrationGUI.php.

References getTabs().

                                  : void
    {
        $this->getTabs();
    }

Here is the call graph for this function:

getContentGUI()

ilObjTalkTemplateAdministrationGUI::getContentGUI

(

)

Filter the view by talk templates because the talk series objects are also children of the talk template administration.

this is super messy, and should be refactored completely...

Returns

ilContainerContentGUI

Definition at line 172 of file class.ilObjTalkTemplateAdministrationGUI.php.

References ilContainerGUI\getItemPresentation(), ilContainerFilterField\STD_FIELD_OBJECT_TYPE, and ilObjTalkTemplate\TYPE.

                                   : ilContainerContentGUI
    {
        $this->container_user_filter = new ilContainerUserFilter([
            'std_' . ilContainerFilterField::STD_FIELD_OBJECT_TYPE => ilObjTalkTemplate::TYPE
        ]);
        return new ilContainerByTypeContentGUI(
            $this,
            $this->getItemPresentation()
        );
    }

Here is the call graph for this function:

getCreatableObjectTypes()

ilObjTalkTemplateAdministrationGUI::getCreatableObjectTypes ( )

protected

Definition at line 134 of file class.ilObjTalkTemplateAdministrationGUI.php.

References ILIAS\Repository\access(), ilObjectDefinition\MODE_ADMINISTRATION, ILIAS\Repository\object(), and ilObjEmployeeTalkSeries\TYPE.

Referenced by showPossibleSubObjects().

                                                : array
    {
        $subtypes = $this->obj_definition->getCreatableSubObjects(
            $this->object->getType(),
            ilObjectDefinition::MODE_ADMINISTRATION,
            $this->object->getRefId()
        );
        unset($subtypes[ilObjEmployeeTalkSeries::TYPE]);

        return array_filter(
            $subtypes,
            fn($key) => $this->access->checkAccess('create_' . $key, '', $this->ref_id, $this->type),
            ARRAY_FILTER_USE_KEY
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTabs()

ilObjTalkTemplateAdministrationGUI::getTabs ( )

protected

Definition at line 192 of file class.ilObjTalkTemplateAdministrationGUI.php.

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

Referenced by getAdminTabs().

                                : void
    {
        $read_access_ref_id = $this->rbacsystem->checkAccess('visible,read', $this->object->getRefId());
        if ($read_access_ref_id) {
            $this->tabs_gui->addTab('view_content', $this->lng->txt("content"), $this->ctrl->getLinkTarget($this, "view"));
            $this->tabs_gui->addTab(
                "info_short",
                $this->lng->txt('tab_info'),
                $this->ctrl->getLinkTargetByClass([
                    strtolower(self::class),
                    strtolower(ilInfoScreenGUI::class)
                ], "showSummary")
            );
        }
        if ($this->tree->getSavedNodeData($this->object->getRefId())) {
            $this->tabs_gui->addTarget('trash', $this->ctrl->getLinkTarget($this, 'trash'), 'trash', get_class($this));
        }
        parent::getTabs();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isActiveAdministrationPanel()

ilObjTalkTemplateAdministrationGUI::isActiveAdministrationPanel

(

)

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

                                                 : bool
    {
        return false;
    }

returnObject()

ilObjTalkTemplateAdministrationGUI::returnObject

(

)

Not completely sure why this is necessary, after creation of talk templates the redirect leads here.

Definition at line 187 of file class.ilObjTalkTemplateAdministrationGUI.php.

References viewObject().

                                  : void
    {
        $this->viewObject();
    }

Here is the call graph for this function:

setContentSubTabs()

ilObjTalkTemplateAdministrationGUI::setContentSubTabs

(

)

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

                                       : void
    {
    }

setTitleAndDescription()

ilObjTalkTemplateAdministrationGUI::setTitleAndDescription ( )

protected

called by prepare output

Definition at line 110 of file class.ilObjTalkTemplateAdministrationGUI.php.

References ILIAS\Repository\lng().

                                               : void
    {
        # all possible create permissions
        parent::setTitleAndDescription();
        $this->tpl->setTitle($this->lng->txt("objs_tala"));
        $this->tpl->setDescription($this->lng->txt("objs_tala"));

        $this->tpl->setTitleIcon("", $this->lng->txt("obj_" . $this->object->getType()));
    }

Here is the call graph for this function:

showPossibleSubObjects()

ilObjTalkTemplateAdministrationGUI::showPossibleSubObjects ( )

protected

Definition at line 120 of file class.ilObjTalkTemplateAdministrationGUI.php.

References ilContainerGUI\$gui, ilObjectGUI\buildGroup(), getCreatableObjectTypes(), and ILIAS\Repository\lng().

                                               : void
    {
        $subtypes = $this->getCreatableObjectTypes();
        $gui = new ILIAS\ILIASObject\Creation\AddNewItemGUI(
            [$this->buildGroup(
                self::class,
                array_keys($subtypes),
                $this->lng->txt('other'),
                $subtypes
            )]
        );
        $gui->render();
    }

Here is the call graph for this function:

supportsPageEditor()

ilObjTalkTemplateAdministrationGUI::supportsPageEditor ( )

protected

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

                                           : bool
    {
        return false;
    }

viewObject()

ilObjTalkTemplateAdministrationGUI::viewObject

(

)

Definition at line 150 of file class.ilObjTalkTemplateAdministrationGUI.php.

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by returnObject().

                                : void
    {
        $this->tabs_gui->activateTab('view_content');

        if (!$this->rbacsystem->checkAccess("read", $this->getRefId())) {
            if ($this->rbacsystem->checkAccess("visible", $this->getRefId())) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt("msg_no_perm_read"));
                $this->ctrl->redirectByClass(strtolower(ilInfoScreenGUI::class), '');
            }

            $this->ilias->raiseError($this->lng->txt("msg_no_perm_read"), $this->ilias->error_obj->WARNING);
        }

        parent::renderObject();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• components/ILIAS/EmployeeTalk/classes/class.ilObjTalkTemplateAdministrationGUI.php