ilDclFileuploadRecordFieldModel Class Reference

Inheritance diagram for ilDclFileuploadRecordFieldModel:

Collaboration diagram for ilDclFileuploadRecordFieldModel:

Public Member Functions
	__construct (ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)
	parseValue ($value)
	addHiddenItemsToConfirmation (ilConfirmationGUI $confirmation)
	setValue ($value, bool $omit_parsing=false)
	Set value for record field. More...
	parseExportValue ($value)
	parseSortingValue ($value, bool $link=true)
	Returns sortable value for the specific field-types. More...
	setValueFromForm (ilPropertyFormGUI $form)
	afterClone ()
Public Member Functions inherited from ilDclBaseRecordFieldModel
	__construct (ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)
	doCreate ()
	Creates an Id and a database entry. More...
	doUpdate ()
	Update object in database. More...
	delete ()
	Delete record field in database. More...
	getValue ()
	getValueForRepresentation ()
	serializeData ($value)
	Serialize data before storing to db. More...
	deserializeData ($value)
	Deserialize data before applying to field. More...
	setValue ($value, bool $omit_parsing=false)
	Set value for record field. More...
	setValueFromForm (ilPropertyFormGUI $form)
	getFormulaValue ()
	parseExportValue ($value)
	Function to parse incoming data from form input value $value. More...
	getValueFromExcel (ilExcel $excel, int $row, int $col)
	parseValue ($value)
	Function to parse incoming data from form input value $value. More...
	getExportValue ()
	fillExcelExport (ilExcel $worksheet, int &$row, int &$col)
	getPlainText ()
	getSortingValue (bool $link=true)
	addHiddenItemsToConfirmation (ilConfirmationGUI $confirmation)
	parseSortingValue ($value, bool $link=true)
	Returns sortable value for the specific field-types. More...
	cloneStructure (ilDclBaseRecordFieldModel $old_record_field)
	afterClone ()
	getField ()
	getId ()
	getRecord ()
	getRecordRepresentation ()
	setRecordRepresentation (ilDclBaseRecordRepresentation $record_representation)
	getFieldRepresentation ()
	setFieldRepresentation (ilDclBaseFieldRepresentation $field_representation)

Private Attributes
ILIAS FileUpload FileUpload	$upload

Additional Inherited Members
Protected Member Functions inherited from ilDclBaseRecordFieldModel
	doRead ()
	Read object data from database. More...
	loadValue ()
	Load the value. More...
Protected Attributes inherited from ilDclBaseRecordFieldModel
int	$id = null
ilDclBaseFieldModel	$field
ilDclBaseRecordModel	$record
ilDclBaseRecordRepresentation	$record_representation = null
ilDclBaseFieldRepresentation	$field_representation = null
	$value
ilObjUser	$user
ilCtrl	$ctrl
ilDBInterface	$db
ilLanguage	$lng
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilDclFileuploadRecordFieldModel::__construct	(	ilDclBaseRecordModel	$record,
		ilDclBaseFieldModel	$field
	)

Definition at line 26 of file class.ilDclFileuploadRecordFieldModel.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\upload().

    {
        parent::__construct($record, $field);
        global $DIC;
        $this->upload = $DIC->upload();
    }

Here is the call graph for this function:

Member Function Documentation

addHiddenItemsToConfirmation()

ilDclFileuploadRecordFieldModel::addHiddenItemsToConfirmation

(

ilConfirmationGUI

$confirmation

)

Definition at line 111 of file class.ilDclFileuploadRecordFieldModel.php.

References ILIAS\LTI\ToolProvider\$key, ilDclBaseRecordFieldModel\$value, ilConfirmationGUI\addHiddenItem(), and ilDclBaseRecordFieldModel\getValue().

                                                                                 : void
    {
        if (is_array($this->getValue())) {
            foreach ($this->getValue() as $key => $value) {
                $confirmation->addHiddenItem('field_' . $this->field->getId() . '[' . $key . ']', $value);
            }
        }
    }

Here is the call graph for this function:

afterClone()

ilDclFileuploadRecordFieldModel::afterClone

(

)

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

References ilDclBaseRecordFieldModel\$field, ilDclBaseRecordFieldModel\$record, ilObject2\cloneObject(), ilDclBaseRecordFieldModel\doUpdate(), ilDclCache\getCloneOf(), ilDclBaseRecordFieldModel\getField(), ilObject\getId(), ilDclBaseRecordFieldModel\getId(), ilDclBaseRecordFieldModel\getRecord(), ilDclCache\getRecordFieldCache(), setValue(), ilDclCache\TYPE_FIELD, and ilDclCache\TYPE_RECORD.

                                : void
    {
        $field = ilDclCache::getCloneOf($this->getField()->getId(), ilDclCache::TYPE_FIELD);
        $record = ilDclCache::getCloneOf($this->getRecord()->getId(), ilDclCache::TYPE_RECORD);
        $record_field = ilDclCache::getRecordFieldCache($record, $field);

        if (!$record_field || !$record_field->getValue()) {
            return;
        }

        $file_old = new ilObjFile($record_field->getValue(), false);
        $file_new = $file_old->cloneObject(0, 0, true);

        $this->setValue($file_new->getId(), true);
        $this->doUpdate();
    }

Here is the call graph for this function:

parseExportValue()

ilDclFileuploadRecordFieldModel::parseExportValue

(

$value

)

Parameters

string

$value

Definition at line 148 of file class.ilDclFileuploadRecordFieldModel.php.

