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 ($a_mode="create")
	initEditCustomForm More...

	getValues ()
	getFieldValues More...

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

	getDataCollectionObject ()

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

	checkAccess ()

Protected Attributes
	$obj_id

	$table_id

	$parent_obj

	$table

	$form

	$field_obj

Detailed Description

Class ilDclFieldEditGUI.

Author: 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

Version: $Id:

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

Constructor & Destructor Documentation

◆ __construct()

ilDclFieldEditGUI::__construct ( ilDclTableListGUI $a_parent_obj )

Constructor.

Parameters

ilDclTableListGUI	$a_parent_obj
int	$table_id	We need a table_id if no field_id is set (creation mode). We ignore the table_id by edit mode
int	$field_id	The field_id of a existing fiel (edit mode)

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

                                                                     {
                global $DIC;
                $ilCtrl = $DIC['ilCtrl'];
 
                $this->obj_id = $a_parent_obj->obj_id;
                $this->parent_obj = $a_parent_obj;
 
                $this->table_id = $_GET["table_id"];
                $this->field_id = $_GET['field_id'];
 
                if ($this->field_id) {
                        $this->field_obj = ilDclCache::getFieldCache($this->field_id);
                } else {
                        $datatype = null;
                        if(isset($_POST['datatype']) && in_array($_POST['datatype'], array_keys(ilDclDatatype::getAllDatatype()))) {
                                $datatype = $_POST['datatype'];
                        }
                        $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);
        }

References $_GET, $_POST, $DIC, $ilCtrl, ilDclDatatype\getAllDatatype(), ilDclCache\getFieldCache(), ilDclFieldFactory\getFieldModelInstance(), and ilDclCache\getTableCache().

Here is the call graph for this function:

Member Function Documentation

◆ cancel()

ilDclFieldEditGUI::cancel ( )

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

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

References $DIC, and $ilCtrl.

◆ cancelDelete()

ilDclFieldEditGUI::cancelDelete ( )

cancelDelete

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

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

References $DIC, and $ilCtrl.

◆ checkAccess()

ilDclFieldEditGUI::checkAccess ( )

protected

Returns: bool

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

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

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkInput()

ilDclFieldEditGUI::checkInput ( $a_mode )

protected

Check input of form.

Parameters

$a_mode 'create' | 'update'

Returns: bool

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

                                               {
                global $DIC;
                $lng = $DIC['lng'];
                $return = $this->form->checkInput();
 
                // 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($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) {
                        ilUtil::sendFailure($lng->txt("form_input_not_valid"));
                }
 
                return $return;
        }

References $DIC, $lng, $title, ilDclTable\_hasFieldByTitle(), ilDclFieldFactory\getFieldModelInstanceByClass(), and ilUtil\sendFailure().

Referenced by save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDelete()

ilDclFieldEditGUI::confirmDelete ( )

confirmDelete

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

                                        {
                global $DIC;
                $ilCtrl = $DIC['ilCtrl'];
                $lng = $DIC['lng'];
                $tpl = $DIC['tpl'];
 
                include_once './Services/Utilities/classes/class.ilConfirmationGUI.php';
                $conf = new ilConfirmationGUI();
                $conf->setFormAction($ilCtrl->getFormAction($this));
                $conf->setHeaderText($lng->txt('dcl_confirm_delete_field'));
 
                $conf->addItem('field_id', (int)$this->field_obj->getId(), $this->field_obj->getTitle());
 
                $conf->setConfirm($lng->txt('delete'), 'delete');
                $conf->setCancel($lng->txt('cancel'), 'cancelDelete');
 
                $tpl->setContent($conf->getHTML());
        }

References $DIC, $ilCtrl, $lng, and $tpl.

◆ create()

ilDclFieldEditGUI::create ( )

create field add form

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

                                 {
                global $DIC;
                $tpl = $DIC['tpl'];
 
                $this->initForm();
                $tpl->setContent($this->form->getHTML());
        }

References $DIC, $tpl, and initForm().

Here is the call graph for this function:

◆ delete()

ilDclFieldEditGUI::delete ( )

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

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

References $DIC, and $ilCtrl.

◆ edit()

ilDclFieldEditGUI::edit ( )

create field edit form

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

                               {
                global $DIC;
                $tpl = $DIC['tpl'];
 
                $this->initForm("edit");
                $this->getValues();
 
                $tpl->setContent($this->form->getHTML());
        }

References $DIC, $tpl, getValues(), and initForm().

Here is the call graph for this function:

◆ executeCommand()

ilDclFieldEditGUI::executeCommand ( )

execute command

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

                                         {
                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;
                }
 
                return true;
        }

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

Here is the call graph for this function:

◆ getDataCollectionObject()

ilDclFieldEditGUI::getDataCollectionObject ( )

Returns: ilObjDataCollection

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

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

Referenced by checkAccess(), and initForm().

Here is the caller graph for this function:

◆ getValues()

ilDclFieldEditGUI::getValues ( )

