Collaboration diagram for ilDclFieldEditGUI:

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

	executeCommand ()
	execute command More...

	create ()
	create field add form More...

	edit ()
	create field edit form More...

	permissionDenied ()

	confirmDelete ()
	confirmDelete More...

	cancelDelete ()
	cancelDelete More...

	delete ()

	cancel ()

	initForm (string $a_mode="create")
	initEditCustomForm More...

	save (string $a_mode="create")
	save Field More...

	getDataCollectionObject ()

Protected Member Functions
	checkInput (string $a_mode)
	Check input of form. More...

	checkAccess ()

	checkUniqueness ()

Protected Attributes
int	$obj_id

int	$table_id

ilDclTableListGUI	$parent_obj

ilDclTable	$table

ilPropertyFormGUI	$form

ilDclBaseFieldModel	$field_obj

ilHelpGUI	$help

ILIAS HTTP Services	$http

ILIAS Refinery Factory	$refinery

int	$field_id

Private Attributes
ilGlobalTemplateInterface	$main_tpl

ilLanguage	$lng

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilDclFieldEditGUI::__construct ( ilDclTableListGUI $a_parent_obj )

Constructor.

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

References $DIC, ilDclDatatype\getAllDatatype(), ilDclCache\getFieldCache(), ilDclFieldFactory\getFieldModelInstance(), ilDclTableListGUI\getObjId(), ilDclCache\getTableCache(), ILIAS\Repository\help(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

     {
         global $DIC;
         $this->main_tpl = $DIC->ui()->mainTemplate();
         $ilCtrl = $DIC['ilCtrl'];
 
         $this->obj_id = $a_parent_obj->getObjId();
         $this->parent_obj = $a_parent_obj;
         $this->help = $DIC->help();
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
         $this->lng = $DIC->language();
 
         $this->table_id = $this->http->wrapper()->query()->retrieve('table_id', $this->refinery->kindlyTo()->int());
 
         $hasFieldId = $this->http->wrapper()->query()->has('field_id');
         if ($hasFieldId) {
             $this->field_id = $this->http->wrapper()->query()->retrieve('field_id', $this->refinery->kindlyTo()->int());
         } else {
             $this->field_id = 0;
         }
 
         if ($this->field_id) {
             $this->field_obj = ilDclCache::getFieldCache($this->field_id);
         } else {
             $datatype = null;
 
             $has_datatype = $this->http->wrapper()->post()->has('datatype');
 
             if ($has_datatype) {
                 $datatype_value = $this->http->wrapper()->post()->retrieve(
                     'datatype',
                     $this->refinery->kindlyTo()->int()
                 );
                 if (in_array(
                     $datatype_value,
                     array_keys(ilDclDatatype::getAllDatatype())
                 )) {
                     $datatype = $datatype_value;
                 }
             }
             $this->field_obj = ilDclFieldFactory::getFieldModelInstance($this->field_id, $datatype);
             if (!$this->table_id) {
                 $ilCtrl->redirectByClass("ilDclTableListGUI", "listFields");
             }
             $this->field_obj->setTableId($this->table_id);
             $ilCtrl->saveParameter($this, "table_id");
         }
 
         $this->table = ilDclCache::getTableCache($this->table_id);
     }

Here is the call graph for this function:

Member Function Documentation

◆ cancel()

ilDclFieldEditGUI::cancel ( )

Definition at line 199 of file class.ilDclFieldEditGUI.php.

References $DIC.

                             : void
     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
         $ilCtrl->redirectByClass("ildclfieldlistgui", "listFields");
     }

◆ cancelDelete()

ilDclFieldEditGUI::cancelDelete ( )

cancelDelete

Definition at line 176 of file class.ilDclFieldEditGUI.php.

References $DIC.

                                   : void
     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
 
         $ilCtrl->redirectByClass("ildclfieldlistgui", "listFields");
     }

◆ checkAccess()

ilDclFieldEditGUI::checkAccess ( )

protected

Returns: bool

Definition at line 385 of file class.ilDclFieldEditGUI.php.

References getDataCollectionObject(), ilObjDataCollectionAccess\hasAccessToField(), and ilObjDataCollectionAccess\hasAccessToFields().

