@noinspection AutoloadingIssuesInspection More...

Inheritance diagram for ilDclFileRecordFieldModel:

Collaboration diagram for ilDclFileRecordFieldModel:

Public Member Functions
	__construct (ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)

	parseValue ($value)
	Function to parse incoming data from form input value $value. More...

	setValueFromForm (ilPropertyFormGUI $form)

	delete ()
	Delete record field in database. More...

	parseExportValue ($value)
	Function to parse incoming data from form input value $value. More...

	parseSortingValue ($value, bool $link=true)
	Returns sortable value for the specific field-types. More...

	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 ()

	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

@noinspection AutoloadingIssuesInspection

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

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

ilDclBaseRecordModel	$record
ilDclBaseFieldModel	$field

Reimplemented from ilDclBaseRecordFieldModel.

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ afterClone()

ilDclFileRecordFieldModel::afterClone ( )

Reimplemented from ilDclBaseRecordFieldModel.

Reimplemented in ilDclMobRecordFieldModel.

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

                                : 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();
        }
    }

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

Here is the call graph for this function:

◆ delete()

ilDclFileRecordFieldModel::delete ( )

Delete record field in database.

Reimplemented from ilDclBaseRecordFieldModel.

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

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

References removeData().

Here is the call graph for this function:

◆ parseExportValue()

ilDclFileRecordFieldModel::parseExportValue ( $value )

Function to parse incoming data from form input value $value.

returns the string/number/etc. to store in the database.

Parameters

mixed $value

Returns: mixed

Reimplemented from ilDclBaseRecordFieldModel.

Reimplemented in ilDclMobRecordFieldModel.

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

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

References ilDclBaseRecordFieldModel\$value.

◆ parseSortingValue()

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

Returns sortable value for the specific field-types.

Parameters

int | string $value

Returns: int|string

Reimplemented from ilDclBaseRecordFieldModel.

Reimplemented in ilDclMobRecordFieldModel.

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

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

References ilDclBaseRecordFieldModel\$value.

◆ parseValue()

ilDclFileRecordFieldModel::parseValue ( $value )

Function to parse incoming data from form input value $value.

returns the string/number/etc. to store in the database.

Parameters

int | string $value

Returns: int|string|null

Reimplemented from ilDclBaseRecordFieldModel.

Reimplemented in ilDclMobRecordFieldModel.

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

    {
        $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->getValue();
            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();
    }

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

Here is the call graph for this function:

◆ removeData()

ilDclFileRecordFieldModel::removeData ( )

protected

Reimplemented in ilDclMobRecordFieldModel.

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

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

Referenced by delete(), and setValueFromForm().

Here is the caller graph for this function:

◆ setValueFromForm()

ilDclFileRecordFieldModel::setValueFromForm ( ilPropertyFormGUI $form )

Reimplemented from ilDclBaseRecordFieldModel.

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

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

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

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.

◆ $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.

Referenced by parseValue().

◆ FILE_TMP_NAME

const ilDclFileRecordFieldModel::FILE_TMP_NAME = 'tmp_name'

private

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

Referenced by parseValue().

◆ 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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ afterClone()

◆ delete()

◆ parseExportValue()

◆ parseSortingValue()

◆ parseValue()

◆ removeData()

◆ setValueFromForm()

Field Documentation

◆ $irss

◆ $stakeholder

◆ $upload

◆ FILE_NAME

◆ FILE_TMP_NAME

◆ FILE_TYPE