This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjDataCollectionGUI:

Collaboration diagram for ilObjDataCollectionGUI:

Public Member Functions
	__construct (int $a_id=0, int $a_id_type=self::REPOSITORY_NODE_ID, int $a_parent_node_id=0)

	getObjectId ()

	getStandardCmd ()

	getType ()

	executeCommand ()

	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...

	render ()
	show Content; redirect to ilDclRecordListGUI::listRecords More...

	infoScreenForward ()
	show information screen More...

	editObject ()
	edit object public More...

	listRecords ()

	getDataCollectionObject ()

	toggleNotification ()

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)

	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 (string $a_target)

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	GET_DCL_GTR = "dcl_gtr"

const	GET_REF_ID = "ref_id"

const	GET_VIEW_ID = "tableview_id"

const	TAB_EDIT_DCL = 'settings'

const	TAB_LIST_TABLES = 'dcl_tables'

const	TAB_EXPORT = 'export'

const	TAB_LIST_PERMISSIONS = 'perm_settings'

const	TAB_INFO = 'info_short'

const	TAB_CONTENT = 'content'

ilObject	$object = null

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
	handleExport (bool $do_default=false)

	getTableViewId ()

	addLocatorItems ()

	afterSave (ilObject $new_object)

	setTabs ()
	setTabs create tabs (repository/workspace switch) this had to be moved here because of the context-specific permission tab More...

	initEditForm ()

	getEditFormCustomValues (array &$a_values)

	updateCustom (ilPropertyFormGUI $form)

	addHeaderAction ()

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

	setTargetFrame (string $cmd, string $target_frame)

	getCenterColumnHTML ()

	getRightColumnHTML ()

	checkPermission (string $perm, string $cmd="", string $type="", int $ref_id=null)

	showPossibleSubObjects ()

	redirectToRefId (int $ref_id, string $cmd="")

	fillCloneTemplate (?string $tpl_varname, string $type)

	addAdminLocatorItems (bool $do_not_add_object=false)

	setTabs ()
	create tabs (repository/workspace switch) More...

	getReturnLocation (string $cmd, string $location="")
	Deprecated functions. More...

	setReturnLocation (string $cmd, string $location)

	showActions ()

	getTabs ()

	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 ()
	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...

Protected Attributes
ilCtrl	$ctrl

ilLanguage	$lng

ILIAS HTTP Services	$http

ilTabsGUI	$tabs

int	$table_id

Protected Attributes inherited from ilObject2GUI
ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ilObjectService	$object_service

ilFavouritesManager	$favourites

ilErrorHandling	$error

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilToolbarGUI	$toolbar

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

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 = array()

	$access_handler

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

Factory	$refinery

ilFavouritesManager	$favourites

ilObjectCustomIconFactory	$custom_icon_factory

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 Member Functions
	setTableId (int $objectOrRefId=0)

	addJavaScript ()

	addTab (string $langKey, string $link)

	emptyInfo ()

Private Attributes
ilDataCollectionUiPort	$dclUi

ilDataCollectionEndpointPort	$dclEndPoint

ilDataCollectionAccessPort	$dclAccess

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

Definition at line 30 of file class.ilObjDataCollectionGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjDataCollectionGUI::__construct	(	int	$a_id = `0`,
		int	$a_id_type = `self::REPOSITORY_NODE_ID`,
		int	$a_parent_node_id = `0`
	)

