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

Collaboration diagram for ilDclFieldListGUI:

Public Member Functions
	__construct (ilDclTableListGUI $a_parent_obj)
	Constructor. More...

	getTableId ()

	executeCommand ()
	execute command More...

	deleteFields ()
	Delete multiple fields. More...

	save ()

	listFields ()
	list fields More...

	doTableSwitch ()

	getDataCollectionObject ()

Protected Member Functions
	checkAccess ()

Protected Attributes
ilCtrl	$ctrl

ilLanguage	$lng

ilToolbarGUI	$toolbar

ilGlobalTemplateInterface	$tpl

ilTabsGUI	$tabs

ILIAS HTTP Services	$http

ILIAS Refinery Factory	$refinery

int	$table_id

ilDclTableListGUI	$parent_obj

int	$obj_id

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.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Definition at line 19 of file class.ilDclFieldListGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilDclFieldListGUI::__construct ( ilDclTableListGUI $a_parent_obj )

Constructor.

Definition at line 35 of file class.ilDclFieldListGUI.php.

    {
        global $DIC;
 
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->table_id = $this->http->wrapper()->query()->retrieve('table_id', $this->refinery->kindlyTo()->int());
        $locator = $DIC['ilLocator'];
        $this->parent_obj = $a_parent_obj;
        $this->obj_id = $a_parent_obj->getObjId();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->tabs = $DIC->tabs();
        $this->toolbar = $DIC->toolbar();
 
        $this->ctrl->saveParameterByClass('ilDclTableEditGUI', 'table_id');
        $locator->addItem(
            ilDclCache::getTableCache($this->table_id)->getTitle(),
            $this->ctrl->getLinkTargetByClass('ilDclTableEditGUI', 'edit')
        );
        $this->tpl->setLocator();
 
        if (!$this->checkAccess()) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->ctrl->redirectByClass('ildclrecordlistgui', 'listRecords');
        }
    }

References $DIC, checkAccess(), ILIAS\Repository\ctrl(), ilDclTableListGUI\getObjId(), ilDclCache\getTableCache(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Member Function Documentation

◆ checkAccess()

ilDclFieldListGUI::checkAccess ( )

protected

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

                                    : bool
    {
        $ref_id = $this->getDataCollectionObject()->getRefId();
 
        return ilObjDataCollectionAccess::hasAccessToEditTable($ref_id, $this->table_id);
    }

References $ref_id, getDataCollectionObject(), and ilObjDataCollectionAccess\hasAccessToEditTable().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteFields()

ilDclFieldListGUI::deleteFields ( )

Delete multiple fields.

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

                                  : void
    {
        if ($this->http->wrapper()->post()->has('dcl_field_ids')) {
            $field_ids = $this->http->wrapper()->post()->retrieve(
                'dcl_field_ids',
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
            );
            $table = ilDclCache::getTableCache($this->table_id);
            foreach ($field_ids as $field_id) {
                $table->deleteField($field_id);
            }
        }
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('dcl_msg_fields_deleted'), true);
        $this->ctrl->redirect($this, 'listFields');
    }

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

Here is the call graph for this function:

◆ doTableSwitch()

ilDclFieldListGUI::doTableSwitch ( )

Definition at line 208 of file class.ilDclFieldListGUI.php.

                                   : void
    {
        $table_id = $this->http->wrapper()->post()->retrieve('table_id', $this->refinery->kindlyTo()->int());
        $this->ctrl->setParameterByClass("ilObjDataCollectionGUI", "table_id", $table_id);
        $this->ctrl->redirectByClass("ilDclFieldListGUI", "listFields");
    }

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

Here is the call graph for this function:

◆ executeCommand()

ilDclFieldListGUI::executeCommand ( )

execute command

Definition at line 72 of file class.ilDclFieldListGUI.php.

                                    : void
    {
        $cmd = $this->ctrl->getCmd('listFields');
        $this->$cmd();
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getDataCollectionObject()

ilDclFieldListGUI::getDataCollectionObject ( )

Definition at line 222 of file class.ilDclFieldListGUI.php.

                                             : ilObjDataCollection
    {
        return $this->parent_obj->getDataCollectionObject();
    }

Referenced by checkAccess().

Here is the caller graph for this function:

◆ getTableId()

ilDclFieldListGUI::getTableId ( )

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

                                : int
    {
        return $this->table_id;
    }

References $table_id.

◆ listFields()

ilDclFieldListGUI::listFields ( )

list fields

Definition at line 174 of file class.ilDclFieldListGUI.php.

                                : void
    {
        //add button
        $add_new = ilLinkButton::getInstance();
        $add_new->setPrimary(true);
        $add_new->setCaption("dcl_add_new_field");
        $add_new->setUrl($this->ctrl->getLinkTargetByClass('ildclfieldeditgui', 'create'));
        $this->toolbar->addStickyItem($add_new);
 
        $this->toolbar->addSeparator();
 
        // Show tableswitcher
        $tables = $this->parent_obj->getDataCollectionObject()->getTables();
 
        foreach ($tables as $table) {
            $options[$table->getId()] = $table->getTitle();
        }
        $table_selection = new ilSelectInputGUI('', 'table_id');
        $table_selection->setOptions($options);
        $table_selection->setValue($this->table_id);
 
        $this->toolbar->setFormAction($this->ctrl->getFormActionByClass("ilDclFieldListGUI", "doTableSwitch"));
        $this->toolbar->addText($this->lng->txt("dcl_select"));
        $this->toolbar->addInputItem($table_selection);
        $this->toolbar->addFormButton($this->lng->txt('change'), 'doTableSwitch');
 
        //table gui
        $list = new ilDclFieldListTableGUI($this, $this->ctrl->getCmd(), $this->table_id);
        $this->tpl->setContent($list->getHTML());
    }

References ILIAS\Repository\ctrl(), ilLinkButton\getInstance(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Referenced by save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilDclFieldListGUI::save ( )

Definition at line 132 of file class.ilDclFieldListGUI.php.

                          : void
    {
        $table_id = $this->http->wrapper()->query()->retrieve('table_id', $this->refinery->kindlyTo()->int());
 
        $table = ilDclCache::getTableCache($table_id);
        $fields = $table->getFields();
 
        $order = $this->http->wrapper()->post()->retrieve(
            'order',
            $this->refinery->kindlyTo()->dictOf($this->refinery->kindlyTo()->string())
        );
        asort($order);
        $val = 10;
        foreach (array_keys($order) as $field_id) {
            $order[$field_id] = $val;
            $val += 10;
        }
 
        $exportable = [];
        if ($this->http->wrapper()->post()->has("exportable")) {
            $exportable = $this->http->wrapper()->post()->retrieve(
                "exportable",
                $this->refinery->kindlyTo()->dictOf(
                    $this->refinery->kindlyTo()->string()
                )
            );
        }
 
        foreach ($fields as $field) {
            $field->setExportable(array_key_exists($field->getId(), $exportable) && $exportable[$field->getId()] === "on");
            $field->setOrder($order[$field->getId()]);
            $field->doUpdate();
        }
 
        $table->reloadFields();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("dcl_table_settings_saved"));
        $this->listFields();
    }