ilDclRecordEditGUI Class Reference

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

Collaboration diagram for ilDclRecordEditGUI:

Public Member Functions
	__construct (ilObjDataCollectionGUI $parent_obj, int $table_id, int $tableview_id)
	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 (int $record_id=0)
	Return All fields and values from a record ID. More...
	initForm ()
	init Form move parts to RecordRepresentationGUI 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
	rebuildUploadsForFileHash (bool $has_ilfilehash)
	checkAndPerformRedirect (bool $force_redirect=false)
	Checks to what view (table or detail) should be redirected and performs redirect. More...
	accessDenied ()
	sendFailure (string $message)
	parseSearchResults (array $a_res)
	Parse search results. More...
	cleanupTempFiles ()
	Cleanup temp-files. More...

Protected Attributes
int	$tableview_id = null
int	$record_id = null
int	$table_id = 1
ilDclTable	$table
ilObjDataCollectionGUI	$parent_obj
ilDclBaseRecordModel	$record
ilCtrl	$ctrl
ilGlobalPageTemplate	$tpl
ilLanguage	$lng
ilObjUser	$user
ilDclPropertyFormGUI	$form
ilDclTableView	$tableview
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery

Detailed Description

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

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Constructor & Destructor Documentation

__construct()

ilDclRecordEditGUI::__construct	(	ilObjDataCollectionGUI	$parent_obj,
		int	$table_id,
		int	$tableview_id
	)

Parameters

ilObjDataCollectionGUI

$parent_obj

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

