ilDclTableEditGUI Class Reference

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

Collaboration diagram for ilDclTableEditGUI:

Public Member Functions
	__construct (ilDclTableListGUI $a_parent_obj)
	Constructor. More...
	executeCommand ()
	create ()
	edit ()
	getValues ()
	getStandardValues ()
	cancel ()
	initForm (string $a_mode="create")
	initEditCustomForm More...
	doTableSwitch ()
	save (string $a_mode="create")
	accessDenied ()
	confirmDelete ()
	cancelDelete ()
	delete ()

Protected Member Functions
	checkInput (string $a_mode)
	Custom checks for the form input. More...
	checkAccess ()
	createTableSwitcher ()

Protected Attributes
ilLanguage	$lng
ilCtrl	$ctrl
ilGlobalTemplateInterface	$tpl
ilToolbarGUI	$toolbar
ilPropertyFormGUI	$form
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery
ilDclTableListGUI	$parent_object
int	$obj_id

Private Attributes
int	$table_id
ilDclTable	$table

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

Constructor & Destructor Documentation

__construct()

ilDclTableEditGUI::__construct

(

ilDclTableListGUI

$a_parent_obj

)

Constructor.

Definition at line 36 of file class.ilDclTableEditGUI.php.

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

    {
        global $DIC;

        $locator = $DIC['ilLocator'];

        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->toolbar = $DIC->toolbar();
        $this->parent_object = $a_parent_obj;
        $this->obj_id = $a_parent_obj->getObjId();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();

        $table_id = null;
        if ($this->http->wrapper()->query()->has("table_id")) {
            $table_id = $this->http->wrapper()->query()->retrieve('table_id', $this->refinery->kindlyTo()->int());
        }

        $this->table_id = $table_id;
        $this->table = ilDclCache::getTableCache($this->table_id);

        $this->ctrl->saveParameter($this, 'table_id');
        if ($this->table->getTitle()) {
            $locator->addItem($this->table->getTitle(), $this->ctrl->getLinkTarget($this, 'edit'));
        }
        $this->tpl->setLocator();

        if (!$this->checkAccess()) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->ctrl->redirectByClass('ildclrecordlistgui', 'listRecords');
        }
    }

Here is the call graph for this function:

Member Function Documentation

accessDenied()

ilDclTableEditGUI::accessDenied

(

)

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

Referenced by save().

                                  : void
    {
        $this->tpl->setContent("Access denied.");
    }

Here is the caller graph for this function:

cancel()

ilDclTableEditGUI::cancel

(

)

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

References ILIAS\Repository\ctrl().

                            : void
    {
        $this->ctrl->redirectByClass("ilDclTableListGUI", "listTables");
    }

Here is the call graph for this function:

cancelDelete()

ilDclTableEditGUI::cancelDelete

(

)

Definition at line 389 of file class.ilDclTableEditGUI.php.

References ILIAS\Repository\ctrl().

                                  : void
    {
        $this->ctrl->redirectByClass("ilDclTableListGUI", "listTables");
    }

Here is the call graph for this function:

checkAccess()

ilDclTableEditGUI::checkAccess ( )

protected

Definition at line 410 of file class.ilDclTableEditGUI.php.

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

