ilDclFileRecordFieldModel Class Reference

AutoloadingIssuesInspection More...

Inheritance diagram for ilDclFileRecordFieldModel:

Collaboration diagram for ilDclFileRecordFieldModel:

Public Member Functions
	__construct (ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)
	parseValue ($value)
	setValueFromForm (ilPropertyFormGUI $form)
	delete ()
	parseExportValue ($value)
	parseSortingValue ($value, bool $link=true)
	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)

Protected Member Functions
	removeData ()
Protected Member Functions inherited from ilDclBaseRecordFieldModel
	doRead ()
	Read object data from database. More...
	loadValue ()
	Load the value. More...

Protected Attributes
ILIAS ResourceStorage Services	$irss
ilDataCollectionStakeholder	$stakeholder
ILIAS FileUpload FileUpload	$upload
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

Private Attributes
const	FILE_TMP_NAME = 'tmp_name'
const	FILE_NAME = "name"
const	FILE_TYPE = "type"

Detailed Description

AutoloadingIssuesInspection

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

Constructor & Destructor Documentation

__construct()

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

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

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

    {
        global $DIC;
        parent::__construct($record, $field);
        $this->stakeholder = new ilDataCollectionStakeholder();
        $this->irss = $DIC->resourceStorage();
        $this->upload = $DIC->upload();
    }

Here is the call graph for this function:

Member Function Documentation

afterClone()

ilDclFileRecordFieldModel::afterClone

(

)

Definition at line 157 of file class.ilDclFileRecordFieldModel.php.

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

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

        if (!$record_field->getValue()) {
            return;
        }
        $current = $this->valueToCurrentRevision($record_field->getValue());
        if ($current !== null) {
            $new_rid = $this->irss->manage()->clone($current->getIdentification());
            $this->setValue($new_rid->serialize());
            $this->doUpdate();
        }
    }

Here is the call graph for this function:

delete()

ilDclFileRecordFieldModel::delete

(

)

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

References null, and removeData().

                            : void
    {
        if ($this->value !== null) {
            $this->removeData();
        }
        parent::delete();
    }

Here is the call graph for this function:

parseExportValue()

ilDclFileRecordFieldModel::parseExportValue

(

$value

)

Definition at line 147 of file class.ilDclFileRecordFieldModel.php.

References ilDclBaseRecordFieldModel\$value.

    {
        return $this->valueToFileTitle($value);
    }

parseSortingValue()

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

Definition at line 152 of file class.ilDclFileRecordFieldModel.php.

References ilDclBaseRecordFieldModel\$value.

    {
        return $this->valueToFileTitle($value);
    }

parseValue()

ilDclFileRecordFieldModel::parseValue

(

$value

)

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

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

    {
        $file = $value;

        // Some general Request Information
        $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[self::FILE_TMP_NAME])
            && $file[self::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[self::FILE_NAME],
                    $file[self::FILE_TYPE]
                );

                $file_stream = ILIAS\Filesystem\Stream\Streams::ofResource(fopen($move_file, 'rb'));
            } else {
                $move_file = $file[self::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[self::FILE_NAME] ?? basename($move_file);

            // Storing the File to the IRSS
            $existing_value = $this->getValueForRepresentation();
            if (
                is_string($existing_value)
                && ($rid = $this->irss->manage()->find($existing_value)) !== null
            ) {
                // Append to existing RID
                $this->irss->manage()->replaceWithStream(
                    $rid,
                    $file_stream,
                    $this->stakeholder,
                    $file_title
                );
            } else {
                // Create new RID
                $rid = $this->irss->manage()->stream(
                    $file_stream,
                    $this->stakeholder,
                    $file_title
                );
            }

            return $rid->serialize();
        } else {
            // handover for save-confirmation
            if (is_array($file) && isset($file[self::FILE_TMP_NAME]) && $file[self::FILE_TMP_NAME] != "") {
                return $file;
            }
        }
        return $this->getValue();
    }

Here is the call graph for this function:

removeData()

ilDclFileRecordFieldModel::removeData ( )

protected

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

References $stakeholder.

Referenced by delete(), and setValueFromForm().

                                   : void
    {
        $this->irss->manage()->remove($this->irss->manage()->find($this->value), $this->stakeholder);
    }

Here is the caller graph for this function:

setValueFromForm()

ilDclFileRecordFieldModel::setValueFromForm

(

ilPropertyFormGUI

$form

)

Definition at line 124 of file class.ilDclFileRecordFieldModel.php.

References ilDclBaseRecordFieldModel\doUpdate(), ilPropertyFormGUI\getItemByPostVar(), null, removeData(), and ilDclBaseRecordFieldModel\setValue().

                                                             : void
    {
        if ($this->value !== null && $form->getItemByPostVar("field_" . $this->getField()->getId())->getDeletionFlag()) {
            $this->removeData();
            $this->setValue(null, true);
            $this->doUpdate();
        }
        parent::setValueFromForm($form);
    }

Here is the call graph for this function:

Field Documentation

$irss

ILIAS ResourceStorage Services ilDclFileRecordFieldModel::$irss

protected

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

$stakeholder

ilDataCollectionStakeholder ilDclFileRecordFieldModel::$stakeholder

protected

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

Referenced by removeData().

$upload

ILIAS FileUpload FileUpload ilDclFileRecordFieldModel::$upload

protected

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

FILE_NAME

const ilDclFileRecordFieldModel::FILE_NAME = "name"

private

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

FILE_TMP_NAME

const ilDclFileRecordFieldModel::FILE_TMP_NAME = 'tmp_name'

private

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

FILE_TYPE

const ilDclFileRecordFieldModel::FILE_TYPE = "type"

private

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

---

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

• components/ILIAS/DataCollection/classes/Fields/File/class.ilDclFileRecordFieldModel.php