getFieldValues

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

                                    {
                //Std-Values
                $values = array(
                        'table_id' => $this->field_obj->getTableId(),
                        'field_id' => $this->field_obj->getId(),
                        'title' => $this->field_obj->getTitle(),
                        'datatype' => $this->field_obj->getDatatypeId(),
                        'description' => $this->field_obj->getDescription(),
                        'required' => $this->field_obj->getRequired(),
                        'unique' => $this->field_obj->isUnique(),
                );
 
                $properties = $this->field_obj->getValidFieldProperties();
                foreach ($properties as $prop) {
                        $values['prop_' . $prop] = $this->field_obj->getProperty($prop);
                }
 
                $this->form->setValuesByArray($values);
 
                return true;
        }

Referenced by edit().

Here is the caller graph for this function:

◆ initForm()

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

initEditCustomForm

Parameters

string $a_mode values: create | edit

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

                                                     {
                global $DIC;
                $ilCtrl = $DIC['ilCtrl'];
                $lng = $DIC['lng'];
 
                include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
                $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), "update");
 
                        $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($this->field_obj->getTableId());
                        $this->form->addItem($hidden_prop);
 
                        $this->form->setFormAction($ilCtrl->getFormAction($this), "save");
 
                        $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(true));
                $this->form->addItem($text_prop);
 
        // Description
        $text_prop = new ilTextAreaInputGUI($lng->txt("dcl_field_description"), "description");
        $this->form->addItem($text_prop);
 
        $edit_datatype = new ilRadioGroupInputGUI($lng->txt('dcl_datatype'), 'datatype');
 
                foreach (ilDclDatatype::getAllDatatype() as $datatype) {
                        $model = new ilDclBaseFieldModel();
                        $model->setDatatypeId($datatype->getId());
 
                        if($a_mode == 'edit' && $datatype->getId() == $this->field_obj->getDatatypeId()) {
                                $model = $this->field_obj;
                        }
 
                        $field_representation = ilDclFieldFactory::getFieldRepresentationInstance($model);
                        $field_representation->addFieldCreationForm($edit_datatype, $this->getDataCollectionObject(), $a_mode);
                }
                $edit_datatype->setRequired(true);
 
                //you can't change type but we still need it in POST
                if ($a_mode == "edit") {
                        $edit_datatype->setDisabled(true);
                }
                $this->form->addItem($edit_datatype);
 
                // Required
                $cb = new ilCheckboxInputGUI($lng->txt("dcl_field_required"), "required");
                $this->form->addItem($cb);
 
                //Unique
                $cb = new ilCheckboxInputGUI($lng->txt("dcl_unique"), "unique");
        $cb->setInfo($lng->txt('dcl_unique_desc'));
                $this->form->addItem($cb);
        }

References $DIC, $field_obj, $ilCtrl, $lng, ilDclBaseFieldModel\_getTitleInvalidChars(), ilDclDatatype\getAllDatatype(), getDataCollectionObject(), ilDclFieldFactory\getFieldRepresentationInstance(), and sprintf.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ permissionDenied()

ilDclFieldEditGUI::permissionDenied ( )

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

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

References $DIC, and $tpl.

Referenced by executeCommand().

Here is the caller graph for this function:

◆ save()

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

save Field

Parameters

string $a_mode values: create | update

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

                                                 {
                global $DIC;
                $ilCtrl = $DIC['ilCtrl'];
                $lng = $DIC['lng'];
                $tpl = $DIC['tpl'];
 
                $this->initForm($a_mode == "update" ? "edit" : "create");
 
                if ($this->checkInput($a_mode)) {
                        $title = $this->form->getInput("title");
                        if ($a_mode != "create" && $title != $this->field_obj->getTitle()) {
                                ilUtil::sendInfo($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($this->form->getInput("datatype"));
                        $this->field_obj->setRequired($this->form->getInput("required"));
                        $this->field_obj->setUnique($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
                        $field_props = $this->field_obj->getValidFieldProperties();
                        foreach ($field_props as $property) {
                                $representation = ilDclFieldFactory::getFieldRepresentationInstance($this->field_obj);
                                $value = $this->form->getInput($representation->getPropertyInputFieldId($property));
 
                                // save non empty values and set them to null, when they already exist. Do not override plugin-hook when already set.
                                if(!empty($value) || ($this->field_obj->getPropertyInstance($property) != NULL && $property != ilDclBaseFieldModel::PROP_PLUGIN_HOOK_NAME)) {
                                        $this->field_obj->setProperty($property, $value)->store();
                                }
                        }
 
                        $ilCtrl->setParameter($this, "field_id", $this->field_obj->getId());
 
                        if ($a_mode == "update") {
                                ilUtil::sendSuccess($lng->txt("dcl_msg_field_modified"), true);
                        } else {
                                $this->table->addField($this->field_obj);
                                $this->table->buildOrderFields();
                                ilUtil::sendSuccess($lng->txt("msg_field_created"), false);
                        }
                        $ilCtrl->redirectByClass(strtolower("ilDclFieldListGUI"), "listFields");
                } else {
                        $this->form->setValuesByPost();
                        $tpl->setContent($this->form->getHTML());
                }
        }