Referenced by __construct().

                                    : bool
    {
        $ref_id = $this->parent_object->getDataCollectionObject()->getRefId();

        return $this->table_id ? ilObjDataCollectionAccess::hasAccessToEditTable(
            $ref_id,
            $this->table_id
        ) : ilObjDataCollectionAccess::hasWriteAccess($ref_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkInput()

ilDclTableEditGUI::checkInput ( string  $a_mode )

protected

Custom checks for the form input.

Parameters

$a_mode

'create' | 'update'

Definition at line 348 of file class.ilDclTableEditGUI.php.

References ilObjDataCollection\_hasTableByTitle(), ILIAS\Repository\form(), and ILIAS\Repository\lng().

Referenced by save().

                                                 : bool
    {
        $return = $this->form->checkInput();

        // Title of table must be unique in one DC
        if ($a_mode == 'create') {
            if ($title = $this->form->getInput('title')) {
                if (ilObjDataCollection::_hasTableByTitle($title, $this->obj_id)) {
                    $inputObj = $this->form->getItemByPostVar('title');
                    $inputObj->setAlert($this->lng->txt("dcl_table_title_unique"));
                    $return = false;
                }
            }
        }

        if (!$return) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("form_input_not_valid"));
        }

        return $return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmDelete()

ilDclTableEditGUI::confirmDelete

(

)

Definition at line 375 of file class.ilDclTableEditGUI.php.

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

                                   : void
    {
        $conf = new ilConfirmationGUI();
        $conf->setFormAction($this->ctrl->getFormAction($this));
        $conf->setHeaderText($this->lng->txt('dcl_confirm_delete_table'));

        $conf->addItem('table', $this->table->getId(), $this->table->getTitle());

        $conf->setConfirm($this->lng->txt('delete'), 'delete');
        $conf->setCancel($this->lng->txt('cancel'), 'cancelDelete');

        $this->tpl->setContent($conf->getHTML());
    }

Here is the call graph for this function:

create()

ilDclTableEditGUI::create

(

)

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

References ILIAS\Repository\form(), getStandardValues(), and initForm().

                            : void
    {
        $this->initForm();
        $this->getStandardValues();
        $this->tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

createTableSwitcher()

ilDclTableEditGUI::createTableSwitcher ( )

protected

Returns

string[]

Definition at line 423 of file class.ilDclTableEditGUI.php.

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

Referenced by initForm().

                                            : array
    {
        // Show tables
        $tables = $this->parent_object->getDataCollectionObject()->getTables();

        foreach ($tables as $table) {
            $options[$table->getId()] = $table->getTitle();
        }
        $table_selection = new ilSelectInputGUI($this->lng->txt("dcl_select"), 'table_id');
        $table_selection->setOptions($options);
        $table_selection->setValue($this->table->getId());

        $this->toolbar->setFormAction($this->ctrl->getFormActionByClass("ilDclTableEditGUI", "doTableSwitch"));
        $this->toolbar->addText($this->lng->txt("dcl_select"));
        $this->toolbar->addInputItem($table_selection);
        $button = ilSubmitButton::getInstance();
        $button->setCommand("doTableSwitch");
        $button->setCaption('change');
        $this->toolbar->addButtonInstance($button);

        return $options;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilDclTableEditGUI::delete

(

)

Definition at line 394 of file class.ilDclTableEditGUI.php.

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

                            : void
    {
        if (count($this->table->getCollectionObject()->getTables()) < 2) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt("dcl_cant_delete_last_table"),
                true
            ); //TODO change lng var
            $this->table->doDelete(true);
        } else {
            $this->table->doDelete(false);
        }
        $this->ctrl->clearParameterByClass("ilobjdatacollectiongui", "table_id");
        $this->ctrl->redirectByClass("ildcltablelistgui", "listtables");
    }

Here is the call graph for this function:

doTableSwitch()

ilDclTableEditGUI::doTableSwitch

(

)

Definition at line 273 of file class.ilDclTableEditGUI.php.

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

                                   : void
    {
        $table_id = $this->http->wrapper()->post()->retrieve('table_id', $this->refinery->kindlyTo()->int());
        $this->ctrl->setParameter($this, "table_id", $table_id);
        $this->ctrl->redirect($this, "edit");
    }

Here is the call graph for this function:

edit()

ilDclTableEditGUI::edit

(

)

Definition at line 92 of file class.ilDclTableEditGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilDclCache\getTableCache(), getValues(), and initForm().

                          : void
    {
        if (!$this->table_id) {
            $this->ctrl->redirectByClass("ildclfieldeditgui", "listFields");

            return;
        } else {
            $this->table = ilDclCache::getTableCache($this->table_id);
        }
        $this->initForm("edit");
        $this->getValues();
        $this->tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

executeCommand()

ilDclTableEditGUI::executeCommand

(

)

Definition at line 71 of file class.ilDclTableEditGUI.php.

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

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

        switch ($cmd) {
            case 'update':
                $this->save("update");
                break;
            default:
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

getStandardValues()

ilDclTableEditGUI::getStandardValues

(

)

Definition at line 138 of file class.ilDclTableEditGUI.php.

References ILIAS\Repository\form().

Referenced by create().

                                       : void
    {
        $values = array(
            'title' => "",
            'add_perm' => 1,
            'edit_perm' => 1,
            'edit_perm_mode' => 'own',
            'delete_perm_mode' => 'own',
            'delete_perm' => 1,
            'edit_by_owner' => 1,
            'export_enabled' => 0,
            'import_enabled' => 0,
            'limited' => 0,
            'limit_start' => null,
            'limit_end' => null,
        );
        $this->form->setValuesByArray($values);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getValues()

ilDclTableEditGUI::getValues

(

)

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

References ILIAS\Repository\form(), and ILIAS\Repository\int().

Referenced by edit().

                               : void
    {
        $values = array(
            'title' => $this->table->getTitle(),
            'add_perm' => (int) $this->table->getAddPerm(),
            'edit_perm' => (int) $this->table->getEditPerm(),
            'edit_perm_mode' => $this->table->getEditByOwner() ? 'own' : 'all',
            'delete_perm' => (int) $this->table->getDeletePerm(),
            'delete_perm_mode' => $this->table->getDeleteByOwner() ? 'own' : 'all',
            'export_enabled' => $this->table->getExportEnabled(),
            'import_enabled' => $this->table->getImportEnabled(),
            'limited' => $this->table->getLimited(),
            'limit_start' => substr($this->table->getLimitStart(), 0, 10) . " " . substr(
                $this->table->getLimitStart(),
                -8
            ),
            'limit_end' => substr($this->table->getLimitEnd(), 0, 10) . " " . substr($this->table->getLimitEnd(), -8),
            'default_sort_field' => $this->table->getDefaultSortField(),
            'default_sort_field_order' => $this->table->getDefaultSortFieldOrder(),
            'description' => $this->table->getDescription(),
            'view_own_records_perm' => $this->table->getViewOwnRecordsPerm(),
            'save_confirmation' => $this->table->getSaveConfirmation(),
        );
        if (!$this->table->getLimitStart()) {
            $values['limit_start'] = null;
        }
        if (!$this->table->getLimitEnd()) {
            $values['limit_end'] = null;
        }
        $this->form->setValuesByArray($values);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilDclTableEditGUI::initForm

(

string

$a_mode = "create"

)

initEditCustomForm

Definition at line 165 of file class.ilDclTableEditGUI.php.

References createTableSwitcher(), ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ILIAS\Repository\lng(), ilFormPropertyGUI\setInfo(), ilDateTimeInputGUI\setShowTime(), and ilTextAreaInputGUI\setUseRte().

Referenced by create(), edit(), and save().

                                                       : void
    {
        $this->form = new ilPropertyFormGUI();

        $item = new ilTextInputGUI($this->lng->txt('title'), 'title');
        $item->setRequired(true);
        $this->form->addItem($item);

        // Show default order field, direction and tableswitcher only in edit mode, because table id is not yet given and there are no fields to select
        if ($a_mode != 'create') {
            $this->createTableSwitcher();

            $item = new ilSelectInputGUI($this->lng->txt('dcl_default_sort_field'), 'default_sort_field');
            $item->setInfo($this->lng->txt('dcl_default_sort_field_desc'));
            $fields = array_filter($this->table->getFields(), function (ilDclBaseFieldModel $field) {
                return !is_null($field->getRecordQuerySortObject());
            });
            $options = array(0 => $this->lng->txt('dcl_please_select'));
            foreach ($fields as $field) {
                if ($field->getId() == 'comments') {
                    continue;
                }
                $options[$field->getId()] = $field->getTitle();
            }
            $item->setOptions($options);
            $this->form->addItem($item);

            $item = new ilSelectInputGUI($this->lng->txt('dcl_default_sort_field_order'), 'default_sort_field_order');
            $options = array('asc' => $this->lng->txt('dcl_asc'), 'desc' => $this->lng->txt('dcl_desc'));
            $item->setOptions($options);
            $this->form->addItem($item);
        }

        $item = new ilTextAreaInputGUI($this->lng->txt('additional_info'), 'description');
        $item->setUseRte(true);
        $item->setInfo($this->lng->txt('dcl_additional_info_desc'));
        $item->setRteTagSet('mini');
        $this->form->addItem($item);

        $section = new ilFormSectionHeaderGUI();
        $section->setTitle($this->lng->txt('dcl_permissions_form'));
        $this->form->addItem($section);

        $item = new ilCustomInputGUI();
        $item->setHtml($this->lng->txt('dcl_table_info'));
        $item->setTitle($this->lng->txt('dcl_table_info_title'));
        $this->form->addItem($item);

        $item = new ilCheckboxInputGUI($this->lng->txt('dcl_add_perm'), 'add_perm');
        $item->setInfo($this->lng->txt("dcl_add_perm_desc"));
        $this->form->addItem($item);

        $item = new ilCheckboxInputGUI($this->lng->txt('dcl_save_confirmation'), 'save_confirmation');
        $item->setInfo($this->lng->txt('dcl_save_confirmation_desc'));
        $this->form->addItem($item);

        $item = new ilCheckboxInputGUI($this->lng->txt('dcl_edit_perm'), 'edit_perm');
        $this->form->addItem($item);

        $radios = new ilRadioGroupInputGUI('', 'edit_perm_mode');
        $radios->addOption(new ilRadioOption($this->lng->txt('dcl_all_entries'), 'all'));
        $radios->addOption(new ilRadioOption($this->lng->txt('dcl_own_entries'), 'own'));
        $item->addSubItem($radios);

        $item = new ilCheckboxInputGUI($this->lng->txt('dcl_delete_perm'), 'delete_perm');
        $this->form->addItem($item);

        $radios = new ilRadioGroupInputGUI('', 'delete_perm_mode');
        $radios->addOption(new ilRadioOption($this->lng->txt('dcl_all_entries'), 'all'));
        $radios->addOption(new ilRadioOption($this->lng->txt('dcl_own_entries'), 'own'));
        $item->addSubItem($radios);

        $item = new ilCheckboxInputGUI($this->lng->txt('dcl_view_own_records_perm'), 'view_own_records_perm');
        $this->form->addItem($item);

        $item = new ilCheckboxInputGUI($this->lng->txt('dcl_export_enabled'), 'export_enabled');
        $item->setInfo($this->lng->txt('dcl_export_enabled_desc'));
        $this->form->addItem($item);

        $item = new ilCheckboxInputGUI($this->lng->txt('dcl_import_enabled'), 'import_enabled');
        $item->setInfo($this->lng->txt('dcl_import_enabled_desc'));
        $this->form->addItem($item);

        $item = new ilCheckboxInputGUI($this->lng->txt('dcl_limited'), 'limited');
        $sitem1 = new ilDateTimeInputGUI($this->lng->txt('dcl_limit_start'), 'limit_start');
        $sitem1->setShowTime(true);
        $sitem2 = new ilDateTimeInputGUI($this->lng->txt('dcl_limit_end'), 'limit_end');
        $sitem2->setShowTime(true);
        $item->setInfo($this->lng->txt("dcl_limited_desc"));
        $item->addSubItem($sitem1);
        $item->addSubItem($sitem2);
        $this->form->addItem($item);

        if ($a_mode == "edit") {
            $this->form->addCommandButton('update', $this->lng->txt('dcl_table_' . $a_mode));
        } else {
            $this->form->addCommandButton('save', $this->lng->txt('dcl_table_' . $a_mode));
        }

        $this->form->addCommandButton('cancel', $this->lng->txt('cancel'));
        $this->form->setFormAction($this->ctrl->getFormAction($this, $a_mode));
        if ($a_mode == "edit") {
            $this->form->setTitle($this->lng->txt('dcl_edit_table'));
        } else {
            $this->form->setTitle($this->lng->txt('dcl_new_table'));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilDclTableEditGUI::save

(

string

$a_mode = "create"

)

Definition at line 280 of file class.ilDclTableEditGUI.php.

References $DIC, accessDenied(), ilObjDataCollectionAccess\checkActionForObjId(), checkInput(), ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilDclCache\getTableCache(), initForm(), and ILIAS\Repository\lng().

Referenced by executeCommand().

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

        if (!ilObjDataCollectionAccess::checkActionForObjId('write', $this->obj_id)) {
            $this->accessDenied();

            return;
        }

        $ilTabs->activateTab("id_fields");
        $this->initForm($a_mode);

        if ($this->checkInput($a_mode)) {
            if ($a_mode != "update") {
                $this->table = ilDclCache::getTableCache();
            } elseif ($this->table_id) {
                $this->table = ilDclCache::getTableCache($this->table_id);
            } else {
                $this->ctrl->redirectByClass("ildclfieldeditgui", "listFields");
            }

            $this->table->setTitle($this->form->getInput("title"));
            $this->table->setObjId($this->obj_id);
            $this->table->setSaveConfirmation((bool) $this->form->getInput('save_confirmation'));
            $this->table->setAddPerm((bool) $this->form->getInput("add_perm"));
            $this->table->setEditPerm((bool) $this->form->getInput("edit_perm"));
            if ($this->table->getEditPerm()) {
                $edit_by_owner = ($this->form->getInput('edit_perm_mode') == 'own');
                $this->table->setEditByOwner($edit_by_owner);
            }
            $this->table->setDeletePerm((bool) $this->form->getInput("delete_perm"));
            if ($this->table->getDeletePerm()) {
                $delete_by_owner = ($this->form->getInput('delete_perm_mode') == 'own');
                $this->table->setDeleteByOwner($delete_by_owner);
            }
            $this->table->setViewOwnRecordsPerm($this->form->getInput('view_own_records_perm'));
            $this->table->setExportEnabled($this->form->getInput("export_enabled"));
            $this->table->setImportEnabled($this->form->getInput("import_enabled"));
            $this->table->setDefaultSortField($this->form->getInput("default_sort_field"));
            $this->table->setDefaultSortFieldOrder($this->form->getInput("default_sort_field_order"));
            $this->table->setLimited($this->form->getInput("limited"));
            $this->table->setDescription($this->form->getInput('description'));
            $limit_start = $this->form->getInput("limit_start");
            $limit_end = $this->form->getInput("limit_end");
            $this->table->setLimitStart($limit_start);
            $this->table->setLimitEnd($limit_end);
            if ($a_mode == "update") {
                $this->table->doUpdate();
                $this->tpl->setOnScreenMessage('success', $this->lng->txt("dcl_msg_table_edited"), true);
                $this->ctrl->redirectByClass("ildcltableeditgui", "edit");
            } else {
                $this->table->doCreate();
                $this->tpl->setOnScreenMessage('success', $this->lng->txt("dcl_msg_table_created"), true);
                $this->ctrl->setParameterByClass("ildclfieldlistgui", "table_id", $this->table->getId());
                $this->ctrl->redirectByClass("ildclfieldlistgui", "listFields");
            }
        } else {
            $this->form->setValuesByPost();
            $this->tpl->setContent($this->form->getHTML());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilCtrl ilDclTableEditGUI::$ctrl

protected

Definition at line 24 of file class.ilDclTableEditGUI.php.

$form

ilPropertyFormGUI ilDclTableEditGUI::$form

protected

Definition at line 27 of file class.ilDclTableEditGUI.php.

$http

ILIAS HTTP Services ilDclTableEditGUI::$http

protected

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

$lng

ilLanguage ilDclTableEditGUI::$lng

protected

Definition at line 23 of file class.ilDclTableEditGUI.php.

$obj_id

int ilDclTableEditGUI::$obj_id

protected

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

$parent_object

ilDclTableListGUI ilDclTableEditGUI::$parent_object

protected

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

$refinery

ILIAS Refinery Factory ilDclTableEditGUI::$refinery

protected

Definition at line 29 of file class.ilDclTableEditGUI.php.

$table

ilDclTable ilDclTableEditGUI::$table

private

Definition at line 22 of file class.ilDclTableEditGUI.php.

$table_id

int ilDclTableEditGUI::$table_id

private

Definition at line 21 of file class.ilDclTableEditGUI.php.

Referenced by __construct().

$toolbar

ilToolbarGUI ilDclTableEditGUI::$toolbar

protected

Definition at line 26 of file class.ilDclTableEditGUI.php.

$tpl

ilGlobalTemplateInterface ilDclTableEditGUI::$tpl

protected

Definition at line 25 of file class.ilDclTableEditGUI.php.

---

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

• Modules/DataCollection/classes/Table/class.ilDclTableEditGUI.php