Collaboration diagram for ilDclTableEditGUI:

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

	executeCommand ()

	create ()

	edit ()

	getValues ()

	getStandardValues ()

	cancel ()

	initForm (bool $create=true)

	save (bool $create=true)

	accessDenied ()

	confirmDelete ()

	cancelDelete ()

	delete ()

Protected Member Functions
	checkInput ()

	checkAccess ()

Protected Attributes
ILIAS UI Factory	$ui_factory

ilLanguage	$lng

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilToolbarGUI	$toolbar

ilPropertyFormGUI	$form

ilHelpGUI	$help

ILIAS HTTP Services	$http

ILIAS Refinery Factory	$refinery

ilDclTableListGUI	$parent_object

int	$obj_id

Private Attributes
int	$table_id

ilDclTable	$table

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilDclTableEditGUI::__construct ( ilDclTableListGUI $a_parent_obj )

Constructor.

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

References $DIC, $table_id, checkAccess(), ILIAS\Repository\ctrl(), ilDclTableListGUI\getObjId(), ilDclCache\getTableCache(), ILIAS\Repository\help(), 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->help = $DIC->help();
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
         $this->ui_factory = $DIC->ui()->factory();
 
         $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::class, 'listRecords');
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ accessDenied()

ilDclTableEditGUI::accessDenied ( )

Definition at line 364 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 166 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 383 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 404 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 ( )

protected

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

References $table, ILIAS\Repository\form(), ilDclTable\getId(), ilDclTable\getTitle(), and ILIAS\Repository\lng().

Referenced by save().

                                    : bool
     {
         $return = $this->form->checkInput();
 
         $title = $this->form->getInput('title');
         foreach ($this->parent_object->getDataCollectionObject()->getTables() as $table) {
             if ($table->getTitle() === $title && $table->getId() !== $this->table->getId()) {
                 $inputObj = $this->form->getItemByPostVar('title');
                 $inputObj->setAlert($this->lng->txt("dcl_table_title_unique"));
                 $return = false;
                 break;
             }
         }
 
         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 369 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', (string) $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 90 of file class.ilDclTableEditGUI.php.

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

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

Here is the call graph for this function:

◆ delete()

ilDclTableEditGUI::delete ( )

Definition at line 388 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();
         }
         $this->ctrl->clearParameterByClass("ilobjdatacollectiongui", "table_id");
         $this->ctrl->redirectByClass("ildcltablelistgui", "listtables");
     }

Here is the call graph for this function:

◆ edit()

ilDclTableEditGUI::edit ( )

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

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

                           : void
     {
         $this->help->setSubScreenId('edit');
 
         if (!$this->table_id) {
             $this->ctrl->redirectByClass(ilDclFieldEditGUI::class, "listFields");
 
             return;
         } else {
             $this->table = ilDclCache::getTableCache($this->table_id);
         }
         $this->initForm(false);
         $this->getValues();
         $this->tpl->setContent($this->form->getHTML());
     }

Here is the call graph for this function:

◆ executeCommand()

ilDclTableEditGUI::executeCommand ( )

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

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

                                     : void
     {
         $cmd = $this->ctrl->getCmd();
         switch ($cmd) {
             case 'update':
                 $this->save(false);
                 break;
             default:
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ getStandardValues()

ilDclTableEditGUI::getStandardValues ( )

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

References ILIAS\Repository\form().

Referenced by create().

                                        : void
     {
         $values = [
             '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 115 of file class.ilDclTableEditGUI.php.

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

Referenced by edit().

                                : void
     {
         $values = [
             '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 ( bool $create = true )

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

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

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);
 
         if (!$create) {
             $switcher = new ilDclSwitcher($this->toolbar, $this->ui_factory, $this->ctrl, $this->lng);
             $switcher->addTableSwitcherToToolbar(
                 $this->parent_object->getDataCollectionObject()->getTables(),
                 self::class,
                 'edit'
             );
 
             $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 = [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 = ['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);
 
         $this->ctrl->setParameter($this, 'table_id', $this->table_id);
         if ($create) {
             $this->form->setTitle($this->lng->txt('dcl_new_table'));
             $this->form->addCommandButton('save', $this->lng->txt('create'));
             $this->form->setFormAction($this->ctrl->getFormAction($this, 'create'));
         } else {
             $this->form->setTitle($this->lng->txt('dcl_edit_table'));
             $this->form->addCommandButton('update', $this->lng->txt('save'));
             $this->form->setFormAction($this->ctrl->getFormAction($this, 'update'));
         }
         $this->form->addCommandButton('cancel', $this->lng->txt('cancel'));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilDclTableEditGUI::save ( bool $create = true )

Definition at line 281 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($create);
 
         if ($this->checkInput()) {
             if ($create) {
                 $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((bool) $this->form->getInput('view_own_records_perm'));
             $this->table->setExportEnabled((bool) $this->form->getInput("export_enabled"));
             $this->table->setImportEnabled((bool) $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((bool) $this->form->getInput("limited"));
             $this->table->setDescription($this->form->getInput('description'));
             $this->table->setLimitStart((string) $this->form->getInput("limit_start"));
             $this->table->setLimitEnd((string) $this->form->getInput("limit_end"));
             if ($create) {
                 $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->table->doUpdate();
                 $this->tpl->setOnScreenMessage('success', $this->lng->txt("dcl_msg_table_edited"), true);
                 $this->ctrl->redirectByClass("ildcltableeditgui", "edit");
             }
         } else {
             $this->form->setValuesByPost();
             $this->tpl->setContent($this->form->getHTML());
         }
     }