ilObjDataCollectionGUI Class Reference

Class ilObjDataCollectionGUI. More...

Inheritance diagram for ilObjDataCollectionGUI:

Collaboration diagram for ilObjDataCollectionGUI:

Public Member Functions
	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...
	addLocatorItems ()
	setTabs ()
	setTabs create tabs (repository/workspace switch) More...
	listRecords ()
	called by goto More...
	getDataCollectionObject ()
	getEditFormCustomValues (array &$a_values)
	updateCustom (ilPropertyFormGUI $a_form)
	toggleNotification ()
	addHeaderAction ($a_redraw=false)
Public Member Functions inherited from ilObject2GUI
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
	Constructor. More...
	executeCommand ()
	execute command More...
	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 ($a_mode=true)
	getCreationMode ()
	prepareOutput ($a_show_subobjects=true)
	isVisible ($a_ref_id, $a_type)
	trash ()
	undelete ()
	cancelDelete ()
	removeFromSystem ()
	cloneAll ()
	view ()
	view object content (repository/workspace switch) More...
	getType ()
	Functions that must be overwritten. More...
	create ()
	Deleted in ilObject. More...
	save ()
	edit ()
	update ()
	cancel ()
	importFile ()
	Import. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...
	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	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 public More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	save object More...
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	edit object More...
	addExternalEditFormCustom (ilPropertyFormGUI $a_form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	list childs of current object More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...

Static Public Member Functions
static	_goto ($a_target)
Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $a_obj, $a_callback_ref_id)
	After creation callback. More...
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Data Fields
const	GET_DCL_GTR = "dcl_gtr"
const	GET_REF_ID = "ref_id"
const	GET_VIEW_ID = "tableview_id"
Data Fields inherited from ilObject2GUI
	$tree
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	COPY_WIZARD_NEEDS_PAGE = 1
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3