Definition at line 55 of file class.ilObjDataCollectionGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), addJavaScript(), ILIAS\Repository\ctrl(), ilObjectGUI\getRefId(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilDataCollectionEndpointAdapter\new(), ilDataCollectionAccessAdapter\new(), ilDataCollectionUiAdapter\new(), setTableId(), and ILIAS\Repository\tabs().

     {
         global $DIC;
         parent::__construct($a_id, $a_id_type, $a_parent_node_id);
 
         $this->http = $DIC->http();
         $this->tabs = $DIC->tabs();
 
         $this->lng->loadLanguageModule("dcl");
         $this->lng->loadLanguageModule('content');
         $this->lng->loadLanguageModule('obj');
         $this->lng->loadLanguageModule('cntr');
 
         $this->setTableId($this->getRefId());
 
         $this->dclEndPoint = ilDataCollectionEndpointAdapter::new();
         $this->dclAccess = ilDataCollectionAccessAdapter::new();
         $this->dclUi = ilDataCollectionUiAdapter::new();
 
         if ($this->ctrl->isAsynch() === false) {
             $this->addJavaScript();
         }
 
         $this->dclEndPoint->saveParameterTableId($this);
     }

Here is the call graph for this function:

Member Function Documentation

◆ _goto()

static ilObjDataCollectionGUI::_goto ( string $a_target )

static

Definition at line 368 of file class.ilObjDataCollectionGUI.php.

References $DIC, $refId, ilObjectGUI\_gotoRepositoryNode(), ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilDataCollectionUiPort\displayFailureMessage(), ilDataCollectionAccessPort\hasReadPermission(), ilDataCollectionAccessPort\hasVisibleOrReadPermission(), ilDataCollectionAccessPort\hasVisiblePermission(), ilDataCollectionOutboundsAdapter\new(), and ilLanguage\txt().

                                                   : void
     {
         global $DIC;
         $lng = $DIC->language();
 
         $dclConfig = ilDataCollectionOutboundsAdapter::new();
         $dclUi = $dclConfig->getDataCollectionUi();
 
         $ilCtrl = $DIC->ctrl();
         $dclAccess = $dclConfig->getDataCollectionAccess();
 
         $targetParts = explode("_", $a_target);
         if (count($targetParts) === 1) {
             [$refId] = $targetParts;
         } elseif (count($targetParts) === 2) {
             [$refId, $viewId] = $targetParts;
         } else {
             [$refId, $viewId, $recordId] = $targetParts;
         }
 
         //redirect if no permission given
         if ($dclAccess->hasVisibleOrReadPermission($refId) === false) {
             $dclUi->displayFailureMessage(
                 sprintf(
                     $lng->txt("msg_no_perm_read_item"),
                     ilObject::_lookupTitle(ilObject::_lookupObjId($a_target))
                 )
             );
             ilObjectGUI::_gotoRepositoryRoot();
         }
 
         //load record list
         if ($dclAccess->hasReadPermission($refId) === true) {
             $ilCtrl->setParameterByClass("ilRepositoryGUI", self::GET_REF_ID, $refId);
             if (isset($viewId)) {
                 $ilCtrl->setParameterByClass("ilRepositoryGUI", self::GET_VIEW_ID, $viewId);
             }
             if (isset($recordId)) {
                 $ilCtrl->setParameterByClass("ilRepositoryGUI", self::GET_DCL_GTR, $recordId);
             }
             $ilCtrl->redirectByClass("ilRepositoryGUI", "listRecords");
         }
 
         //redirect to info screen
         if ($dclAccess->hasVisiblePermission($refId) === true) {
             ilObjectGUI::_gotoRepositoryNode($a_target, "infoScreen");
         }
     }

Here is the call graph for this function:

◆ addHeaderAction()

ilObjDataCollectionGUI::addHeaderAction ( )

protected

Definition at line 607 of file class.ilObjDataCollectionGUI.php.

References ilObjectGUI\$obj_id, ILIAS\Repository\access(), ANONYMOUS_USER_ID, ILIAS\Repository\ctrl(), ilUtil\getImagePath(), ilNotification\hasNotification(), ILIAS\Repository\lng(), ilNotification\TYPE_DATA_COLLECTION, ilCommonActionDispatcherGUI\TYPE_REPOSITORY, and ILIAS\Repository\user().

Referenced by executeCommand().

                                         : void
     {
         ilObjectListGUI::prepareJSLinks(
             $this->ctrl->getLinkTarget($this, "redrawHeaderAction", "", true),
             "",
             $this->ctrl->getLinkTargetByClass(array("ilcommonactiondispatchergui", "iltagginggui"), "", "", true)
         );
 
         $dispatcher = new ilCommonActionDispatcherGUI(ilCommonActionDispatcherGUI::TYPE_REPOSITORY, $this->access, "dcl", $this->ref_id, $this->obj_id);
 
         $lg = $dispatcher->initHeaderAction();
 
         // notification
         if ($this->user->getId() != ANONYMOUS_USER_ID and $this->object->getNotification() == 1) {
             if (ilNotification::hasNotification(ilNotification::TYPE_DATA_COLLECTION, $this->user->getId(), $this->obj_id)) {
                 //Command Activate Notification
                 $this->ctrl->setParameter($this, "ntf", 1);
                 $lg->addCustomCommand($this->ctrl->getLinkTarget($this, "toggleNotification"), "dcl_notification_deactivate_dcl");
 
                 $lg->addHeaderIcon("not_icon", ilUtil::getImagePath("notification_on.svg"), $this->lng->txt("dcl_notification_activated"));
             } else {
                 //Command Deactivate Notification
                 $this->ctrl->setParameter($this, "ntf", 2);
                 $lg->addCustomCommand($this->ctrl->getLinkTarget($this, "toggleNotification"), "dcl_notification_activate_dcl");
 
                 $lg->addHeaderIcon("not_icon", ilUtil::getImagePath("notification_off.svg"), $this->lng->txt("dcl_notification_deactivated"));
             }
             $this->ctrl->setParameter($this, "ntf", "");
         }
 
         $this->tpl->setHeaderActionMenu($lg->getHeaderAction());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addJavaScript()

ilObjDataCollectionGUI::addJavaScript ( )

private

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

Referenced by __construct().

                                     : void
     {
         $this->dclUi->addJavaScriptFile("Modules/DataCollection/js/datacollection.js");
     }

Here is the caller graph for this function:

◆ addLocatorItems()

ilObjDataCollectionGUI::addLocatorItems ( )

protected

Exceptions

ilCtrlException

Definition at line 357 of file class.ilObjDataCollectionGUI.php.

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

                                         : void
     {
         if (is_object($this->object) === true) {
             $this->dclUi->addLocatorItem(
                 $this->object->getTitle(),
                 $this->ctrl->getLinkTarget($this, ""),
                 $this->object->getRefId()
             );
         }
     }

Here is the call graph for this function:

◆ addTab()

ilObjDataCollectionGUI::addTab	(	string	$langKey,
		string	$link
	)

private

Definition at line 463 of file class.ilObjDataCollectionGUI.php.

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

Referenced by setTabs().

                                                           : void
     {
         $this->tabs->addTab($langKey, $this->lng->txt($langKey), $link);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ afterSave()

ilObjDataCollectionGUI::afterSave ( ilObject $new_object )

protected

Definition at line 417 of file class.ilObjDataCollectionGUI.php.

References ILIAS\Repository\lng().

                                                       : void
     {
         $this->dclUi->displaySuccessMessage($this->lng->txt("object_added"));
 
         $listTablesLink = $this->dclEndPoint->getListTablesLink();
         $this->dclEndPoint->redirect($listTablesLink);
     }

Here is the call graph for this function:

◆ editObject()

ilObjDataCollectionGUI::editObject ( )

edit object public

Definition at line 472 of file class.ilObjDataCollectionGUI.php.

References $refId, ilObject2GUI\$tpl, ilObjectGUI\addExternalEditFormCustom(), ilObjectGUI\getEditFormValues(), initEditForm(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Referenced by executeCommand().

                                 : void
     {
         $dataCollectionTemplate = $this->tpl;
 
         $refId = $this->object->getRefId();
         if ($this->dclAccess->hasWritePermission($refId) === false) {
             $this->dclUi->displayErrorMessage(
                 $this->lng->txt("msg_no_perm_write")
             );
         }
 
         $this->tabs->activateTab(self::TAB_EDIT_DCL);
 
         $form = $this->initEditForm();
         $values = $this->getEditFormValues();
         if ($values) {
             $form->setValuesByArray($values, true);
         }
 
         $this->addExternalEditFormCustom($form);
 
         $dataCollectionTemplate->setContent($form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ emptyInfo()

ilObjDataCollectionGUI::emptyInfo ( )

private

Definition at line 571 of file class.ilObjDataCollectionGUI.php.

References $DIC, ilDclCache\getTableCache(), ILIAS\Repository\object(), and ilLanguage\txt().

Referenced by updateCustom().

                                 : void
     {
         global $DIC;
         $lng = $DIC['lng'];
         $table = ilDclCache::getTableCache($this->object->getFirstVisibleTableId());
         $tables = $this->object->getTables();
         if (count($tables) === 1 && count($table->getRecordFields()) === 0 && count($table->getRecords()) === 0
             && $this->object->getOnline()
         ) {
             $this->tpl->setOnScreenMessage('info', $lng->txt("dcl_no_content_warning"), true);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjDataCollectionGUI::executeCommand ( )

Exceptions

ilCtrlException

Definition at line 117 of file class.ilObjDataCollectionGUI.php.

References $DIC, addHeaderAction(), ilObject2GUI\checkPermissionBool(), ilDclRecordListGUI\CMD_LIST_RECORDS, ILIAS\Repository\ctrl(), editObject(), ilObject2GUI\getCreationMode(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), ilObjectGUI\getObject(), ilObjectGUI\getRefId(), getTableViewId(), handleExport(), ILIAS\FileDelivery\http(), infoScreenForward(), listRecords(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilObject2GUI\prepareOutput(), ILIAS\Repository\refinery(), and ILIAS\Repository\tabs().

                                     : void
     {
         global $DIC;
 
         $ilNavigationHistory = $DIC['ilNavigationHistory'];
         $ilHelp = $DIC['ilHelp'];
         $ilHelp->setScreenIdComponent('bibl');
 
         // Navigation History
         $link = $this->ctrl->getLinkTarget($this, "render");
 
         if ($this->getObject() !== null) {
             $ilNavigationHistory->addItem($this->object->getRefId(), $link, "dcl");
         }
 
         $hasDclGtr = $this->http->wrapper()->query()->has(self::GET_DCL_GTR);
         // Direct-Link Resource, redirect to viewgui
         if ($hasDclGtr) {
             $table_view_id = $this->getTableViewId();
             $record_id = $this->http->wrapper()->query()->retrieve(
                 self::GET_DCL_GTR,
                 $this->refinery->kindlyTo()->int()
             );
 
             $this->ctrl->setParameterByClass(ilDclDetailedViewGUI::class, 'tableview_id', $table_view_id);
             $this->ctrl->setParameterByClass(ilDclDetailedViewGUI::class, 'record_id', $record_id);
             $this->ctrl->redirectByClass(ilDclDetailedViewGUI::class, 'renderRecord');
         }
 
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd();
 
         if (!$this->getCreationMode() && $next_class != "ilinfoscreengui" && $cmd != 'infoScreen' && !$this->checkPermissionBool("read")) {
             $DIC->ui()->mainTemplate()->loadStandardTemplate();
             $DIC->ui()->mainTemplate()->setContent("Permission Denied.");
 
             return;
         }
 
         switch ($next_class) {
             case "ilinfoscreengui":
                 $this->prepareOutput();
                 $this->tabs->activateTab(self::TAB_INFO);
                 $this->infoScreenForward();
                 break;
 
             case "ilcommonactiondispatchergui":
                 $this->prepareOutput();
                 $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                 $gui->enableCommentsSettings(false);
                 $this->ctrl->forwardCommand($gui);
                 break;
 
             case "ilpermissiongui":
                 $this->prepareOutput();
                 $this->tabs->activateTab(self::TAB_LIST_PERMISSIONS);
                 $perm_gui = new ilPermissionGUI($this);
                 $this->ctrl->forwardCommand($perm_gui);
                 break;
 
             case "ilobjectcopygui":
                 $cp = new ilObjectCopyGUI($this);
                 $cp->setType("dcl");
                 $DIC->ui()->mainTemplate()->loadStandardTemplate();
                 $this->ctrl->forwardCommand($cp);
                 break;
 
             case "ildcltablelistgui":
                 $this->prepareOutput();
                 $this->tabs->activateTab(self::TAB_LIST_TABLES);
                 $tablelist_gui = new ilDclTableListGUI($this);
                 $this->ctrl->forwardCommand($tablelist_gui);
                 break;
 
             case "ildclrecordlistgui":
                 $this->addHeaderAction();
                 $this->prepareOutput();
                 $this->tabs->activateTab(self::TAB_CONTENT);
                 $recordlist_gui = new ilDclRecordListGUI($this, $this->table_id, $this->getTableViewId());
                 $this->ctrl->forwardCommand($recordlist_gui);
                 break;
 
             case "ildclrecordeditgui":
                 $this->prepareOutput();
                 $this->tabs->activateTab(self::TAB_CONTENT);
                 $recordedit_gui = new ilDclRecordEditGUI($this, $this->table_id, $this->getTableViewId());
                 $this->ctrl->forwardCommand($recordedit_gui);
                 break;
 
             case "ilobjfilegui":
                 $this->prepareOutput();
                 $this->tabs->activateTab(self::TAB_CONTENT);
                 $file_gui = new ilObjFile($this->getRefId());
                 $this->ctrl->forwardCommand($file_gui);
                 break;
 
             case "ilratinggui":
                 $rgui = new ilRatingGUI();
 
                 $record_id = $this->http->wrapper()->query()->retrieve('record_id', $this->refinery->kindlyTo()->int());
                 $field_id = $this->http->wrapper()->query()->retrieve('field_id', $this->refinery->kindlyTo()->int());
 
                 $rgui->setObject($record_id, "dcl_record", $field_id, "dcl_field");
                 $rgui->executeCommand();
                 $this->listRecords();
                 break;
 
             case "ildcldetailedviewgui":
                 $this->prepareOutput();
                 $recordview_gui = new ilDclDetailedViewGUI($this, $this->getTableViewId());
                 $this->ctrl->forwardCommand($recordview_gui);
                 $this->tabs->clearTargets();
                 $this->tabs->setBackTarget(
                     $this->lng->txt("back"),
                     $this->ctrl->getLinkTargetByClass(
                         ilDclRecordListGUI::class,
                         ilDclRecordListGUI::CMD_LIST_RECORDS
                     )
                 );
                 break;
 
             case 'ilnotegui':
                 $this->prepareOutput();
                 $recordviewGui = new ilDclDetailedViewGUI($this, $this->getTableViewId());
                 $this->ctrl->forwardCommand($recordviewGui);
                 $this->tabs->clearTargets();
                 $this->tabs->setBackTarget($this->lng->txt("back"), $this->ctrl->getLinkTarget($this, ""));
                 break;
             case "ildclexportgui":
                 $this->handleExport();
                 break;
 
             case strtolower(ilDclPropertyFormGUI::class):
                 $recordedit_gui = new ilDclRecordEditGUI($this, $this->table_id, $this->getTableViewId());
                 $recordedit_gui->getRecord();
                 $recordedit_gui->initForm();
                 $form = $recordedit_gui->getForm();
                 $this->ctrl->forwardCommand($form);
                 break;
 
             default:
                 switch ($cmd) {
                     case 'edit': // this is necessary because ilObjectGUI only calls its own editObject (why??)
                         $this->prepareOutput();
                         $this->editObject();
                         break;
                     case 'export':
                         $this->handleExport(true);
                         break;
                     default:
                         parent::executeCommand();
                 }
         }
     }

Here is the call graph for this function:

◆ getDataCollectionObject()

ilObjDataCollectionGUI::getDataCollectionObject ( )

Definition at line 544 of file class.ilObjDataCollectionGUI.php.

                                              : ilObjDataCollection
     {
         return new ilObjDataCollection($this->ref_id, true);
     }

◆ getEditFormCustomValues()

ilObjDataCollectionGUI::getEditFormCustomValues ( array & $a_values )

protected

Definition at line 549 of file class.ilObjDataCollectionGUI.php.

                                                                 : void
     {
         $a_values["is_online"] = $this->object->getOnline();
         $a_values["rating"] = $this->object->getRating();
         $a_values["public_notes"] = $this->object->getPublicNotes();
         $a_values["approval"] = $this->object->getApproval();
         $a_values["notification"] = $this->object->getNotification();
     }

◆ getObjectId()

ilObjDataCollectionGUI::getObjectId ( )

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

References ilObjectGUI\$obj_id.

                                  : int
     {
         return $this->obj_id;
     }

◆ getStandardCmd()

ilObjDataCollectionGUI::getStandardCmd ( )

Definition at line 104 of file class.ilObjDataCollectionGUI.php.

                                     : string
     {
         return "render";
     }

◆ getTableViewId()

ilObjDataCollectionGUI::getTableViewId ( )

protected

Definition at line 287 of file class.ilObjDataCollectionGUI.php.

References ilObjectGUI\getRefId(), ilDclCache\getTableCache(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by executeCommand(), and listRecords().

                                        : int
     {
         $tableview_id = null;
         if ($this->http->wrapper()->query()->has('tableview_id')) {
             $tableview_id = $this->http->wrapper()->query()->retrieve(
                 'tableview_id',
                 $this->refinery->kindlyTo()->int()
             );
         }
         if ($this->http->wrapper()->post()->has('tableview_id')) {
             $tableview_id = $this->http->wrapper()->post()->retrieve(
                 'tableview_id',
                 $this->refinery->kindlyTo()->int()
             );
         }
         if (!$tableview_id) {
             $table_obj = ilDclCache::getTableCache($this->table_id);
             $tableview_id = $table_obj->getFirstTableViewId($this->getRefId());
         }
         return $tableview_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

ilObjDataCollectionGUI::getType ( )

Definition at line 109 of file class.ilObjDataCollectionGUI.php.

                              : string
     {
         return "dcl";
     }

◆ handleExport()

ilObjDataCollectionGUI::handleExport ( bool $do_default = false )

protected

Definition at line 272 of file class.ilObjDataCollectionGUI.php.

References $table_id, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilObject2GUI\prepareOutput(), and ILIAS\Repository\tabs().

Referenced by executeCommand().

     {
         $this->prepareOutput();
         $this->tabs->setTabActive(self::TAB_EXPORT);
         $exp_gui = new ilDclExportGUI($this);
         $exporter = new ilDclContentExporter($this->object->getRefId(), $this->table_id);
         $exp_gui->addFormat("xlsx", $this->lng->txt('dlc_xls_async_export'), $exporter, 'exportAsync');
         $exp_gui->addFormat("xml");
         if ($do_default) {
             $exp_gui->listExportFiles();
         } else {
             $this->ctrl->forwardCommand($exp_gui);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ infoScreen()

ilObjDataCollectionGUI::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 314 of file class.ilObjDataCollectionGUI.php.

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

                                 : void
     {
         $this->ctrl->setCmd("showSummary");
         $this->ctrl->setCmdClass("ilinfoscreengui");
         $this->infoScreenForward();
     }

Here is the call graph for this function:

◆ infoScreenForward()

ilObjDataCollectionGUI::infoScreenForward ( )

show information screen

Definition at line 339 of file class.ilObjDataCollectionGUI.php.

References ilObject2GUI\checkPermission(), ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ILIAS\Repository\object(), and ILIAS\Repository\tabs().

Referenced by executeCommand(), and infoScreen().

                                        : void
     {
         $this->tabs->activateTab(self::TAB_INFO);
 
         if (!$this->checkPermissionBool('visible')) {
             $this->checkPermission('read');
         }
 
         $info = new ilInfoScreenGUI($this);
         $info->enablePrivateNotes();
         $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());
 
         $this->ctrl->forwardCommand($info);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initEditForm()

ilObjDataCollectionGUI::initEditForm ( )

protected

Definition at line 496 of file class.ilObjDataCollectionGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilTextAreaInputGUI\setCols(), ilFormPropertyGUI\setInfo(), ILIAS\Repository\tabs(), and ilObject\TITLE_LENGTH.

Referenced by editObject().

                                      : ilPropertyFormGUI
     {
         $this->tabs->activateTab(self::TAB_EDIT_DCL);
 
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this, "update"));
         $form->setTitle($this->lng->txt($this->object->getType() . "_edit"));
 
         // title
         $ti = new ilTextInputGUI($this->lng->txt("title"), "title");
         $ti->setSize(min(40, ilObject::TITLE_LENGTH));
         $ti->setMaxLength(ilObject::TITLE_LENGTH);
         $ti->setRequired(true);
         $form->addItem($ti);
 
         // description
         $ta = new ilTextAreaInputGUI($this->lng->txt("description"), "desc");
         $ta->setCols(40);
         $ta->setRows(2);
         $form->addItem($ta);
 
         // is_online
         $cb = new ilCheckboxInputGUI($this->lng->txt("online"), "is_online");
         $cb->setInfo($this->lng->txt("dcl_online_info"));
         $form->addItem($cb);
 
         // Notification
         $cb = new ilCheckboxInputGUI($this->lng->txt("dcl_activate_notification"), "notification");
         $cb->setInfo($this->lng->txt("dcl_notification_info"));
         $form->addItem($cb);
 
         // tile img upload
         $section_appearance = new ilFormSectionHeaderGUI();
         $section_appearance->setTitle($this->lng->txt('cont_presentation'));
         $form->addItem($section_appearance);
         $form = $this->object_service->commonSettings()->legacyForm($form, $this->object)->addTileImage();
 
         $form->addCommandButton("update", $this->lng->txt("save"));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listRecords()

ilObjDataCollectionGUI::listRecords ( )

final

Definition at line 538 of file class.ilObjDataCollectionGUI.php.

References getTableViewId().

Referenced by executeCommand().

                                        : void
     {
         $listRecordsLink = $this->dclEndPoint->getListRecordsLink($this->getTableViewId());
         $this->dclEndPoint->redirect($listRecordsLink);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ render()

ilObjDataCollectionGUI::render ( )

show Content; redirect to ilDclRecordListGUI::listRecords

Definition at line 324 of file class.ilObjDataCollectionGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

                             : void
     {
         if ($this->http->wrapper()->query()->has('tableview_id')) {
             $tableview_id = $this->http->wrapper()->query()->retrieve(
                 'tableview_id',
                 $this->refinery->kindlyTo()->int()
             );
             $this->ctrl->setParameterByClass('ilDclRecordListGUI', 'tableview_id', $tableview_id);
         }
         $this->ctrl->redirectByClass("ildclrecordlistgui", "show");
     }

Here is the call graph for this function:

◆ setTableId()

ilObjDataCollectionGUI::setTableId ( int $objectOrRefId = 0 )

private

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

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by __construct().

                                                        : void
     {
         if ($this->http->wrapper()->query()->has('table_id')) {
             $this->table_id = $this->http->wrapper()->query()->retrieve('table_id', $this->refinery->kindlyTo()->int());
         } elseif ($this->http->wrapper()->query()->has('tableview_id')) {
             $this->table_id = ilDclTableView::find(
                 $this->http->wrapper()->query()->retrieve('tableview_id', $this->refinery->kindlyTo()->int())
             )->getTableId();
         } elseif ($objectOrRefId > 0) {
             $this->table_id = $this->object->getFirstVisibleTableId();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTabs()

ilObjDataCollectionGUI::setTabs ( )

protected

setTabs create tabs (repository/workspace switch) this had to be moved here because of the context-specific permission tab

Definition at line 430 of file class.ilObjDataCollectionGUI.php.

References $refId, and addTab().

                                 : void
     {
         $refId = $this->object->getRefId();
 
         // read permission
         if ($this->dclAccess->hasReadPermission($refId) === true) {
             // list records
             $this->addTab(self::TAB_CONTENT, $this->dclEndPoint->getListRecordsLink());
         }
 
         // visible permission
         if ($this->dclAccess->hasVisibleOrReadPermission($refId) === true) {
             // info screen
             $this->addTab(self::TAB_INFO, $this->dclEndPoint->getInfoScreenLink());
         }
 
         // write permission
         if ($this->dclAccess->hasWritePermission($refId) === true) {
             // settings
             $this->addTab(self::TAB_EDIT_DCL, $this->dclEndPoint->getEditDclLink($this));
             // list tables
             $this->addTab(self::TAB_LIST_TABLES, $this->dclEndPoint->getListTablesLink());
             // export
             $this->addTab(self::TAB_EXPORT, $this->dclEndPoint->getDataCollectionExportLink());
         }
 
         // edit permissions
         if ($this->dclAccess->hasEditPermissionPermission($refId) === true) {
             //list permissions
             $this->addTab(self::TAB_LIST_PERMISSIONS, $this->dclEndPoint->getListPermissionsLink());
         }
     }

Here is the call graph for this function:

◆ toggleNotification()

ilObjDataCollectionGUI::toggleNotification ( )

final

Definition at line 584 of file class.ilObjDataCollectionGUI.php.

References ilObjectGUI\$obj_id, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), ilNotification\setNotification(), ilNotification\TYPE_DATA_COLLECTION, and ILIAS\Repository\user().

                                               : void
     {
         $ntf = $this->http->wrapper()->query()->retrieve('ntf', $this->refinery->kindlyTo()->int());
         switch ($ntf) {
             case 1:
                 ilNotification::setNotification(
                     ilNotification::TYPE_DATA_COLLECTION,
                     $this->user->getId(),
                     $this->obj_id,
                     false
                 );
                 break;
             case 2:
                 ilNotification::setNotification(
                     ilNotification::TYPE_DATA_COLLECTION,
                     $this->user->getId(),
                     $this->obj_id
                 );
                 break;
         }
         $this->ctrl->redirectByClass("ildclrecordlistgui", "show");
     }

Here is the call graph for this function:

◆ updateCustom()

ilObjDataCollectionGUI::updateCustom ( ilPropertyFormGUI $form )

protected

Definition at line 558 of file class.ilObjDataCollectionGUI.php.

References emptyInfo(), and ilPropertyFormGUI\getInput().

                                                             : void
     {
         $this->object->setOnline($form->getInput("is_online"));
         $this->object->setRating($form->getInput("rating"));
         $this->object->setPublicNotes($form->getInput("public_notes"));
         $this->object->setApproval($form->getInput("approval"));
         $this->object->setNotification($form->getInput("notification"));
 
         $this->object_service->commonSettings()->legacyForm($form, $this->object)->saveTileImage();
 
         $this->emptyInfo();
     }