ilDclRecordEditGUI Class Reference

Class ilDclRecordEditGUI. More...

Collaboration diagram for ilDclRecordEditGUI:

Public Member Functions
	__construct (ilObjDataCollectionGUI $parent_obj)
	executeCommand ()
	getRecord ()
	create ()
	Create new record gui. More...
	edit ()
	Record edit gui. More...
	confirmDelete ()
	Delete confirmation. More...
	cancelDelete ()
	Cancel deletion. More...
	delete ()
	Remove record. More...
	getRecordData ($record_id=0)
	Return All fields and values from a record ID. More...
	initForm ()
	init Form More...
	setFormValues ()
	Set values from object to form. More...
	cancelUpdate ()
	Cancel Update. More...
	cancelSave ()
	Cancel Save. More...
	save ()
	Save record. More...
	searchObjects ()
	This function is only used by the ajax request if searching for ILIAS references. More...
	getForm ()

Data Fields
const	REDIRECT_RECORD_LIST = 1
	Possible redirects after saving/updating a record - use GET['redirect'] to set constants. More...
const	REDIRECT_DETAIL = 2

Protected Member Functions
	checkAndPerformRedirect ($force_redirect=false)
	Checkes to what view (table or detail) should be redirected and performs redirect. More...
	accessDenied ()
	sendFailure ($message)
	getLanguageJsKeys ()
	parseSearchResults ($a_res)
	Parse search results. More...
	cleanupTempFiles ()
	Cleanup temp-files. More...

Protected Attributes
	$tableview_id
	$record_id
	$table_id
	$table
	$parent_obj
	$record
	$ctrl
	$tpl
	$lng
	$user
	$form
	$tableview

Detailed Description

Class ilDclRecordEditGUI.

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

Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

$Id:

Definition at line 15 of file class.ilDclRecordEditGUI.php.

Constructor & Destructor Documentation

__construct()

ilDclRecordEditGUI::__construct

(

ilObjDataCollectionGUI

$parent_obj

)

Parameters

ilObjDataCollectionGUI

$parent_obj

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

References $DIC, $ilUser, $lng, $parent_obj, $tpl, ActiveRecord\findOrGetInstance(), ilDclCache\getTableCache(), and user().

    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];
        $ilUser = $DIC['ilUser'];

        $this->ctrl = $ilCtrl;
        $this->tpl = $tpl;
        $this->lng = $lng;
        $this->user = $ilUser;
        $this->parent_obj = $parent_obj;
        $this->record_id = $_REQUEST['record_id'];
        $this->table_id = $_REQUEST['table_id'];
        $this->tableview_id = $_REQUEST['tableview_id'];
        if (!$this->tableview_id) {
            $this->tableview_id = ilDclCache::getTableCache($this->table_id)
                                         ->getFirstTableViewId($this->parent_obj->ref_id);
        }
        $this->tableview = ilDclTableView::findOrGetInstance($this->tableview_id);
    }

Here is the call graph for this function:

Member Function Documentation

accessDenied()

ilDclRecordEditGUI::accessDenied ( )

protected

Definition at line 705 of file class.ilDclRecordEditGUI.php.

References exit, and ilUtil\sendFailure().

