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

	setUser (ilObjUser $user)

	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
	handleFileUpload (array $value, bool $has_save_confirmation)

	removeData ()

Protected Member Functions inherited from ilDclBaseRecordFieldModel
	doRead ()
	Read object data from database. More...

	loadValue ()
	Load the value. More...

Protected Attributes
const	FILE_TMP_NAME = 'tmp_name'

const	FILE_NAME = "name"

const	FILE_TYPE = "type"

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

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 128 of file class.ilDclFileRecordFieldModel.php.

                                : void
    {
        if ($this->value !== null) {
            $value = null;
            $current = $this->valueToCurrentRevision($this->value);
            if ($current !== null) {
                $new_rid = $this->irss->manage()->clone($current->getIdentification());
                $value = $new_rid->serialize();
            }
            $this->setValue($value, true);
            $this->doUpdate();
        }
    }

References ilDclBaseRecordFieldModel\$value, ilDclBaseRecordFieldModel\doUpdate(), and ilDclBaseRecordFieldModel\setValue().

Here is the call graph for this function:

◆ delete()

ilDclFileRecordFieldModel::delete ( )

Delete record field in database.

Reimplemented from ilDclBaseRecordFieldModel.

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

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

References removeData().

Here is the call graph for this function:

◆ handleFileUpload()

ilDclFileRecordFieldModel::handleFileUpload	(	array	$value,
		bool	$has_save_confirmation
	)

protected

Reimplemented in ilDclMobRecordFieldModel.

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

                                                                                  : mixed
    {
        if ($has_save_confirmation) {
            $move_file = ilDclPropertyFormGUI::getTempFilename(
                $this->http->wrapper()->post()->retrieve('ilfilehash', $this->refinery->kindlyTo()->string()),
                'field_' . $this->getField()->getId(),
                $value[self::FILE_NAME],
                $value[self::FILE_TYPE]
            );
 
            $file_stream = ILIAS\Filesystem\Stream\Streams::ofResource(fopen($move_file, 'rb'));
        } else {
            $move_file = $value[self::FILE_TMP_NAME];
 
            $file_stream = Streams::ofResource(fopen($move_file, 'rb'));
        }
 
        $file_title = $value[self::FILE_NAME] ?? basename($move_file);
 
        $old = $this->getValue();
        if (is_string($old) && ($rid = $this->irss->manage()->find($old)) !== null) {
            $this->irss->manage()->replaceWithStream($rid, $file_stream, $this->stakeholder, $file_title);
        } else {
            $rid = $this->irss->manage()->stream($file_stream, $this->stakeholder, $file_title);
        }
 
        return $rid->serialize();
    }

References ilDclBaseRecordFieldModel\$value, FILE_NAME, FILE_TMP_NAME, ilDclPropertyFormGUI\getTempFilename(), ilDclBaseRecordFieldModel\getValue(), ILIAS\FileDelivery\http(), and ILIAS\Filesystem\Stream\Streams\ofResource().

Referenced by parseValue().

Here is the call graph for this function:

Here is the caller 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 118 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 123 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.

Returns: int|string|null

Reimplemented from ilDclBaseRecordFieldModel.

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

    {
        $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 (($value[self::FILE_TMP_NAME] ?? '') !== '' && (!$has_save_confirmation || $is_confirmed)) {
            return $this->handleFileUpload($value, $has_save_confirmation);
        } else {
            if (($value[self::FILE_TMP_NAME] ?? '') !== '') {
                return $value;
            } else {
                return $this->getValue();
            }
        }
    }

References ilDclBaseRecordFieldModel\$value, ilDclBaseRecordFieldModel\getRecord(), ilDclBaseRecordFieldModel\getValue(), handleFileUpload(), and ILIAS\FileDelivery\http().

Here is the call graph for this function:

◆ removeData()

ilDclFileRecordFieldModel::removeData ( )

protected

Reimplemented in ilDclMobRecordFieldModel.

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

                                   : void
    {
        if (null !== $rid = $this->irss->manage()->find($this->getValue())) {
            $this->irss->manage()->remove($rid, $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 93 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);
    }