Protected Member Functions
	initCreationForms ($a_new_type)
	afterSave (ilObject $a_new_object)
	initEditCustomForm (ilPropertyFormGUI $a_form)
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 ()
	Get access handler. More...
	setLocator ()
	set Locator More...
	deleteConfirmation ()
	Display delete confirmation form (workspace specific) More...
	deleteConfirmedObjects ()
	Delete objects (workspace specific) More...
	setTitleAndDescription ()
	showUpperIcon ()
	omitLocator ($a_omit=true)
	getTargetFrame ($a_cmd, $a_target_frame="")
	setTargetFrame ($a_cmd, $a_target_frame)
	getCenterColumnHTML ()
	getRightColumnHTML ()
	setColumnSettings (ilColumnGUI $column_gui)
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	showPossibleSubObjects ()
	redirectToRefId ($a_ref_id, $a_cmd="")
	fillCloneTemplate ($a_tpl_varname, $a_type)
	fillCloneSearchTemplate ($a_tpl_varname, $a_type)
	searchCloneSource ()
	buildCloneSelect ($existing_objs)
	addAdminLocatorItems ($a_do_not_add_object=false)
	setTabs ()
	create tabs (repository/workspace switch) More...
	getReturnLocation ($a_cmd, $a_location="")
	Deprecated functions. More...
	setReturnLocation ($a_cmd, $a_location)
	showActions ()
	getTabs ()
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	addLocatorItems ()
	Functions to be overwritten. More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_node_id=null)
	Check permission. More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	redrawHeaderAction ()
	Updating icons after ajax call. More...
	getPermanentLinkWidget ($a_append=null, $a_center=false)
	handleAutoRating (ilObject $a_new_obj)
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...
	assignObject ()
	setTitleAndDescription ()
	called by prepare output More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	showMountWebfolderIcon ()
	setTabs ()
	set admin tabs public More...
	setAdminTabs ()
	set admin tabs public More...
	setLocator ()
	set Locator More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm ($a_new_type)
	Init object creation form. More...
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	Init object edit form. More...
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	Get values for edit form. More...
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm ($a_new_type)
	Init object import form. More...
	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...
	getTabs ()
	get tabs abstract method. More...
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...
	redirectToRefId ($a_ref_id, $a_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 $_GET["ref_id"] value More...
	fillCloneTemplate ($a_tpl_varname, $a_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...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Private Member Functions
	emptyInfo ()

Additional Inherited Members
Protected Attributes inherited from ilObject2GUI
	$object_id
	$node_id
	$creation_forms = array()
	$id_type = array()
	$parent_id
	$access_handler
Protected Attributes inherited from ilObjectGUI
	$ilErr
	$locator
	$user
	$access
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service

Detailed Description

Class ilObjDataCollectionGUI.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Marcel Raimann mr@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

ilObjDataCollectionGUI: ilInfoScreenGUI, ilNoteGUI, ilCommonActionDispatcherGUI ilObjDataCollectionGUI: ilPermissionGUI, ilObjectCopyGUI, ilDclExportGUI ilObjDataCollectionGUI: ilDclTreePickInputGUI ilObjDataCollectionGUI: ilDclRecordListGUI, ilDclRecordEditGUI ilObjDataCollectionGUI: ilDclDetailedViewGUI ilObjDataCollectionGUI: ilDclTableListGUI, ilObjFileGUI ilObjDataCollectionGUI: ilObjUserGUI ilObjDataCollectionGUI: ilRatingGUI ilObjDataCollectionGUI: ilPropertyFormGUI ilObjDataCollectionGUI: ilDclPropertyFormGUI

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

Member Function Documentation

_goto()

static ilObjDataCollectionGUI::_goto (   $a_target )

static

Parameters

$a_target

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

References $_GET, $id, and exit.

    {
        $id = explode("_", $a_target);

        $_GET["baseClass"] = "ilRepositoryGUI";
        $_GET[self::GET_REF_ID] = $id[0];  // ref_id
        $_GET[self::GET_VIEW_ID] = $id[1]; // view_id
        $_GET[self::GET_DCL_GTR] = $id[2]; // record_id
        $_GET["cmd"] = "listRecords";
        require_once('./ilias.php');
        exit;
    }

addHeaderAction()

ilObjDataCollectionGUI::addHeaderAction

(

$a_redraw = false

)

Parameters

bool

$a_redraw

Returns

string|void

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

References $DIC, $ilCtrl, $ilUser, $lg, ilObjectGUI\$lng, ilObjectGUI\$obj_id, ilObjectGUI\$tpl, ilUtil\getImagePath(), ilNotification\hasNotification(), ilNotification\TYPE_DATA_COLLECTION, and ilCommonActionDispatcherGUI\TYPE_REPOSITORY.

    {
        global $DIC;
        $ilUser = $DIC['ilUser'];
        $ilAccess = $DIC['ilAccess'];
        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];

        $dispatcher = new ilCommonActionDispatcherGUI(ilCommonActionDispatcherGUI::TYPE_REPOSITORY, $ilAccess, "dcl", $this->ref_id, $this->obj_id);

        ilObjectListGUI::prepareJSLinks(
            $this->ctrl->getLinkTarget($this, "redrawHeaderAction", "", true),
            $ilCtrl->getLinkTargetByClass(
                array(
                "ilcommonactiondispatchergui",
                "ilnotegui",
            ),
                "",
                "",
                true,
                false
            ),
            $ilCtrl->getLinkTargetByClass(array("ilcommonactiondispatchergui", "iltagginggui"), "", "", true, false)
        );

        $lg = $dispatcher->initHeaderAction();
        //$lg->enableNotes(true);
        //$lg->enableComments(ilObjWiki::_lookupPublicNotes($this->getPageObject()->getParentId()), false);

        // notification
        if ($ilUser->getId() != ANONYMOUS_USER_ID and $this->object->getNotification() == 1) {
            if (ilNotification::hasNotification(ilNotification::TYPE_DATA_COLLECTION, $ilUser->getId(), $this->obj_id)) {
                //Command Activate Notification
                $ilCtrl->setParameter($this, "ntf", 1);
                $lg->addCustomCommand($ilCtrl->getLinkTarget($this, "toggleNotification"), "dcl_notification_deactivate_dcl");

                $lg->addHeaderIcon("not_icon", ilUtil::getImagePath("notification_on.svg"), $lng->txt("dcl_notification_activated"));
            } else {
                //Command Deactivate Notification
                $ilCtrl->setParameter($this, "ntf", 2);
                $lg->addCustomCommand($ilCtrl->getLinkTarget($this, "toggleNotification"), "dcl_notification_activate_dcl");

                $lg->addHeaderIcon("not_icon", ilUtil::getImagePath("notification_off.svg"), $lng->txt("dcl_notification_deactivated"));
            }
            $ilCtrl->setParameter($this, "ntf", "");
        }

        if (!$a_redraw) {
            $tpl->setHeaderActionMenu($lg->getHeaderAction());
        } else {
            return $lg->getHeaderAction();
        }

        $tpl->setHeaderActionMenu($lg->getHeaderAction());
    }

Here is the call graph for this function:

addLocatorItems()

ilObjDataCollectionGUI::addLocatorItems

(

)

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

References $DIC, and ilObject2GUI\$node_id.

    {
        global $DIC;
        $ilLocator = $DIC['ilLocator'];

        if (is_object($this->object)) {
            $ilLocator->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, ""), "", $this->node_id);
        }
    }