Referenced by delete(), getRecord(), and save().

    {
        if (!$this->ctrl->isAsynch()) {
            ilUtil::sendFailure($this->lng->txt('dcl_msg_no_perm_edit'), true);
            $this->ctrl->redirectByClass('ildclrecordlistgui', 'listRecords');
        } else {
            echo $this->lng->txt('dcl_msg_no_perm_edit');
            exit();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cancelDelete()

ilDclRecordEditGUI::cancelDelete

(

)

Cancel deletion.

Definition at line 219 of file class.ilDclRecordEditGUI.php.

    {
        $this->ctrl->redirectByClass("ildclrecordlistgui", "listRecords");
    }

cancelSave()

ilDclRecordEditGUI::cancelSave

(

)

Cancel Save.

Definition at line 406 of file class.ilDclRecordEditGUI.php.

References cancelUpdate(), exit, ilDclBaseRecordModel\getRecordField(), ilDclFieldFactory\getRecordRepresentationInstance(), ilObjDataCollectionAccess\hasEditAccess(), ilObjDataCollectionAccess\hasWriteAccess(), IL_CAL_DATETIME, IL_CAL_UNIX, ilDclBaseRecordModel\setLastEditBy(), ilDclBaseRecordModel\setLastUpdate(), ilDclBaseRecordModel\setTableId(), and user().

    {
        $this->cancelUpdate();
    }

Here is the call graph for this function:

cancelUpdate()

ilDclRecordEditGUI::cancelUpdate

(

)

Cancel Update.

Definition at line 397 of file class.ilDclRecordEditGUI.php.

References checkAndPerformRedirect().

Referenced by cancelSave().

    {
        $this->checkAndPerformRedirect(true);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkAndPerformRedirect()

ilDclRecordEditGUI::checkAndPerformRedirect (   $force_redirect = false )

protected

Checkes to what view (table or detail) should be redirected and performs redirect.

Definition at line 685 of file class.ilDclRecordEditGUI.php.

References $_GET.

Referenced by cancelUpdate(), and save().

    {
        if ($force_redirect || (isset($_GET['redirect']) && !$this->ctrl->isAsynch())) {
            switch ((int) $_GET['redirect']) {
                case self::REDIRECT_DETAIL:
                    $this->ctrl->setParameterByClass('ilDclDetailedViewGUI', 'record_id', $this->record_id);
                    $this->ctrl->setParameterByClass('ilDclDetailedViewGUI', 'table_id', $this->table_id);
                    $this->ctrl->setParameterByClass('ilDclDetailedViewGUI', 'tableview_id', $this->tableview_id);
                    $this->ctrl->redirectByClass("ilDclDetailedViewGUI", "renderRecord");
                    break;
                case self::REDIRECT_RECORD_LIST:
                    $this->ctrl->redirectByClass("ildclrecordlistgui", "listRecords");
                    break;
                default:
                    $this->ctrl->redirectByClass("ildclrecordlistgui", "listRecords");
            }
        }
    }

Here is the caller graph for this function:

cleanupTempFiles()

ilDclRecordEditGUI::cleanupTempFiles ( )

protected

Cleanup temp-files.

Definition at line 830 of file class.ilDclRecordEditGUI.php.

References $_POST.

Referenced by edit().

    {
        $ilfilehash = (isset($_POST['ilfilehash'])) ? $_POST['ilfilehash'] : null;
        if ($ilfilehash != null) {
            $this->form->cleanupTempFiles($ilfilehash);
        }
    }

Here is the caller graph for this function:

confirmDelete()

ilDclRecordEditGUI::confirmDelete

(

)

Delete confirmation.

Exceptions

ilDclException

Definition at line 190 of file class.ilDclRecordEditGUI.php.

References $record, ilDclCache\getRecordCache(), ilDclCache\getRecordFieldCache(), and ilDclCache\getRecordRepresentation().

    {
        $conf = new ilConfirmationGUI();
        $conf->setFormAction($this->ctrl->getFormAction($this));
        $conf->setHeaderText($this->lng->txt('dcl_confirm_delete_record'));
        $record = ilDclCache::getRecordCache($this->record_id);

        $all_fields = $this->table->getRecordFields();
        $record_data = "";
        foreach ($all_fields as $key => $field) {
            $field_record = ilDclCache::getRecordFieldCache($record, $field);

            $record_representation = ilDclCache::getRecordRepresentation($field_record);
            if ($record_representation->getConfirmationHTML() !== false) {
                $record_data .= $field->getTitle() . ": " . $record_representation->getConfirmationHTML() . "<br />";
            }
        }
        $conf->addItem('record_id', $record->getId(), $record_data);
        $conf->addHiddenItem('table_id', $this->table_id);
        $conf->addHiddenItem('tableview_id', $this->tableview_id);
        $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()

ilDclRecordEditGUI::create

(

)

Create new record gui.

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

References exit, getLanguageJsKeys(), and initForm().

    {
        $this->initForm();
        if ($this->ctrl->isAsynch()) {
            echo $this->form->getHTML();
            exit();
        } else {
            $this->tpl->setContent(
                $this->getLanguageJsKeys()
                . $this->form->getHTML()
            );
        }
    }

Here is the call graph for this function:

delete()

ilDclRecordEditGUI::delete

(

)

Remove record.

Definition at line 228 of file class.ilDclRecordEditGUI.php.

References $record, accessDenied(), and ilDclCache\getRecordCache().

    {
        $record = ilDclCache::getRecordCache($this->record_id);

        if (!$this->table->hasPermissionToDeleteRecord($this->parent_obj->ref_id, $record)) {
            $this->accessDenied();

            return;
        }

        $record->doDelete();
        ilUtil::sendSuccess($this->lng->txt("dcl_record_deleted"), true);
        $this->ctrl->redirectByClass("ildclrecordlistgui", "listRecords");
    }

Here is the call graph for this function:

edit()

ilDclRecordEditGUI::edit

(

)

Record edit gui.

Definition at line 167 of file class.ilDclRecordEditGUI.php.

References cleanupTempFiles(), exit, getLanguageJsKeys(), initForm(), and setFormValues().

    {
        $this->initForm();
        $this->cleanupTempFiles();

        $this->setFormValues();
        if ($this->ctrl->isAsynch()) {
            echo $this->form->getHTML();
            exit();
        } else {
            $this->tpl->setContent(
                $this->getLanguageJsKeys()
                . $this->form->getHTML()
            );
        }
    }

Here is the call graph for this function:

executeCommand()

ilDclRecordEditGUI::executeCommand

(

)

Returns

bool

Definition at line 104 of file class.ilDclRecordEditGUI.php.

References getRecord().

    {
        $this->getRecord();

        $cmd = $this->ctrl->getCmd();
        switch ($cmd) {
            default:
                $this->$cmd();
                break;
        }

        return true;
    }

Here is the call graph for this function:

getForm()

ilDclRecordEditGUI::getForm

(

)

Returns

ilDclPropertyFormGUI

Definition at line 842 of file class.ilDclRecordEditGUI.php.

References $form.

    {
        return $this->form;
    }

getLanguageJsKeys()

ilDclRecordEditGUI::getLanguageJsKeys ( )

protected

Definition at line 798 of file class.ilDclRecordEditGUI.php.

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

    {
        return "<script>ilDataCollection.strings.add_value='" . $this->lng->txt('add_value') . "';</script>";
    }

Here is the caller graph for this function:

getRecord()

ilDclRecordEditGUI::getRecord

(

)

Definition at line 122 of file class.ilDclRecordEditGUI.php.

References $_GET, accessDenied(), ilDclCache\getRecordCache(), ilDclCache\getTableCache(), and ilObjDataCollectionAccess\hasAddRecordAccess().

Referenced by executeCommand().

    {
        if ($_GET['mode']) {
            $this->ctrl->saveParameter($this, 'mode');
            $this->ctrl->setParameterByClass("ildclrecordlistgui", "mode", $_GET['mode']);
        }
        $this->ctrl->setParameterByClass('ildclrecordlistgui', 'tableview_id', $this->tableview_id);
        $this->ctrl->saveParameter($this, 'redirect');
        if ($this->record_id) {
            $this->record = ilDclCache::getRecordCache($this->record_id);
            if (!($this->record->hasPermissionToEdit($this->parent_obj->ref_id) and $this->record->hasPermissionToView($this->parent_obj->ref_id)) && !$this->record->hasPermissionToDelete($this->parent_obj->ref_id)) {
                $this->accessDenied();
            }
            $this->table = $this->record->getTable();
            $this->table_id = $this->table->getId();
        } else {
            $this->table = ilDclCache::getTableCache($this->table_id);
            if (!ilObjDataCollectionAccess::hasAddRecordAccess($_GET['ref_id'])) {
                $this->accessDenied();
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRecordData()

ilDclRecordEditGUI::getRecordData

(

$record_id = 0

)

Return All fields and values from a record ID.

If this method is requested over AJAX, data is returned in JSON format

Parameters

int

$record_id

Returns

array

Definition at line 252 of file class.ilDclRecordEditGUI.php.

References $_GET, $record, $record_id, exit, and ilDclCache\getRecordCache().

    {
        $record_id = ($record_id) ? $record_id : $_GET['record_id'];
        $return = array();
        if ($record_id) {
            $record = ilDclCache::getRecordCache((int) $record_id);
            if (is_object($record)) {
                $return = $record->getRecordFieldValues();
            }
        }
        if ($this->ctrl->isAsynch()) {
            echo json_encode($return);
            exit();
        }

        return $return;
    }

Here is the call graph for this function:

initForm()

ilDclRecordEditGUI::initForm

(

)

init Form

move parts to RecordRepresentationGUI

Definition at line 276 of file class.ilDclRecordEditGUI.php.

References ilDclTableViewBaseDefaultValue\findSingle(), ilDclCache\getFieldRepresentation(), and ilObjDataCollectionAccess\hasWriteAccess().

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

    {
        $this->form = new ilDclPropertyFormGUI();
        $prefix = ($this->ctrl->isAsynch()) ? 'dclajax' : 'dcl'; // Used by datacolleciton.js to select input elements
        $this->form->setId($prefix . $this->table_id . $this->record_id);

        $hidden_prop = new ilHiddenInputGUI("table_id");
        $hidden_prop->setValue($this->table_id);
        $this->form->addItem($hidden_prop);
        $hidden_prop = new ilHiddenInputGUI("tableview_id");
        $hidden_prop->setValue($this->tableview_id);
        $this->form->addItem($hidden_prop);
        if ($this->record_id) {
            $hidden_prop = new ilHiddenInputGUI("record_id");
            $hidden_prop->setValue($this->record_id);
            $this->form->addItem($hidden_prop);
        }

        $this->ctrl->setParameter($this, "record_id", $this->record_id);
        $this->form->setFormAction($this->ctrl->getFormAction($this));
        $allFields = $this->table->getRecordFields();
        $inline_css = '';
        foreach ($allFields as $field) {
            $field_setting = $field->getViewSetting($this->tableview_id);
            if ($field_setting->isVisibleInForm(!$this->record_id)) {
                $item = ilDclCache::getFieldRepresentation($field)->getInputField($this->form, $this->record_id);
                if ($item === null) {
                    continue; // Fields calculating values at runtime, e.g. ilDclFormulaFieldModel do not have input
                }

                if (!ilObjDataCollectionAccess::hasWriteAccess($this->parent_obj->ref_id) && $field_setting->isLocked(!$this->record_id)) {
                    $item->setDisabled(true);
                }

                $item->setRequired($field_setting->isRequired(!$this->record_id));
                $default_value = null;

                // If creation mode
                if (!$this->record_id) {
                    $default_value = ilDclTableViewBaseDefaultValue::findSingle($field_setting->getFieldObject()->getDatatypeId(), $field_setting->getId());

                    if ($default_value !== null) {
                        if ($item instanceof ilDclCheckboxInputGUI) {
                            $item->setChecked($default_value->getValue());
                        } else {
                            $item->setValue($default_value->getValue());
                        }
                    }
                }
                $this->form->addItem($item);
            }
        }

        $this->tpl->addInlineCss($inline_css);

        // Add possibility to change the owner in edit mode
        if ($this->record_id) {
            $field_setting = $this->tableview->getFieldSetting('owner');
            if ($field_setting->isVisibleEdit()) {
                $ownerField = $this->table->getField('owner');
                $inputfield = ilDclCache::getFieldRepresentation($ownerField)->getInputField($this->form);

                if (!ilObjDataCollectionAccess::hasWriteAccess($this->parent_obj->ref_id) && $field_setting->isLockedEdit()) {
                    $inputfield->setDisabled(true);
                } else {
                    $inputfield->setRequired(true);
                }

                $this->form->addItem($inputfield);
            }
        }

        // save and cancel commands
        if ($this->record_id) {
            $this->form->setTitle($this->lng->txt("dcl_update_record"));
            $this->form->addCommandButton("save", $this->lng->txt("dcl_update_record"));
            if (!$this->ctrl->isAsynch()) {
                $this->form->addCommandButton("cancelUpdate", $this->lng->txt("cancel"));
            }
        } else {
            $this->form->setTitle($this->lng->txt("dcl_add_new_record"));
            $this->form->addCommandButton("save", $this->lng->txt("save"));
            if (!$this->ctrl->isAsynch()) {
                $this->form->addCommandButton("cancelSave", $this->lng->txt("cancel"));
            }
        }
        $this->ctrl->setParameter($this, "tableview_id", $this->tableview_id);
        $this->ctrl->setParameter($this, "table_id", $this->table_id);
        $this->ctrl->setParameter($this, "record_id", $this->record_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parseSearchResults()

ilDclRecordEditGUI::parseSearchResults (   $a_res )

protected

Parse search results.

Parameters

ilObject[]

$a_res

Returns

array

Definition at line 811 of file class.ilDclRecordEditGUI.php.

References $rows, ilObject\_lookupDescription(), and ilObject\_lookupTitle().

Referenced by searchObjects().

    {
        $rows = array();
        foreach ($a_res as $obj_id => $references) {
            $r = array();
            $r['title'] = ilObject::_lookupTitle($obj_id);
            $r['desc'] = ilObject::_lookupDescription($obj_id);
            $r['obj_id'] = $obj_id;
            $r['refs'] = $references;
            $rows[] = $r;
        }

        return $rows;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilDclRecordEditGUI::save

(

)

Save record.

Definition at line 478 of file class.ilDclRecordEditGUI.php.

References $_GET, $_POST, $_SESSION, $data, $DIC, Vendor\Package\$e, $form, $table_id, $valid, ilObjUser\_lookupId(), accessDenied(), checkAndPerformRedirect(), ilDclBaseRecordModel\doCreate(), ilDclBaseRecordModel\doUpdate(), exit, ilDclTableViewBaseDefaultValue\findSingle(), ilDclBaseRecordModel\getId(), getLanguageJsKeys(), ilDclCache\getRecordCache(), ilUtil\getSystemMessageHTML(), ilObjDataCollectionAccess\hasPermissionToAddRecord(), ilDclBaseRecordModel\hasPermissionToEdit(), ilObjDataCollectionAccess\hasWriteAccess(), IL_CAL_DATETIME, IL_CAL_UNIX, initForm(), ilDclPropertyFormGUI\rebuildTempFileByHash(), sendFailure(), ilDclBaseRecordModel\setCreateDate(), setFormValues(), ilDclBaseRecordModel\setLastEditBy(), ilDclBaseRecordModel\setLastUpdate(), ilDclBaseRecordModel\setOwner(), ilDclBaseRecordModel\setRecordFieldValue(), ilDclBaseRecordModel\setRecordFieldValueFromForm(), ilDclBaseRecordModel\setTableId(), and user().

    {
        global $DIC;
        $ilAppEventHandler = $DIC['ilAppEventHandler'];

        $this->initForm();

        // if save confirmation is enabled: Temporary file-uploads need to be handled
        if ($this->table->getSaveConfirmation() && isset($_POST['save_confirmed']) && isset($_POST['ilfilehash']) && !isset($this->record_id) && !$this->ctrl->isAsynch()) {
            ilDclPropertyFormGUI::rebuildTempFileByHash($_POST['ilfilehash']);

            //handle empty fileuploads, since $_FILES has to have an entry for each fileuploadGUI
            if (json_decode($_POST['empty_fileuploads']) && $_POST['empty_fileuploads'] != '') {
                $_FILES = $_FILES + json_decode($_POST['empty_fileuploads'], true);
            }

            unset($_SESSION['record_form_values']);
        }

        $valid = $this->form->checkInput();

        $record_obj = ilDclCache::getRecordCache($this->record_id);
        $unchanged_obj = $record_obj;
        $date_obj = new ilDateTime(time(), IL_CAL_UNIX);
        $record_obj->setTableId($this->table_id);
        $record_obj->setLastUpdate($date_obj->get(IL_CAL_DATETIME));
        $record_obj->setLastEditBy($this->user->getId());

        $create_mode = !isset($this->record_id);

        if (ilObjDataCollectionAccess::hasWriteAccess($this->parent_obj->ref_id) || $create_mode) {
            $all_fields = $this->table->getRecordFields();
        } else {
            $all_fields = $this->table->getEditableFields(!$this->record_id);
        }

        //Check if we can create this record.
        foreach ($all_fields as $field) {
            try {
                $field->checkValidityFromForm($this->form, $this->record_id);
            } catch (ilDclInputException $e) {
                $valid = false;
                $item = $this->form->getItemByPostVar('field_' . $field->getId());
                $item->setAlert($e);
            }
        }

        if (!$valid) {
            $this->sendFailure($this->lng->txt('form_input_not_valid'));

            return;
        }

        if ($valid) {
            if ($create_mode) {
                if (!(ilObjDataCollectionAccess::hasPermissionToAddRecord($this->parent_obj->ref_id, $this->table_id))) {
                    $this->accessDenied();

                    return;
                }

                // when save_confirmation is enabled, not yet confirmed and we have not an async-request => prepare for displaying confirmation
                if ($this->table->getSaveConfirmation() && $this->form->getInput('save_confirmed') == null && !$this->ctrl->isAsynch()) {
                    // temporary store fileuploads (reuse code from ilPropertyFormGUI)
                    $hash = $_POST["ilfilehash"];
                    foreach ($_FILES as $field => $data) {
                        if (is_array($data["tmp_name"])) {
                            foreach ($data["tmp_name"] as $idx => $upload) {
                                if (is_array($upload)) {
                                    foreach ($upload as $idx2 => $file) {
                                        if ($file && is_uploaded_file($file)) {
                                            $file_name = $data["name"][$idx][$idx2];
                                            $file_type = $data["type"][$idx][$idx2];
                                            $this->form->keepTempFileUpload($hash, $field, $file, $file_name, $file_type, $idx, $idx2);
                                        }
                                    }
                                } else {
                                    if ($upload && is_uploaded_file($upload)) {
                                        $file_name = $data["name"][$idx];
                                        $file_type = $data["type"][$idx];
                                        $this->form->keepTempFileUpload($hash, $field, $upload, $file_name, $file_type, $idx);
                                    }
                                }
                            }
                        } else {
                            $this->form->keepTempFileUpload($hash, $field, $data["tmp_name"], $data["name"], $data["type"]);
                        }
                    }

                    //edit values, they are valid we already checked them above
                    foreach ($all_fields as $field) {
                        $record_obj->setRecordFieldValueFromForm($field->getId(), $this->form);
                    }

                    $this->saveConfirmation($record_obj, $hash);

                    return;
                }

                $record_obj->setOwner($this->user->getId());
                $record_obj->setCreateDate($date_obj->get(IL_CAL_DATETIME));
                $record_obj->setTableId($this->table_id);
                $record_obj->doCreate();

                $this->record_id = $record_obj->getId();
                $create_mode = true;
            } else {
                if (!$record_obj->hasPermissionToEdit($this->parent_obj->ref_id)) {
                    $this->accessDenied();

                    return;
                }
            }

            //edit values, they are valid we already checked them above
            foreach ($all_fields as $field) {
                $field_setting = $field->getViewSetting($this->tableview_id);

                if ($field_setting->isVisibleInForm($create_mode) &&
                    (!$field_setting->isLocked($create_mode) || ilObjDataCollectionAccess::hasWriteAccess($this->parent_obj->ref_id))) {
                    // set all visible fields
                    $record_obj->setRecordFieldValueFromForm($field->getId(), $this->form);
                } elseif ($create_mode) {
                    // set default values when creating
                    $default_value = ilDclTableViewBaseDefaultValue::findSingle(
                        $field_setting->getFieldObject()->getDatatypeId(),
                        $field_setting->getId()
                    );
                    if ($default_value !== null) {
                        $record_obj->setRecordFieldValue($field->getId(), $default_value->getValue());
                    }
                }
            }

            // Do we need to set a new owner for this record?
            if (!$create_mode && $this->tableview->getFieldSetting('owner')->isVisibleEdit()) {
                $owner_id = ilObjUser::_lookupId($_POST['field_owner']);
                if (!$owner_id) {
                    $this->sendFailure($this->lng->txt('user_not_known'));

                    return;
                }
                $record_obj->setOwner($owner_id);
            }

            $dispatchEvent = "update";

            $dispatchEventData = array(
                'dcl' => $this->parent_obj->getDataCollectionObject(),
                'table_id' => $this->table_id,
                'record_id' => $record_obj->getId(),
                'record' => $record_obj,
            );

            if ($create_mode) {
                $dispatchEvent = "create";
                $objDataCollection = new ilObjDataCollection($_GET['ref_id']);
                $objDataCollection->sendNotification("new_record", $this->table_id, $record_obj->getId());
            } else {
                $dispatchEventData['prev_record'] = $unchanged_obj;
            }

            $record_obj->doUpdate($create_mode);

            $ilAppEventHandler->raise(
                'Modules/DataCollection',
                $dispatchEvent . 'Record',
                $dispatchEventData
            );

            $this->ctrl->setParameter($this, "table_id", $this->table_id);
            $this->ctrl->setParameter($this, "tableview_id", $this->tableview_id);
            $this->ctrl->setParameter($this, "record_id", $this->record_id);

            if (!$this->ctrl->isAsynch()) {
                ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"), true);
            }

            $this->checkAndPerformRedirect();
            if ($this->ctrl->isAsynch()) {
                // If ajax request, return the form in edit mode again
                $this->record_id = $record_obj->getId();
                $this->initForm();
                $this->setFormValues();
                echo ilUtil::getSystemMessageHTML($this->lng->txt('msg_obj_modified'), 'success') . $this->form->getHTML();
                exit();
            } else {
                $this->ctrl->redirectByClass("ildclrecordlistgui", "listRecords");
            }
        } else {
            // Form not valid...
            //TODO: URL title flushes on invalid form
            $this->form->setValuesByPost();
            if ($this->ctrl->isAsynch()) {
                echo $this->form->getHTML();
                exit();
            } else {
                $this->tpl->setContent($this->getLanguageJsKeys() . $this->form->getHTML());
            }
        }
    }

Here is the call graph for this function:

searchObjects()

ilDclRecordEditGUI::searchObjects

(

)

This function is only used by the ajax request if searching for ILIAS references.

It builds the html for the search results.

Definition at line 756 of file class.ilDclRecordEditGUI.php.

References $_POST, $res, $results, $tpl, exit, parseSearchResults(), QP_COMBINATION_AND, and ROOT_FOLDER_ID.

    {
        $search = $_POST['search_for'];
        $dest = $_POST['dest'];
        $html = "";
        $query_parser = new ilQueryParser($search);
        $query_parser->setMinWordLength(1, true);
        $query_parser->setCombination(QP_COMBINATION_AND);
        $query_parser->parse();
        if (!$query_parser->validate()) {
            $html .= $query_parser->getMessage() . "<br />";
        }

        // only like search since fulltext does not support search with less than 3 characters
        $object_search = new ilLikeObjectSearch($query_parser);
        $res = $object_search->performSearch();
        //$res->setRequiredPermission('copy');
        $res->filter(ROOT_FOLDER_ID, true);

        if (!count($results = $res->getResultsByObjId())) {
            $html .= $this->lng->txt('dcl_no_search_results_found_for') . ' ' . $search . "<br />";
        }
        $results = $this->parseSearchResults($results);

        foreach ($results as $entry) {
            $tpl = new ilTemplate("tpl.dcl_tree.html", true, true, "Modules/DataCollection");
            foreach ((array) $entry['refs'] as $reference) {
                $path = new ilPathGUI();
                $tpl->setCurrentBlock('result');
                $tpl->setVariable('RESULT_PATH', $path->getPath(ROOT_FOLDER_ID, $reference) . " » " . $entry['title']);
                $tpl->setVariable('RESULT_REF', $reference);
                $tpl->setVariable('FIELD_ID', $dest);
                $tpl->parseCurrentBlock();
            }
            $html .= $tpl->get();
        }

        echo $html;
        exit;
    }

Here is the call graph for this function:

sendFailure()

ilDclRecordEditGUI::sendFailure (   $message )

protected

Parameters

$message

Definition at line 720 of file class.ilDclRecordEditGUI.php.

References $form, $message, exit, ilDclBaseRecordModel\fillRecordFieldFormInput(), ilDclBaseRecordModel\getId(), getLanguageJsKeys(), ilDclCache\getRecordCache(), ilUtil\getSystemMessageHTML(), and ilUtil\sendFailure().

Referenced by save().

    {
        $keep = ($this->ctrl->isAsynch()) ? false : true;
        $this->form->setValuesByPost();
        if ($this->ctrl->isAsynch()) {
            echo ilUtil::getSystemMessageHTML($message, 'failure') . $this->form->getHTML();
            exit();
        } else {
            ilUtil::sendFailure($message, $keep);

            // Fill locked fields on edit mode - otherwise they are empty (workaround)
            if (isset($this->record_id)) {
                $record_obj = ilDclCache::getRecordCache($this->record_id);
                if ($record_obj->getId()) {
                    //Get Table Field Definitions
                    $allFields = $this->table->getFields();
                    foreach ($allFields as $field) {
                        $field_setting = $field->getViewSetting($this->tableview_id);
                        if (
                            $field_setting->isLockedEdit() &&
                            $field_setting->isVisibleEdit()
                        ) {
                            $record_obj->fillRecordFieldFormInput($field->getId(), $this->form);
                        }
                    }
                }
            }

            $this->tpl->setContent($this->getLanguageJsKeys() . $this->form->getHTML());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setFormValues()

ilDclRecordEditGUI::setFormValues

(

)

Set values from object to form.

Returns

bool

Definition at line 373 of file class.ilDclRecordEditGUI.php.

References $form, ilDclCache\getRecordCache(), and ilDclDatatype\INPUTFORMAT_NONE.

Referenced by edit(), and save().

    {
        //Get Record-Values
        $record_obj = ilDclCache::getRecordCache($this->record_id);
        if ($record_obj->getId()) {
            //Get Table Field Definitions
            $allFields = $this->table->getFields();
            foreach ($allFields as $field) {
                if ($field->getDatatypeId() !== ilDclDatatype::INPUTFORMAT_NONE &&
                    $field->getViewSetting($this->tableview_id)->isVisibleEdit()) {
                    $record_obj->fillRecordFieldFormInput($field->getId(), $this->form);
                }
            }
        } else {
            $this->form->setValuesByPost();
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilDclRecordEditGUI::$ctrl

protected

Definition at line 51 of file class.ilDclRecordEditGUI.php.

$form

ilDclRecordEditGUI::$form

protected

Definition at line 67 of file class.ilDclRecordEditGUI.php.

Referenced by getForm(), save(), sendFailure(), and setFormValues().

$lng

ilDclRecordEditGUI::$lng

protected

Definition at line 59 of file class.ilDclRecordEditGUI.php.

Referenced by __construct().

$parent_obj

ilDclRecordEditGUI::$parent_obj

protected

Definition at line 43 of file class.ilDclRecordEditGUI.php.

Referenced by __construct().

$record

ilDclRecordEditGUI::$record

protected

Definition at line 47 of file class.ilDclRecordEditGUI.php.

Referenced by confirmDelete(), delete(), and getRecordData().

$record_id

ilDclRecordEditGUI::$record_id

protected

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

Referenced by getRecordData().

$table

ilDclRecordEditGUI::$table

protected

Definition at line 39 of file class.ilDclRecordEditGUI.php.

$table_id

ilDclRecordEditGUI::$table_id

protected

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

Referenced by save().

$tableview

ilDclRecordEditGUI::$tableview

protected

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

$tableview_id

ilDclRecordEditGUI::$tableview_id

protected

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

$tpl

ilDclRecordEditGUI::$tpl

protected

Definition at line 55 of file class.ilDclRecordEditGUI.php.

Referenced by __construct(), and searchObjects().

$user

ilDclRecordEditGUI::$user

protected

Definition at line 63 of file class.ilDclRecordEditGUI.php.

REDIRECT_DETAIL

const ilDclRecordEditGUI::REDIRECT_DETAIL = 2

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

Referenced by ilDclDetailedViewGUI\renderRecord().

REDIRECT_RECORD_LIST

const ilDclRecordEditGUI::REDIRECT_RECORD_LIST = 1

Possible redirects after saving/updating a record - use GET['redirect'] to set constants.

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

---

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

• Modules/DataCollection/classes/Content/class.ilDclRecordEditGUI.php