Referenced by executeCommand().

                                     : bool
     {
         if ($field_id = $this->field_obj->getId()) {
             return ilObjDataCollectionAccess::hasAccessToField(
                 $this->getDataCollectionObject()->getRefId(),
                 $this->table_id,
                 (int) $field_id
             );
         } else {
             return ilObjDataCollectionAccess::hasAccessToFields(
                 $this->getDataCollectionObject()->getRefId(),
                 $this->table_id
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkInput()

ilDclFieldEditGUI::checkInput ( string $a_mode )

protected

Check input of form.

Parameters

$a_mode 'create' | 'update'

Returns: bool

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

References $DIC, ilDclTable\_hasFieldByTitle(), checkUniqueness(), ILIAS\Repository\form(), ilDclFieldFactory\getFieldModelInstanceByClass(), and ilLanguage\txt().

Referenced by save().

                                                  : bool
     {
         global $DIC;
         $lng = $DIC['lng'];
         $return = $this->form->checkInput();
 
         //mantis 30758, 36585, jour fixe decision:
         //uniqueness shall be changeable for all types of fields
         if ($a_mode === 'update' && !$this->checkUniqueness()) {
             $return = false;
         }
 
         // load specific model for input checking
         $datatype_id = $this->form->getInput('datatype');
         if ($datatype_id != null && is_numeric($datatype_id)) {
             $base_model = new ilDclBaseFieldModel();
             $base_model->setDatatypeId((int) $datatype_id);
             $field_validation_class = ilDclFieldFactory::getFieldModelInstanceByClass($base_model);
 
             if (!$field_validation_class->checkFieldCreationInput($this->form)) {
                 $return = false;
             }
         }
 
         // Don't allow multiple fields with the same title in this table
         if ($a_mode == 'create') {
             if ($title = $this->form->getInput('title')) {
                 if (ilDclTable::_hasFieldByTitle($title, $this->table_id)) {
                     $inputObj = $this->form->getItemByPostVar('title');
                     $inputObj->setAlert($lng->txt("dcl_field_title_unique"));
                     $return = false;
                 }
             }
         }
 
         if (!$return) {
             $this->main_tpl->setOnScreenMessage('failure', $lng->txt("form_input_not_valid"));
         }
 
         return $return;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkUniqueness()

ilDclFieldEditGUI::checkUniqueness ( )

protected

Returns: bool

Definition at line 404 of file class.ilDclFieldEditGUI.php.

References Vendor\Package\$e, $txt, ILIAS\Repository\form(), ilDclDatatype\INPUTFORMAT_FORMULA, ilDclDatatype\INPUTFORMAT_RATING, and ILIAS\Repository\lng().

Referenced by checkInput().

                                         : bool
     {
         $this->field_obj->setUnique((bool) $this->form->getInput("unique"));
         if (!$this->field_obj->isUnique()) {
             return true;
         }
 
         $txt = $this->lng->txt("dcl_duplicate_non_unique_entries_exist");
 
         //check validity of all available records
         foreach ($this->table->getRecords() as $record) {
 
             //except of formula field
             if ((int) ($this->field_obj->getDatatypeId()) !== ilDclDatatype::INPUTFORMAT_FORMULA) {
                 //get field value
                 $value = $record->getRecordFieldValue($this->field_obj->getId());
 
                 //special for rating field: only voting of the current user
                 if ((int) ($this->field_obj->getDatatypeId()) === ilDclDatatype::INPUTFORMAT_RATING) {
                     $value = $record->getRecordFieldValueForUser($this->field_obj->getId());
                     $txt = "";
                 }
                 //validity of field content
                 try {
                     $this->field_obj->checkValidity($value, $record->getId());
                 } catch (ilDclInputException $e) {
                     $item = $this->form->getItemByPostVar('unique');
                     $item->setAlert($txt);
                     return false;
                 }
             }
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDelete()

ilDclFieldEditGUI::confirmDelete ( )

confirmDelete

Definition at line 154 of file class.ilDclFieldEditGUI.php.

References $DIC, and ilLanguage\txt().

                                    : void
     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
         $lng = $DIC['lng'];
         $tpl = $DIC['tpl'];
 
         $conf = new ilConfirmationGUI();
         $conf->setFormAction($ilCtrl->getFormAction($this));
         $conf->setHeaderText($lng->txt('dcl_confirm_delete_field'));
 
         $conf->addItem('field_id', $this->field_obj->getId(), $this->field_obj->getTitle());
 
         $conf->setConfirm($lng->txt('delete'), 'delete');
         $conf->setCancel($lng->txt('cancel'), 'cancelDelete');
 
         $tpl->setContent($conf->getHTML());
     }

Here is the call graph for this function:

◆ create()

ilDclFieldEditGUI::create ( )

create field add form

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

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

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

Here is the call graph for this function:

◆ delete()

ilDclFieldEditGUI::delete ( )

Definition at line 187 of file class.ilDclFieldEditGUI.php.

References $DIC.

                             : void
     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
 
         $this->table->deleteField((int) $this->field_obj->getId());
         $ilCtrl->redirectByClass("ildclfieldlistgui", "listFields");
     }

◆ edit()

ilDclFieldEditGUI::edit ( )

create field edit form

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

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

                           : void
     {
         $this->help->setSubScreenId('edit');
 
         $this->initForm("edit");
         $this->field_obj->fillPropertiesForm($this->form);
         $this->main_tpl->setContent($this->form->getHTML());
     }

Here is the call graph for this function:

◆ executeCommand()

ilDclFieldEditGUI::executeCommand ( )

execute command

Definition at line 95 of file class.ilDclFieldEditGUI.php.

References $DIC, checkAccess(), permissionDenied(), and save().

                                     : void
     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
         $ilCtrl->saveParameter($this, 'field_id');
 
         $cmd = $ilCtrl->getCmd();
 
         if (!$this->checkAccess()) {
             $this->permissionDenied();
             return;
         }
 
         switch ($cmd) {
             case "update":
                 $this->save("update");
                 break;
             default:
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ getDataCollectionObject()

ilDclFieldEditGUI::getDataCollectionObject ( )

Returns: ilObjDataCollection

Definition at line 442 of file class.ilDclFieldEditGUI.php.

Referenced by checkAccess(), and initForm().

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

Here is the caller graph for this function:

◆ initForm()

ilDclFieldEditGUI::initForm ( string $a_mode = "create" )

initEditCustomForm

Parameters

string $a_mode values: create | edit

Definition at line 210 of file class.ilDclFieldEditGUI.php.

References $DIC, ilDclBaseFieldModel\_getTitleInvalidChars(), ILIAS\Repository\form(), ilDclDatatype\getAllDatatype(), getDataCollectionObject(), ilDclFieldFactory\getFieldModelInstanceByClass(), ilDclFieldFactory\getFieldRepresentationInstance(), ilFormPropertyGUI\setInfo(), and ilLanguage\txt().

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

                                                        : void
     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
         $lng = $DIC['lng'];
 
         $this->form = new ilPropertyFormGUI();
 
         if ($a_mode == "edit") {
             $this->form->setTitle($lng->txt('dcl_edit_field'));
             $hidden_prop = new ilHiddenInputGUI("field_id");
             $this->form->addItem($hidden_prop);
 
             $this->form->setFormAction($ilCtrl->getFormAction($this));
 
             $this->form->addCommandButton('update', $lng->txt('dcl_update_field'));
         } else {
             $this->form->setTitle($lng->txt('dcl_new_field'));
             $hidden_prop = new ilHiddenInputGUI("table_id");
             $hidden_prop->setValue((string) $this->field_obj->getTableId());
             $this->form->addItem($hidden_prop);
 
             $this->form->setFormAction($ilCtrl->getFormAction($this));
 
             $this->form->addCommandButton('save', $lng->txt('dcl_create_field'));
         }
         $this->form->addCommandButton('cancel', $lng->txt('cancel'));
 
         $text_prop = new ilTextInputGUI($lng->txt("title"), "title");
         $text_prop->setRequired(true);
         $text_prop->setInfo(sprintf(
             $lng->txt('fieldtitle_allow_chars'),
             ilDclBaseFieldModel::_getTitleInvalidChars(false)
         ));
         $text_prop->setValidationRegexp(ilDclBaseFieldModel::_getTitleInvalidChars());
         $this->form->addItem($text_prop);
 
         // Description
         $text_prop = new ilTextAreaInputGUI($lng->txt("dcl_field_description"), "description");
         $text_prop->setInfo($lng->txt('dcl_field_description_desc'));
         $this->form->addItem($text_prop);
 
         $edit_datatype = new ilRadioGroupInputGUI($lng->txt('dcl_datatype'), 'datatype');
 
         if ($a_mode === 'edit') {
             $field_representation = ilDclFieldFactory::getFieldRepresentationInstance($this->field_obj);
             $field_representation->addFieldCreationForm($edit_datatype, $this->getDataCollectionObject(), $a_mode);
             $edit_datatype->setDisabled(true);
         } else {
             foreach (ilDclDatatype::getAllDatatype() as $datatype) {
                 $model = new ilDclBaseFieldModel();
                 $model->setDatatypeId($datatype->getId());
                 $model = ilDclFieldFactory::getFieldModelInstanceByClass($model);
                 $field_representation = ilDclFieldFactory::getFieldRepresentationInstance($model);
                 $field_representation->addFieldCreationForm($edit_datatype, $this->getDataCollectionObject());
             }
         }
         $edit_datatype->setRequired(true);
         $this->form->addItem($edit_datatype);
 
         //Unique
         $cb = new ilCheckboxInputGUI($lng->txt("dcl_unique"), "unique");
         $cb->setInfo($lng->txt('dcl_unique_desc'));
         $this->form->addItem($cb);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ permissionDenied()

ilDclFieldEditGUI::permissionDenied ( )

Definition at line 144 of file class.ilDclFieldEditGUI.php.

References $DIC.

Referenced by executeCommand().

                                       : void
     {
         global $DIC;
         $tpl = $DIC['tpl'];
         $tpl->setContent("Permission denied");
     }

Here is the caller graph for this function:

◆ save()

ilDclFieldEditGUI::save ( string $a_mode = "create" )

save Field

Parameters

string $a_mode values: create | update

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

References $DIC, checkInput(), ILIAS\Repository\form(), initForm(), and ilLanguage\txt().

Referenced by executeCommand().

                                                    : void
     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
         $lng = $DIC['lng'];
         $tpl = $DIC['tpl'];
 
         $this->initForm($a_mode == "update" ? "edit" : "create");
 
         if ($this->checkInput($a_mode)) {
 
             // check if confirmation is needed and if so, fetch and render confirmationGUI
             if (($a_mode == "update") && !($this->form->getInput('confirmed')) && $this->field_obj->isConfirmationRequired($this->form)) {
                 $ilConfirmationGUI = $this->field_obj->getConfirmationGUI($this->form);
                 $tpl->setContent($ilConfirmationGUI->getHTML());
 
                 return;
             }
 
             $title = $this->form->getInput("title");
             if ($a_mode != "create" && $title != $this->field_obj->getTitle()) {
                 $this->main_tpl->setOnScreenMessage('info', $lng->txt("dcl_field_title_change_warning"), true);
             }
 
             $this->field_obj->setTitle($title);
             $this->field_obj->setDescription($this->form->getInput("description"));
             $this->field_obj->setDatatypeId((int) $this->form->getInput("datatype"));
             $this->field_obj->setUnique((bool) $this->form->getInput("unique"));
 
             if ($a_mode == "update") {
                 $this->field_obj->doUpdate();
             } else {
                 $this->field_obj->setOrder($this->table->getNewFieldOrder());
                 $this->field_obj->doCreate();
             }
 
             // Get possible properties and save them
             $this->field_obj->storePropertiesFromForm($this->form);
 
             $ilCtrl->setParameter($this, "field_id", $this->field_obj->getId());
 
             if ($a_mode == "update") {
                 $this->main_tpl->setOnScreenMessage('success', $lng->txt("dcl_msg_field_modified"), true);
             } else {
                 $this->table->addField($this->field_obj);
                 $this->table->buildOrderFields();
                 $this->main_tpl->setOnScreenMessage('success', $lng->txt("msg_field_created"));
             }
             $ilCtrl->redirectByClass(strtolower("ilDclFieldListGUI"), "listFields");
         } else {
             $this->form->setValuesByPost();
             $tpl->setContent($this->form->getHTML());
         }
     }