References $DIC, $parent_obj, $table_id, $tableview_id, ILIAS\Repository\ctrl(), ilDclTableView\findOrGetInstance(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

    {
        global $DIC;

        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();

        $this->ctrl = $DIC['ilCtrl'];
        $this->tpl = $DIC['tpl'];
        $this->lng = $DIC['lng'];
        $this->user = $DIC['ilUser'];
        $this->parent_obj = $parent_obj;
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->tableview_id = $tableview_id;
        $this->table_id = $table_id;

        if ($this->http->wrapper()->query()->has('record_id')) {
            $this->record_id = $this->http->wrapper()->query()->retrieve(
                'record_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        if ($this->http->wrapper()->post()->has('record_id')) {
            $this->record_id = $this->http->wrapper()->post()->retrieve(
                'record_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        $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 720 of file class.ilDclRecordEditGUI.php.

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

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

                                     : void
    {
        if (!$this->ctrl->isAsynch()) {
            $this->tpl->setOnScreenMessage('failure', $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 222 of file class.ilDclRecordEditGUI.php.

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

cancelSave()

ilDclRecordEditGUI::cancelSave

(

)

Cancel Save.

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

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

                                : void
    {
        $this->cancelUpdate();
    }

Here is the call graph for this function:

cancelUpdate()

ilDclRecordEditGUI::cancelUpdate

(

)

Cancel Update.

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

References checkAndPerformRedirect().

Referenced by cancelSave().

                                  : void
    {
        $this->checkAndPerformRedirect(true);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkAndPerformRedirect()

ilDclRecordEditGUI::checkAndPerformRedirect ( bool  $force_redirect = false )

protected

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

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

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

Referenced by cancelUpdate(), and save().

                                                                            : void
    {
        $hasRedirect = $this->http->wrapper()->query()->has('redirect');

        if ($force_redirect || ($hasRedirect && !$this->ctrl->isAsynch())) {
            if ($hasRedirect) {
                $redirect = $this->http->wrapper()->query()->retrieve('redirect', $this->refinery->kindlyTo()->int());
                switch ($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;
                }
            }
            $this->ctrl->redirectByClass("ildclrecordlistgui", "listRecords");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cleanupTempFiles()

ilDclRecordEditGUI::cleanupTempFiles ( )

protected

Cleanup temp-files.

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

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

Referenced by edit().

                                         : void
    {
        $has_ilfilehash = $this->http->wrapper()->post()->has('ilfilehash');
        if ($has_ilfilehash) {
            $ilfilehash = $this->http->wrapper()->post()->retrieve('ilfilehash', $this->refinery->kindlyTo()->string());
            $this->form->cleanupTempFiles($ilfilehash);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmDelete()

ilDclRecordEditGUI::confirmDelete

(

)

Delete confirmation.

Exceptions

ilDclException

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

References ILIAS\Repository\ctrl(), ilDclBaseRecordModel\getId(), ilDclCache\getRecordCache(), ilDclCache\getRecordFieldCache(), ilDclCache\getRecordRepresentation(), and ILIAS\Repository\lng().

                                   : void
    {
        $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 $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 172 of file class.ilDclRecordEditGUI.php.

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

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

Here is the call graph for this function:

delete()

ilDclRecordEditGUI::delete

(

)

Remove record.

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

References $record, accessDenied(), ILIAS\Repository\ctrl(), ilDclBaseRecordModel\doDelete(), ilDclCache\getRecordCache(), and ILIAS\Repository\lng().

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

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

            return;
        }

        $record->doDelete();
        $this->tpl->setOnScreenMessage('success', $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 181 of file class.ilDclRecordEditGUI.php.

References cleanupTempFiles(), ILIAS\Repository\form(), initForm(), and setFormValues().

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

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

Here is the call graph for this function:

executeCommand()

ilDclRecordEditGUI::executeCommand

(

)

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

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

                                    : void
    {
        $this->getRecord();

        $cmd = $this->ctrl->getCmd();
        $this->$cmd();
    }

Here is the call graph for this function:

getForm()

ilDclRecordEditGUI::getForm

(

)

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

References $form.

                             : ilDclPropertyFormGUI
    {
        return $this->form;
    }

getRecord()

ilDclRecordEditGUI::getRecord

(

)

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

References $ref_id, accessDenied(), ILIAS\Repository\ctrl(), ilDclCache\getRecordCache(), ilDclCache\getTableCache(), ilObjDataCollectionAccess\hasAddRecordAccess(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by executeCommand().

                               : void
    {
        $hasMode = $this->http->wrapper()->query()->has('mode');
        if ($hasMode) {
            $mode = $this->http->wrapper()->query()->retrieve('mode', $this->refinery->kindlyTo()->string());

            $this->ctrl->saveParameter($this, 'mode');
            $this->ctrl->setParameterByClass("ildclrecordlistgui", "mode", $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->getRefId()) and $this->record->hasPermissionToView($this->parent_obj->getRefId())) && !$this->record->hasPermissionToDelete($this->parent_obj->getRefId())) {
                $this->accessDenied();
            }
            $this->table = $this->record->getTable();
            $this->table_id = $this->table->getId();
        } else {
            $this->table = ilDclCache::getTableCache($this->table_id);
            $ref_id = $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int());
            if (!ilObjDataCollectionAccess::hasAddRecordAccess($ref_id)) {
                $this->accessDenied();
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRecordData()

ilDclRecordEditGUI::getRecordData

(

int

$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 251 of file class.ilDclRecordEditGUI.php.

References $record_id, ILIAS\Repository\ctrl(), exit, ilDclCache\getRecordCache(), ilDclBaseRecordModel\getRecordFieldValues(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

                                                     : array
    {
        $get_record_id = $this->http->wrapper()->query()->retrieve('record_id', $this->refinery->kindlyTo()->int());

        $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 275 of file class.ilDclRecordEditGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilDclCache\getFieldRepresentation(), ilObjDataCollectionAccess\hasWriteAccess(), and ILIAS\Repository\lng().

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

                              : void
    {
        $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->getRefId()) && $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());
                        }
                    } else {
                        if ($item instanceof ilDclTextInputGUI) {
                            $item->setValue("");
                        }
                    }
                }
                $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->getRefId()) && $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 ( array  $a_res )

protected

Parse search results.

Parameters

ilObject[]

$a_res

Returns

array

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

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

Referenced by searchObjects().

                                                       : array
    {
        $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:

rebuildUploadsForFileHash()

ilDclRecordEditGUI::rebuildUploadsForFileHash ( bool  $has_ilfilehash )

protected

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

References $data, ILIAS\Repository\form(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by save().

                                                                      : string
    {
        $hash = "";
        if ($has_ilfilehash) {
            // temporary store fileuploads (reuse code from ilPropertyFormGUI)
            $hash = $this->http->wrapper()->post()->retrieve(
                'ilfilehash',
                $this->refinery->kindlyTo()->string()
            );
            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"]
                    );
                }
            }
        }
        return $hash;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilDclRecordEditGUI::save

(

)

Save record.

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

References $DIC, Vendor\Package\$e, $form, $ref_id, $table_id, $valid, ilObjUser\_lookupId(), accessDenied(), checkAndPerformRedirect(), ILIAS\Repository\ctrl(), ilDclBaseRecordModel\doCreate(), ilDclBaseRecordModel\doUpdate(), exit, ILIAS\Repository\form(), ilDclBaseRecordModel\getId(), ilDclCache\getRecordCache(), ilUtil\getSystemMessageHTML(), ilObjDataCollectionAccess\hasPermissionToAddRecord(), ilDclBaseRecordModel\hasPermissionToEdit(), ilObjDataCollectionAccess\hasWriteAccess(), ILIAS\FileDelivery\http(), IL_CAL_UNIX, initForm(), ILIAS\Repository\lng(), ilDclPropertyFormGUI\rebuildTempFileByHash(), rebuildUploadsForFileHash(), ILIAS\Repository\refinery(), sendFailure(), ilDclBaseRecordModel\setCreateDate(), setFormValues(), ilDclBaseRecordModel\setLastEditBy(), ilDclBaseRecordModel\setLastUpdate(), ilDclBaseRecordModel\setOwner(), ilDclBaseRecordModel\setRecordFieldValue(), ilDclBaseRecordModel\setRecordFieldValueFromForm(), ilDclBaseRecordModel\setTableId(), and ILIAS\Repository\user().

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

        $this->initForm();
        $this->setFormValues();

        // if save confirmation is enabled: Temporary file-uploads need to be handled
        $has_save_confirmed = $this->http->wrapper()->post()->has('save_confirmed');
        $has_ilfilehash = $this->http->wrapper()->post()->has('ilfilehash');
        $has_record_id = isset($this->record_id);
        $table_has_save_confirmation = $this->table->getSaveConfirmation();

        $ilfilehash = $has_ilfilehash ? $this->http->wrapper()->post()->retrieve(
            'ilfilehash',
            $this->refinery->kindlyTo()->string()
        ) : '';
        ilDclPropertyFormGUI::rebuildTempFileByHash($ilfilehash);


        if ($table_has_save_confirmation
            && $has_save_confirmed
            && $has_ilfilehash
            && !$has_record_id
            && !$this->ctrl->isAsynch()
        ) {
            $has_empty_fileuploads = $this->http->wrapper()->post()->has('empty_fileuploads');

            //handle empty fileuploads, since $_FILES has to have an entry for each fileuploadGUI
            if ($has_empty_fileuploads) {
                $empty_fileuploads = $this->http->wrapper()->post()->retrieve(
                    'empty_fileuploads',
                    $this->refinery->kindlyTo()->string()
                );
                if (json_decode($empty_fileuploads)) {
                    $_FILES = $_FILES + json_decode($empty_fileuploads, true);
                }
            }
        }

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

        $create_mode = ($this->record_id == null);
        $date_obj = new ilDateTime(time(), IL_CAL_UNIX);

        $record_obj = ilDclCache::getRecordCache($this->record_id);
        $unchanged_obj = $record_obj;
        $record_obj->setTableId($this->table_id);
        $record_obj->setLastUpdate($date_obj);
        $record_obj->setLastEditBy($this->user->getId());

        if (ilObjDataCollectionAccess::hasWriteAccess($this->parent_obj->getRefId()) || $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) {
            // Form not valid...
            //TODO: URL title flushes on invalid form
            ilDclPropertyFormGUI::rebuildTempFileByHash($ilfilehash);
            $hash = $this->rebuildUploadsForFileHash($has_ilfilehash);
            $this->form->setValuesByPost();
            $this->tpl->setContent($this->form->getHTML());
            $this->sendFailure($this->lng->txt('form_input_not_valid'));

            return;
        }

        if ($create_mode) {
            if (!(ilObjDataCollectionAccess::hasPermissionToAddRecord(
                $this->parent_obj->getRefId(),
                $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 ($table_has_save_confirmation && $this->form->getInput('save_confirmed') == null && !$this->ctrl->isAsynch()) {
                $hash = $this->rebuildUploadsForFileHash($has_ilfilehash);

                //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);
            $record_obj->setTableId($this->table_id);
            $record_obj->doCreate();

            $this->record_id = $record_obj->getId();
        } else {
            if (!$record_obj->hasPermissionToEdit($this->parent_obj->getRefId())) {
                $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->getRefId()))) {
                // 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()) {
            if ($this->http->wrapper()->post()->has('field_owner')) {
                $field_owner = $this->http->wrapper()->post()->retrieve(
                    'field_owner',
                    $this->refinery->kindlyTo()->string()
                );
                $owner_id = ilObjUser::_lookupId($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";
            $ref_id = $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int());
            $objDataCollection = new ilObjDataCollection($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()) {
            $this->tpl->setOnScreenMessage('success', $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");
        }
    }

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 765 of file class.ilDclRecordEditGUI.php.

References $path, $res, $results, exit, ilGlobalPageTemplate\get(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilGlobalPageTemplate\parseCurrentBlock(), parseSearchResults(), ilQueryParser\QP_COMBINATION_AND, ILIAS\Repository\refinery(), ROOT_FOLDER_ID, ilGlobalPageTemplate\setCurrentBlock(), and ilGlobalPageTemplate\setVariable().

                                   : void
    {
        $search = $this->http->wrapper()->post()->retrieve('search_for', $this->refinery->kindlyTo()->string());
        $dest = $this->http->wrapper()->post()->retrieve('dest', $this->refinery->kindlyTo()->string());
        $html = "";
        $query_parser = new ilQueryParser($search);
        $query_parser->setMinWordLength(1);
        $query_parser->setCombination(ilQueryParser::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, (int) $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 ( string  $message )

protected

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

References $form, ILIAS\Repository\ctrl(), exit, ilDclBaseRecordModel\fillRecordFieldFormInput(), ILIAS\Repository\form(), ilDclBaseRecordModel\getId(), ilDclCache\getRecordCache(), and ilUtil\getSystemMessageHTML().

Referenced by save().

                                                   : void
    {
        $keep = !$this->ctrl->isAsynch();
        $this->form->setValuesByPost();
        if ($this->ctrl->isAsynch()) {
            echo ilUtil::getSystemMessageHTML($message, 'failure') . $this->form->getHTML();
            exit();
        } else {
            $this->tpl->setOnScreenMessage('failure', $message, $keep);

            // Fill locked fields on edit mode - otherwise they are empty (workaround)
            if (isset($this->record_id) && $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->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.

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

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

Referenced by edit(), and save().

                                   : bool
    {
        //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

ilCtrl ilDclRecordEditGUI::$ctrl

protected

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

$form

ilDclPropertyFormGUI ilDclRecordEditGUI::$form

protected

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

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

$http

ILIAS HTTP Services ilDclRecordEditGUI::$http

protected

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

$lng

ilLanguage ilDclRecordEditGUI::$lng

protected

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

$parent_obj

ilObjDataCollectionGUI ilDclRecordEditGUI::$parent_obj

protected

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

Referenced by __construct().

$record

ilDclBaseRecordModel ilDclRecordEditGUI::$record

protected

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

Referenced by delete().

$record_id

int ilDclRecordEditGUI::$record_id = null

protected

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

Referenced by getRecordData().

$refinery

ILIAS Refinery Factory ilDclRecordEditGUI::$refinery

protected

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

$table

ilDclTable ilDclRecordEditGUI::$table

protected

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

$table_id

int ilDclRecordEditGUI::$table_id = 1

protected

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

Referenced by __construct(), and save().

$tableview

ilDclTableView ilDclRecordEditGUI::$tableview

protected

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

$tableview_id

int ilDclRecordEditGUI::$tableview_id = null

protected

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

Referenced by __construct().

$tpl

ilGlobalPageTemplate ilDclRecordEditGUI::$tpl

protected

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

$user

ilObjUser ilDclRecordEditGUI::$user

protected

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

REDIRECT_DETAIL

const ilDclRecordEditGUI::REDIRECT_DETAIL = 2

Definition at line 25 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 24 of file class.ilDclRecordEditGUI.php.

---

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

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