afterSave()

ilObjDataCollectionGUI::afterSave ( ilObject  $a_new_object )

protected

Parameters

ilObject

$a_new_object

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

    {
        ilUtil::sendSuccess($this->lng->txt("object_added"), true);
        $this->ctrl->redirectByClass("ilDclTableListGUI", "listTables");
    }

emptyInfo()

ilObjDataCollectionGUI::emptyInfo ( )

private

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

References $DIC, ilObjectGUI\$lng, ilDclCache\getTableCache(), and ilUtil\sendInfo().

Referenced by updateCustom().

    {
        global $DIC;
        $lng = $DIC['lng'];
        $this->table = ilDclCache::getTableCache($this->object->getFirstVisibleTableId());
        $tables = $this->object->getTables();
        if (count($tables) == 1 and count($this->table->getRecordFields()) == 0 and count($this->table->getRecords()) == 0
            and $this->object->getOnline()
        ) {
            ilUtil::sendInfo($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

(

)

Returns

bool

Exceptions

ilCtrlException

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

References $_GET, $DIC, $form, ilObjectGUI\addHeaderAction(), ilObject2GUI\checkPermissionBool(), ilDclRecordListGUI\CMD_LIST_RECORDS, ilObject2GUI\getCreationMode(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), infoScreenForward(), and ilObject2GUI\prepareOutput().

    {
        global $DIC;

        $ilNavigationHistory = $DIC['ilNavigationHistory'];
        $ilHelp = $DIC['ilHelp'];
        $ilHelp->setScreenIdComponent('bibl');

        // Navigation History
        $link = $DIC->ctrl()->getLinkTarget($this, "render");

        if ($this->object != null) {
            $ilNavigationHistory->addItem($this->object->getRefId(), $link, "dcl");
        }

        // Direct-Link Resource, redirect to viewgui
        if ($_GET[self::GET_DCL_GTR]) {
            $DIC->ctrl()->setParameterByClass(ilDclDetailedViewGUI::class, 'tableview_id', $_GET[self::GET_VIEW_ID]);
            $DIC->ctrl()->setParameterByClass(ilDclDetailedViewGUI::class, 'record_id', $_GET[self::GET_DCL_GTR]);
            $DIC->ctrl()->redirectByClass(ilDclDetailedViewGUI::class, 'renderRecord');
        }

        $next_class = $DIC->ctrl()->getNextClass($this);
        $cmd = $DIC->ctrl()->getCmd();

        if (!$this->getCreationMode() and $next_class != "ilinfoscreengui" and $cmd != 'infoScreen' and !$this->checkPermissionBool("read")) {
            $DIC->ui()->mainTemplate()->getStandardTemplate();
            $DIC->ui()->mainTemplate()->setContent("Permission Denied.");

            return;
        }

        switch ($next_class) {
            case "ilinfoscreengui":
                $this->prepareOutput();
                $DIC->tabs()->activateTab("id_info");
                $this->infoScreenForward();
                break;

            case "ilcommonactiondispatchergui":
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $gui->enableCommentsSettings(false);
                $this->ctrl->forwardCommand($gui);
                break;

            case "ilpermissiongui":
                $this->prepareOutput();
                $DIC->tabs()->activateTab("id_permissions");
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;

            case "ilobjectcopygui":
                $cp = new ilObjectCopyGUI($this);
                $cp->setType("dcl");
                $DIC->ui()->mainTemplate()->getStandardTemplate();
                $this->ctrl->forwardCommand($cp);
                break;

            case "ildcltablelistgui":
                $this->prepareOutput();
                $DIC->tabs()->setTabActive("id_tables");
                $tablelist_gui = new ilDclTableListGUI($this);
                $this->ctrl->forwardCommand($tablelist_gui);
                break;

            case "ildclrecordlistgui":
                $this->addHeaderAction(false);
                $this->prepareOutput();
                $DIC->tabs()->activateTab("id_records");
                $this->ctrl->setParameterByClass(ilDclRecordListGUI::class, 'tableview_id', $_REQUEST['tableview_id']);
                                $recordlist_gui = new ilDclRecordListGUI($this, $this->table_id);
                $this->ctrl->forwardCommand($recordlist_gui);
                break;

            case "ildclrecordeditgui":
                $this->prepareOutput();
                $DIC->tabs()->activateTab("id_records");
                $recordedit_gui = new ilDclRecordEditGUI($this);
                $this->ctrl->forwardCommand($recordedit_gui);
                break;

            case "ilobjfilegui":
                $this->prepareOutput();
                $DIC->tabs()->setTabActive("id_records");
                $file_gui = new ilObjFile($this);
                $this->ctrl->forwardCommand($file_gui);
                break;

            case "ilratinggui":
                $rgui = new ilRatingGUI();
                $rgui->setObject($_GET['record_id'], "dcl_record", $_GET["field_id"], "dcl_field");
                $rgui->executeCommand();
                $DIC->ctrl()->redirectByClass("ilDclRecordListGUI", "listRecords");
                break;

            case "ildcldetailedviewgui":
                $this->prepareOutput();
                $recordview_gui = new ilDclDetailedViewGUI($this);
                $this->ctrl->forwardCommand($recordview_gui);
                $DIC->tabs()->clearTargets();
                $DIC->tabs()->setBackTarget($this->lng->txt("back"), $DIC->ctrl()->getLinkTargetByClass(ilDclRecordListGUI::class, ilDclRecordListGUI::CMD_LIST_RECORDS));
                break;

            case 'ilnotegui':
                $this->prepareOutput();
                $recordviewGui = new ilDclDetailedViewGUI($this);
                $this->ctrl->forwardCommand($recordviewGui);
                $DIC->tabs()->clearTargets();
                $DIC->tabs()->setBackTarget($this->lng->txt("back"), $DIC->ctrl()->getLinkTarget($this, ""));
                break;
            case "ildclexportgui":
                $this->prepareOutput();
                $DIC->tabs()->setTabActive("export");
                $exp_gui = new ilDclExportGUI($this);
                $exporter = new ilDclContentExporter($this->object->getRefId());
                $exp_gui->addFormat("xlsx", $this->lng->txt('dlc_xls_async_export'), $exporter, 'exportAsync');
                $exp_gui->addFormat("xml");

                $this->ctrl->forwardCommand($exp_gui);
                break;

            case strtolower(ilDclPropertyFormGUI::class):
                $recordedit_gui = new ilDclRecordEditGUI($this);
                $recordedit_gui->getRecord();
                $recordedit_gui->initForm();
                $form = $recordedit_gui->getForm();
                $this->ctrl->forwardCommand($form);
                break;

            default:
                return parent::executeCommand();
        }

        return true;
    }

Here is the call graph for this function:

getDataCollectionObject()

ilObjDataCollectionGUI::getDataCollectionObject

(

)

Returns

ilObjDataCollection

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

Referenced by initEditCustomForm().

    {
        $obj = new ilObjDataCollection($this->ref_id, true);

        return $obj;
    }

Here is the caller graph for this function:

getEditFormCustomValues()

ilObjDataCollectionGUI::getEditFormCustomValues

(

array &

$a_values

)

Parameters

array

$a_values

Returns

array|void

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

    {
        $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();

        return $a_values;
    }

getStandardCmd()

ilObjDataCollectionGUI::getStandardCmd

(

)

Returns

string

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

    {
        return "render";
    }

getType()

ilObjDataCollectionGUI::getType

(

)

Returns

string

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

    {
        return "dcl";
    }

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

References infoScreenForward().

    {
        $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 306 of file class.ilObjDataCollectionGUI.php.

References $DIC, ilObjectGUI\$ilErr, $info, and ilObject2GUI\checkPermissionBool().

Referenced by executeCommand(), and infoScreen().

    {
        global $DIC;
        $ilTabs = $DIC['ilTabs'];
        $ilErr = $DIC['ilErr'];

        $ilTabs->activateTab("id_info");

        if (!$this->checkPermissionBool("visible") && !$this->checkPermissionBool("read")) {
            $ilErr->raiseError($this->lng->txt("msg_no_perm_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:

initCreationForms()

ilObjDataCollectionGUI::initCreationForms (   $a_new_type )

protected

Parameters

string

$a_new_type

Returns

array

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

    {
        $forms = parent::initCreationForms($a_new_type);

        return $forms;
    }

initEditCustomForm()

ilObjDataCollectionGUI::initEditCustomForm ( ilPropertyFormGUI  $a_form )

protected

Parameters

ilPropertyFormGUI

$a_form

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

References $DIC, $table, ilPropertyFormGUI\addItem(), getDataCollectionObject(), and ilFormPropertyGUI\setInfo().

    {
        global $DIC;
        $ilTabs = $DIC['ilTabs'];

        $ilTabs->activateTab("id_settings");

        // is_online
        $cb = new ilCheckboxInputGUI($this->lng->txt("online"), "is_online");
        $cb->setInfo($this->lng->txt("dcl_online_info"));
        $a_form->addItem($cb);

        // Notification
        $cb = new ilCheckboxInputGUI($this->lng->txt("dcl_activate_notification"), "notification");
        $cb->setInfo($this->lng->txt("dcl_notification_info"));
        $a_form->addItem($cb);

        //table order
        $order_options = array();
        foreach ($this->getDataCollectionObject()->getTables() as $table) {
            $order_options[$table->getId()] = $table->getTitle();
        }
    }

Here is the call graph for this function:

listRecords()

ilObjDataCollectionGUI::listRecords

(

)

called by goto

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

References $_GET, $DIC, and $ilCtrl.

    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $ilCtrl->setParameterByClass("ildclrecordlistgui", "tableview_id", $_GET["tableview_id"]);
        $ilCtrl->redirectByClass("ildclrecordlistgui", "show");
    }

render()

ilObjDataCollectionGUI::render

(

)

show Content; redirect to ilDclRecordListGUI::listRecords

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

References $_GET, $DIC, and $ilCtrl.

    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $this->ctrl->setParameterByClass('ilDclRecordListGUI', 'tableview_id', $_GET['tableview_id']);
        $ilCtrl->redirectByClass("ildclrecordlistgui", "show");
    }

setTabs()

ilObjDataCollectionGUI::setTabs

(

)

setTabs create tabs (repository/workspace switch)

this had to be moved here because of the context-specific permission tab

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

References $DIC, and ilObjectGUI\$lng.

    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];
        $ilTabs = $DIC['ilTabs'];
        $lng = $DIC['lng'];
        $ilHelp = $DIC['ilHelp'];

        $ilHelp->setScreenIdComponent("dcl");

        // list records
        if ($ilAccess->checkAccess('read', "", $this->object->getRefId())) {
            $ilTabs->addTab("id_records", $lng->txt("content"), $this->ctrl->getLinkTargetByClass("ildclrecordlistgui", "show"));
        }

        // info screen
        if ($ilAccess->checkAccess('visible', "", $this->object->getRefId()) || $ilAccess->checkAccess('read', "", $this->object->getRefId())) {
            $ilTabs->addTab("id_info", $lng->txt("info_short"), $this->ctrl->getLinkTargetByClass("ilinfoscreengui", "showSummary"));
        }

        // settings
        if ($ilAccess->checkAccess('write', "", $this->object->getRefId())) {
            $ilTabs->addTab("id_settings", $lng->txt("settings"), $this->ctrl->getLinkTarget($this, "editObject"));
        }

        // list tables
        if ($ilAccess->checkAccess('write', "", $this->object->getRefId())) {
            $ilTabs->addTab("id_tables", $lng->txt("dcl_tables"), $this->ctrl->getLinkTargetByClass("ildcltablelistgui", "listTables"));
        }

        // export
        if ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
            $ilTabs->addTab("export", $lng->txt("export"), $this->ctrl->getLinkTargetByClass("ildclexportgui", ""));
        }

        // edit permissions
        if ($ilAccess->checkAccess('edit_permission', "", $this->object->getRefId())) {
            $ilTabs->addTab("id_permissions", $lng->txt("perm_settings"), $this->ctrl->getLinkTargetByClass("ilpermissiongui", "perm"));
        }
    }

toggleNotification()

ilObjDataCollectionGUI::toggleNotification

(

)

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

References $_GET, $DIC, $ilCtrl, $ilUser, ilObjectGUI\$obj_id, ilNotification\setNotification(), and ilNotification\TYPE_DATA_COLLECTION.

    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $ilUser = $DIC['ilUser'];

        switch ($_GET["ntf"]) {
            case 1:
                ilNotification::setNotification(ilNotification::TYPE_DATA_COLLECTION, $ilUser->getId(), $this->obj_id, false);
                break;
            case 2:
                ilNotification::setNotification(ilNotification::TYPE_DATA_COLLECTION, $ilUser->getId(), $this->obj_id, true);
                break;
        }
        $ilCtrl->redirectByClass("ildclrecordlistgui", "show");
    }

Here is the call graph for this function:

updateCustom()

ilObjDataCollectionGUI::updateCustom

(

ilPropertyFormGUI

$a_form

)

Parameters

ilPropertyFormGUI

$a_form

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

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

    {
        $this->object->setOnline($a_form->getInput("is_online"));
        $this->object->setRating($a_form->getInput("rating"));
        $this->object->setPublicNotes($a_form->getInput("public_notes"));
        $this->object->setApproval($a_form->getInput("approval"));
        $this->object->setNotification($a_form->getInput("notification"));

        $this->emptyInfo();
    }

Here is the call graph for this function:

Field Documentation

GET_DCL_GTR

const ilObjDataCollectionGUI::GET_DCL_GTR = "dcl_gtr"

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

GET_REF_ID

const ilObjDataCollectionGUI::GET_REF_ID = "ref_id"

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

GET_VIEW_ID

const ilObjDataCollectionGUI::GET_VIEW_ID = "tableview_id"

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

---

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

• Modules/DataCollection/classes/class.ilObjDataCollectionGUI.php