References ilDclBaseRecordFieldModel\$value, ilObject\_exists(), and ilObject\_lookupType().

                                            : ?string
    {
        if (!$value || !ilObject2::_exists($value) || ilObject2::_lookupType($value) != "file") {
            return null;
        }

        $file = $value;
        if ($file != "-") {
            $file_obj = new ilObjFile($file, false);
            $file_name = $file_obj->getFileName();

            return $file_name;
        }

        return $file;
    }

Here is the call graph for this function:

parseSortingValue()

ilDclFileuploadRecordFieldModel::parseSortingValue	(		$value,
		bool	$link = true
	)

Returns sortable value for the specific field-types.

Parameters

int

$value

Definition at line 169 of file class.ilDclFileuploadRecordFieldModel.php.

References ilDclBaseRecordFieldModel\$value, ilObject\_exists(), and ilObject\_lookupType().

                                                                : string
    {
        if (!ilObject2::_exists($value) || ilObject2::_lookupType($value) != "file") {
            return '';
        }
        $file_obj = new ilObjFile($value, false);

        return $file_obj->getTitle();
    }

Here is the call graph for this function:

parseValue()

ilDclFileuploadRecordFieldModel::parseValue

(

$value

)

Parameters

null | array | int

$value

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

References ilDclBaseRecordFieldModel\$value, ilDclBaseRecordFieldModel\getField(), ilDclBaseRecordFieldModel\getId(), ilDclBaseRecordFieldModel\getRecord(), ilDclPropertyFormGUI\getTempFilename(), ilDclBaseRecordFieldModel\getValue(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilObjFile\MODE_OBJECT, ILIAS\Filesystem\Stream\Streams\ofResource(), ILIAS\Repository\refinery(), and ILIAS\Repository\upload().

Referenced by setValue().

    {
        if ($value === -1) { //marked for deletion.
            return null;
        }

        $file = $value;

        $has_record_id = $this->http->wrapper()->query()->has('record_id');
        $is_confirmed = $this->http->wrapper()->post()->has('save_confirmed');
        $has_save_confirmation = ($this->getRecord()->getTable()->getSaveConfirmation() && !$has_record_id);

        if (
            is_array($file)
            && isset($file['tmp_name'])
            && $file['tmp_name'] !== ""
            && (!$has_save_confirmation || $is_confirmed)
        ) {
            if ($has_save_confirmation) {
                $ilfilehash = $this->http->wrapper()->post()->retrieve(
                    'ilfilehash',
                    $this->refinery->kindlyTo()->string()
                );

                $move_file = ilDclPropertyFormGUI::getTempFilename(
                    $ilfilehash,
                    'field_' . $this->getField()->getId(),
                    $file["name"],
                    $file["type"]
                );

                $file_stream = ILIAS\Filesystem\Stream\Streams::ofResource(fopen($move_file, 'rb'));
            } else {
                $move_file = $file['tmp_name'];

                if (false === $this->upload->hasBeenProcessed()) {
                    $this->upload->process();
                }

                if (false === $this->upload->hasUploads()) {
                    throw new ilException($this->lng->txt('upload_error_file_not_found'));
                }

                $file_stream = Streams::ofResource(fopen($move_file, 'rb'));
            }

            $file_title = $file["name"] ?? basename($move_file);

            $file_obj = new ilObjFile();
            $file_obj->setType("file");
            $file_obj->setTitle($file_title);
            $file_obj->setFileName($file_title);
            $file_obj->setMode(ilObjFile::MODE_OBJECT);
            $file_obj->create();

            $file_obj->appendStream($file_stream, $file_title);
            $file_obj->setTitle($file_title);
            $file_obj->setFileName($file_title);

            $file_obj->update();

            $file_id = $file_obj->getId();
            $return = $file_id;
            // handover for save-confirmation
        } else {
            if (is_array($file) && isset($file['tmp_name']) && $file['tmp_name'] != "") {
                $return = $file;
            } else {
                $return = $this->getValue();
            }
        }

        return $return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setValue()

ilDclFileuploadRecordFieldModel::setValue	(		$value,
		bool	$omit_parsing = false
	)

Set value for record field.

Parameters

string | int	$value
bool	$omit_parsing	If true, does not parse the value and stores it in the given format

Definition at line 125 of file class.ilDclFileuploadRecordFieldModel.php.

References ilDclBaseRecordFieldModel\$value, ilDclBaseRecordFieldModel\getRecord(), ilDclBaseRecordFieldModel\loadValue(), and parseValue().

Referenced by afterClone(), and setValueFromForm().

                                                                : void
    {
        $this->loadValue();

        if (!$omit_parsing) {
            $tmp = $this->parseValue($value);
            $old = $this->value;
            //if parse value fails keep the old value
            if ($tmp !== false) {
                $this->value = $tmp;
                //delete old file from filesystem
                if ($old && $old != $tmp) {
                    $this->getRecord()->deleteFile($old);
                }
            }
        } else {
            $this->value = $value;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setValueFromForm()

ilDclFileuploadRecordFieldModel::setValueFromForm

(

ilPropertyFormGUI

$form

)

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

References ilDclBaseRecordFieldModel\$value, ilDclBaseRecordFieldModel\getField(), ilDclBaseRecordFieldModel\getId(), ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), and setValue().

                                                             : void
    {
        $value = $form->getInput("field_" . $this->getField()->getId());
        if ($form->getItemByPostVar("field_" . $this->getField()->getId())->getDeletionFlag()) {
            $value = -1;
        }
        $this->setValue($value);
    }

Here is the call graph for this function:

Field Documentation

$upload

ILIAS FileUpload FileUpload ilDclFileuploadRecordFieldModel::$upload

private

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

---

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

• Modules/DataCollection/classes/Fields/Fileupload/class.ilDclFileuploadRecordFieldModel.php